Skip to content

NdiMediaStreamInfo

Source code in docs_src/capo_mediaconnect/types/ndi_media_stream_info.py
class NdiMediaStreamInfo(TypedDict, closed=True):
    stream_type: NotRequired["str"]
    """<p> The type of media stream (for example, <code>Video</code> or <code>Audio</code>). </p>"""
    codec: NotRequired["str"]
    """<p> The codec used for the media stream. For NDI sources, use <code>speed-hq</code>. </p>"""
    stream_id: NotRequired["int"]
    """<p> A unique identifier for the media stream. </p>"""
    scan_mode: NotRequired["capo_mediaconnect.types.scan_mode.ScanMode"]
    """<p> The method used to display video frames. Used when the <code>streamType</code> is <code>Video</code>.</p>"""
    color: NotRequired["capo_mediaconnect.types.color_information.ColorInformation"]
    """<p> The color signaling of the video stream. Used when the <code>streamType</code> is <code>Video</code>. </p>"""
    frame_resolution: NotRequired[
        "capo_mediaconnect.types.frame_resolution.FrameResolution"
    ]
    """<p> The width and height dimensions of the video frame in pixels. Used when the <code>streamType</code> is <code>Video</code>. </p>"""
    frame_rate: NotRequired["str"]
    """<p> The number of video frames displayed per second. Used when the <code>streamType</code> is <code>Video</code>. </p>"""
    channels: NotRequired["int"]
    """<p> The number of audio channels in the stream. Used when the <code>streamType</code> is <code>Audio</code>.</p>"""
    sample_rate: NotRequired["int"]
    """<p> The number of audio samples captured per second, measured in kilohertz (kHz). Used when the <code>streamType</code> is <code>Audio</code>.</p>"""

channels instance-attribute

channels: NotRequired[int]

The number of audio channels in the stream. Used when the streamType is Audio.

codec instance-attribute

codec: NotRequired[str]

The codec used for the media stream. For NDI sources, use speed-hq.

color instance-attribute

color: NotRequired[ColorInformation]

The color signaling of the video stream. Used when the streamType is Video.

frame_rate instance-attribute

frame_rate: NotRequired[str]

The number of video frames displayed per second. Used when the streamType is Video.

frame_resolution instance-attribute

frame_resolution: NotRequired[FrameResolution]

The width and height dimensions of the video frame in pixels. Used when the streamType is Video.

sample_rate instance-attribute

sample_rate: NotRequired[int]

The number of audio samples captured per second, measured in kilohertz (kHz). Used when the streamType is Audio.

scan_mode instance-attribute

scan_mode: NotRequired[ScanMode]

The method used to display video frames. Used when the streamType is Video.

stream_id instance-attribute

stream_id: NotRequired[int]

A unique identifier for the media stream.

stream_type instance-attribute

stream_type: NotRequired[str]

The type of media stream (for example, Video or Audio).