Skip to content

AddMediaStreamRequest

Source code in docs_src/capo_mediaconnect/types/add_media_stream_request.py
class AddMediaStreamRequest(TypedDict, closed=True):
    attributes: NotRequired[
        "capo_mediaconnect.types.media_stream_attributes_request.MediaStreamAttributesRequest"
    ]
    """<p> The attributes that you want to assign to the new media stream.</p>"""
    clock_rate: NotRequired["int"]
    """<p> 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.</p>"""
    description: NotRequired["str"]
    """<p> A description that can help you quickly identify what your media stream is used for.</p>"""
    media_stream_id: NotRequired["int"]
    """<p> A unique identifier for the media stream. </p>"""
    media_stream_name: NotRequired["str"]
    """<p> A name that helps you distinguish one media stream from another.</p>"""
    media_stream_type: NotRequired[
        "capo_mediaconnect.types.media_stream_type.MediaStreamType"
    ]
    """<p> The type of media stream.</p>"""
    video_format: NotRequired["str"]
    """<p> The resolution of the video.</p>"""
    media_stream_tags: NotRequired[
        "capo_mediaconnect.types.__map_of_string.__mapOfString"
    ]
    """<p> The key-value pairs that can be used to tag and organize the media stream. </p>"""

attributes instance-attribute

attributes: NotRequired[MediaStreamAttributesRequest]

The attributes that you want to assign to the new media stream.

clock_rate instance-attribute

clock_rate: NotRequired[int]

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 instance-attribute

description: NotRequired[str]

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

media_stream_id instance-attribute

media_stream_id: NotRequired[int]

A unique identifier for the media stream.

media_stream_name instance-attribute

media_stream_name: NotRequired[str]

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

media_stream_tags instance-attribute

media_stream_tags: NotRequired[__mapOfString]

The key-value pairs that can be used to tag and organize the media stream.

media_stream_type instance-attribute

media_stream_type: NotRequired[MediaStreamType]

The type of media stream.

video_format instance-attribute

video_format: NotRequired[str]

The resolution of the video.