Class: AWSCDK::MediaConnect::CfnFlow::MediaStreamProperty

Inherits:

Jsii::Struct

Object
Jsii::Struct
AWSCDK::MediaConnect::CfnFlow::MediaStreamProperty

show all

Defined in:: media_connect/cfn_flow.rb

Overview

A media stream represents one component of your content, such as video, audio, or ancillary data.

After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html

Instance Attribute Summary collapse

#attributes ⇒ AWSCDK::IResolvable, ... readonly
Attributes that are related to the media stream.
#clock_rate ⇒ Numeric^? readonly
The sample rate for the stream.
#description ⇒ String^? readonly
A description that can help you quickly identify what your media stream is used for.
#fmt ⇒ Numeric^? readonly
The format type number (sometimes referred to as RTP payload type) of the media stream.
#media_stream_id ⇒ Numeric readonly
A unique identifier for the media stream.
#media_stream_name ⇒ String readonly
A name that helps you distinguish one media stream from another.
#media_stream_type ⇒ String readonly
The type of media stream.
#tags ⇒ Array<AWSCDK::CfnTag>^? readonly
Key-value pairs that can be used to tag this media stream.
#video_format ⇒ String^? readonly
The resolution of the video.

Class Method Summary collapse

.jsii_properties ⇒ Object

Instance Method Summary collapse

#initialize(media_stream_id:, media_stream_name:, media_stream_type:, attributes: nil, clock_rate: nil, description: nil, fmt: nil, tags: nil, video_format: nil) ⇒ MediaStreamProperty constructor
A new instance of MediaStreamProperty.
#to_jsii ⇒ Object

Constructor Details

#initialize(media_stream_id:, media_stream_name:, media_stream_type:, attributes: nil, clock_rate: nil, description: nil, fmt: nil, tags: nil, video_format: nil) ⇒ `MediaStreamProperty`

Returns a new instance of MediaStreamProperty.

Parameters:

media_stream_id (Numeric) —
A unique identifier for the media stream.
media_stream_name (String) —
A name that helps you distinguish one media stream from another.
media_stream_type (String) —
The type of media stream.
attributes (AWSCDK::IResolvable, AWSCDK::MediaConnect::CfnFlow::MediaStreamAttributesProperty, nil) (defaults to: nil) —
Attributes that are related to the media stream.
clock_rate (Numeric, nil) (defaults to: nil) —
The sample rate for the stream.
description (String, nil) (defaults to: nil) —
A description that can help you quickly identify what your media stream is used for.
fmt (Numeric, nil) (defaults to: nil) —
The format type number (sometimes referred to as RTP payload type) of the media stream.
tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —
Key-value pairs that can be used to tag this media stream.
video_format (String, nil) (defaults to: nil) —
The resolution of the video.

# File 'media_connect/cfn_flow.rb', line 1479

