CfnFlowMediaStreamProps

class aws_cdk.aws_mediaconnect.CfnFlowMediaStreamProps(*, flow_arn, media_stream_id, media_stream_name, media_stream_type, attributes=None, clock_rate=None, description=None, tags=None, video_format=None)

Bases: object

Properties for defining a CfnFlowMediaStream.

Parameters:

flow_arn (str) – The Amazon Resource Name (ARN) of the flow that the media stream belongs to.
media_stream_id (Union[int, float]) – A unique identifier for the media stream.
media_stream_name (str) – A name that helps you distinguish one media stream from another.
media_stream_type (str) – The type of media stream.
attributes (Union[IResolvable, MediaStreamAttributesProperty, Dict[str, Any], None]) – Attributes that are related to the media stream.
clock_rate (Union[int, float, None]) – The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
description (Optional[str]) – A description that can help you quickly identify what your media stream is used for.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The key-value pairs that can be used to tag and organize the media stream.
video_format (Optional[str]) – The resolution of the video. Required for a video media stream and rejected for other media stream types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowmediastream.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediaconnect as mediaconnect

cfn_flow_media_stream_props = mediaconnect.CfnFlowMediaStreamProps(
    flow_arn="flowArn",
    media_stream_id=123,
    media_stream_name="mediaStreamName",
    media_stream_type="mediaStreamType",

    # the properties below are optional
    attributes=mediaconnect.CfnFlowMediaStream.MediaStreamAttributesProperty(
        fmtp=mediaconnect.CfnFlowMediaStream.FmtpProperty(
            channel_order="channelOrder",
            colorimetry="colorimetry",
            exact_framerate="exactFramerate",
            par="par",
            range="range",
            scan_mode="scanMode",
            tcs="tcs"
        ),
        lang="lang"
    ),
    clock_rate=123,
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    video_format="videoFormat"
)

Attributes

attributes

Attributes that are related to the media stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowmediastream.html#cfn-mediaconnect-flowmediastream-attributes

clock_rate

The sample rate (in Hz) for the stream.

If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.