def initialize(media_stream_id:, media_stream_name:, media_stream_type:, attributes: nil, clock_rate: nil, description: nil, fmt: nil, tags: nil, video_format: nil)
  @media_stream_id = media_stream_id
  Jsii::Type.check_type(@media_stream_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "mediaStreamId")
  @media_stream_name = media_stream_name
  Jsii::Type.check_type(@media_stream_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mediaStreamName")
  @media_stream_type = media_stream_type
  Jsii::Type.check_type(@media_stream_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mediaStreamType")
  @attributes = attributes.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnFlow::MediaStreamAttributesProperty.new(**attributes.transform_keys(&:to_sym)) : attributes
  Jsii::Type.check_type(@attributes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuRmxvdy5NZWRpYVN0cmVhbUF0dHJpYnV0ZXNQcm9wZXJ0eSJ9XX19")), "attributes") unless @attributes.nil?
  @clock_rate = clock_rate
  Jsii::Type.check_type(@clock_rate, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "clockRate") unless @clock_rate.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @fmt = fmt
  Jsii::Type.check_type(@fmt, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "fmt") unless @fmt.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @video_format = video_format
  Jsii::Type.check_type(@video_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "videoFormat") unless @video_format.nil?
end

Instance Attribute Details

#attributes ⇒ `AWSCDK::IResolvable`, ... (readonly)

Attributes that are related to the media stream.

Returns:

(AWSCDK::IResolvable, AWSCDK::MediaConnect::CfnFlow::MediaStreamAttributesProperty, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-attributes



1519
1520
1521

# File 'media_connect/cfn_flow.rb', line 1519

def attributes
  @attributes
end

#clock_rate ⇒ `Numeric`^? (readonly)

The sample rate for the stream.

This value is measured in Hz.

Returns:

(Numeric, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-clockrate



1526
1527
1528

# File 'media_connect/cfn_flow.rb', line 1526

def clock_rate
  @clock_rate
end

#description ⇒ `String`^? (readonly)

A description that can help you quickly identify what your media stream is used for.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-description



1531
1532
1533

# File 'media_connect/cfn_flow.rb', line 1531

def description
  @description
end

#fmt ⇒ `Numeric`^? (readonly)

The format type number (sometimes referred to as RTP payload type) of the media stream.

MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.

Returns:

(Numeric, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-fmt



1538
1539
1540

# File 'media_connect/cfn_flow.rb', line 1538

def fmt
  @fmt
end

#media_stream_id ⇒ `Numeric` (readonly)

A unique identifier for the media stream.

Returns:

(Numeric)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-mediastreamid



1504
1505
1506

# File 'media_connect/cfn_flow.rb', line 1504

def media_stream_id
  @media_stream_id
end

#media_stream_name ⇒ `String` (readonly)

A name that helps you distinguish one media stream from another.

Returns:

(String)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-mediastreamname



1509
1510
1511

# File 'media_connect/cfn_flow.rb', line 1509

def media_stream_name
  @media_stream_name
end

#media_stream_type ⇒ `String` (readonly)

The type of media stream.

Returns:

(String)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-mediastreamtype



1514
1515
1516

# File 'media_connect/cfn_flow.rb', line 1514

def media_stream_type
  @media_stream_type
end

#tags ⇒ `Array<AWSCDK::CfnTag>`^? (readonly)

Key-value pairs that can be used to tag this media stream.

Returns:

(Array<AWSCDK::CfnTag>, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-tags



1543
1544
1545

# File 'media_connect/cfn_flow.rb', line 1543

def tags
  @tags
end

#video_format ⇒ `String`^? (readonly)

The resolution of the video.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-videoformat



1548
1549
1550

# File 'media_connect/cfn_flow.rb', line 1548

def video_format
  @video_format
end

Class Method Details

.jsii_properties ⇒ `Object`

# File 'media_connect/cfn_flow.rb', line 1550

def self.jsii_properties
  {
    :media_stream_id => "mediaStreamId",
    :media_stream_name => "mediaStreamName",
    :media_stream_type => "mediaStreamType",
    :attributes => "attributes",
    :clock_rate => "clockRate",
    :description => "description",
    :fmt => "fmt",
    :tags => "tags",
    :video_format => "videoFormat",
  }
end

Instance Method Details

#to_jsii ⇒ `Object`

# File 'media_connect/cfn_flow.rb', line 1564

def to_jsii
  result = {}
  result.merge!({
    "mediaStreamId" => @media_stream_id,
    "mediaStreamName" => @media_stream_name,
    "mediaStreamType" => @media_stream_type,
    "attributes" => @attributes,
    "clockRate" => @clock_rate,
    "description" => @description,
    "fmt" => @fmt,
    "tags" => @tags,
    "videoFormat" => @video_format,
  })
  result.compact
end

Class: AWSCDK::MediaConnect::CfnFlow::MediaStreamProperty

Overview

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(media_stream_id:, media_stream_name:, media_stream_type:, attributes: nil, clock_rate: nil, description: nil, fmt: nil, tags: nil, video_format: nil) ⇒ MediaStreamProperty

Instance Attribute Details

#attributes ⇒ AWSCDK::IResolvable, ... (readonly)

#clock_rate ⇒ Numeric? (readonly)

#description ⇒ String? (readonly)

#fmt ⇒ Numeric? (readonly)

#media_stream_id ⇒ Numeric (readonly)

#media_stream_name ⇒ String (readonly)

#media_stream_type ⇒ String (readonly)

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

#video_format ⇒ String? (readonly)

Class Method Details

.jsii_properties ⇒ Object

Instance Method Details

#to_jsii ⇒ Object

#initialize(media_stream_id:, media_stream_name:, media_stream_type:, attributes: nil, clock_rate: nil, description: nil, fmt: nil, tags: nil, video_format: nil) ⇒ `MediaStreamProperty`

#attributes ⇒ `AWSCDK::IResolvable`, ... (readonly)

#clock_rate ⇒ `Numeric`^? (readonly)

#description ⇒ `String`^? (readonly)

#fmt ⇒ `Numeric`^? (readonly)

#media_stream_id ⇒ `Numeric` (readonly)

#media_stream_name ⇒ `String` (readonly)

#media_stream_type ⇒ `String` (readonly)

#tags ⇒ `Array<AWSCDK::CfnTag>`^? (readonly)

#video_format ⇒ `String`^? (readonly)

.jsii_properties ⇒ `Object`

#to_jsii ⇒ `Object`