Skip to content

Transport

Source code in docs_src/capo_mediaconnect/types/transport.py
class Transport(TypedDict, closed=True):
    cidr_allow_list: NotRequired[
        "capo_mediaconnect.types.__list_of_string.__listOfString"
    ]
    """<p> The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16</p>"""
    max_bitrate: NotRequired["int"]
    """<p> The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.</p>"""
    max_latency: NotRequired["int"]
    """<p> The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.</p>"""
    max_sync_buffer: NotRequired["int"]
    """<p> The size of the buffer (in milliseconds) to use to sync incoming source data.</p>"""
    min_latency: NotRequired["int"]
    """<p> The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.</p>"""
    protocol: NotRequired["capo_mediaconnect.types.protocol.Protocol"]
    """<p> The protocol that is used by the source or output.</p> <note> <p>Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.</p> </note>"""
    remote_id: NotRequired["str"]
    """<p> The remote ID for the Zixi-pull stream.</p>"""
    sender_control_port: NotRequired["int"]
    """<p> The port that the flow uses to send outbound requests to initiate connection with the sender.</p>"""
    sender_ip_address: NotRequired["str"]
    """<p> The IP address that the flow communicates with to initiate connection with the sender.</p>"""
    smoothing_latency: NotRequired["int"]
    """<p> The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.</p>"""
    source_listener_address: NotRequired["str"]
    """<p> Source IP or domain name for SRT-caller protocol.</p>"""
    source_listener_port: NotRequired["int"]
    """<p> Source port for SRT-caller protocol.</p>"""
    stream_id: NotRequired["str"]
    """<p> The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.</p>"""
    ndi_speed_hq_quality: NotRequired["int"]
    """<p>A quality setting for the NDI Speed HQ encoder. </p>"""
    ndi_program_name: NotRequired["str"]
    """<p>A suffix for the name of the NDI® sender that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. </p>"""
    ndi_source_settings: NotRequired[
        "capo_mediaconnect.types.ndi_source_settings.NdiSourceSettings"
    ]
    """<p> The settings for the NDI source. This includes the exact name of the upstream NDI sender that you want to connect to your source. </p>"""
    ndi_output_timecode_source: NotRequired[
        "capo_mediaconnect.types.ndi_output_timecode_source.NdiOutputTimecodeSource"
    ]
    """<p>The timecode source for NDI output frames. For NDI outputs, this field is always present and defaults to <code>EMBEDDED_TIMECODE</code>.</p> <ul> <li> <p> <code>EMBEDDED_TIMECODE</code> - Preserves timecodes from the input transport stream. The timecodes must be embedded in the video stream as SEI timing messages. If no embedded timecode is detected, MediaConnect uses the UTC system time instead.</p> </li> <li> <p> <code>UTC_SYSTEM_TIME</code> - Generates timecodes based on the system clock time when each frame is sent.</p> </li> </ul>"""
    ndi_audio_reference_level: NotRequired[
        "capo_mediaconnect.types.ndi_audio_reference_level.NdiAudioReferenceLevel"
    ]
    """<p>The audio reference level of the NDI receiver, in decibels relative to full scale (dBFS). Common values are <code>-20</code> (NDI and SMPTE) and <code>-18</code> (EBU). For NDI outputs, this field is always present and defaults to <code>-20</code>.</p>"""

cidr_allow_list instance-attribute

cidr_allow_list: NotRequired[__listOfString]

The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16

max_bitrate instance-attribute

max_bitrate: NotRequired[int]

The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.

max_latency instance-attribute

max_latency: NotRequired[int]

The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.

max_sync_buffer instance-attribute

max_sync_buffer: NotRequired[int]

The size of the buffer (in milliseconds) to use to sync incoming source data.

min_latency instance-attribute

min_latency: NotRequired[int]

The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.

ndi_audio_reference_level instance-attribute

ndi_audio_reference_level: NotRequired[NdiAudioReferenceLevel]

The audio reference level of the NDI receiver, in decibels relative to full scale (dBFS). Common values are -20 (NDI and SMPTE) and -18 (EBU). For NDI outputs, this field is always present and defaults to -20.

ndi_output_timecode_source instance-attribute

ndi_output_timecode_source: NotRequired[NdiOutputTimecodeSource]

The timecode source for NDI output frames. For NDI outputs, this field is always present and defaults to EMBEDDED_TIMECODE.

  • EMBEDDED_TIMECODE - Preserves timecodes from the input transport stream. The timecodes must be embedded in the video stream as SEI timing messages. If no embedded timecode is detected, MediaConnect uses the UTC system time instead.

  • UTC_SYSTEM_TIME - Generates timecodes based on the system clock time when each frame is sent.

ndi_program_name instance-attribute

ndi_program_name: NotRequired[str]

A suffix for the name of the NDI® sender that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.

ndi_source_settings instance-attribute

ndi_source_settings: NotRequired[NdiSourceSettings]

The settings for the NDI source. This includes the exact name of the upstream NDI sender that you want to connect to your source.

ndi_speed_hq_quality instance-attribute

ndi_speed_hq_quality: NotRequired[int]

A quality setting for the NDI Speed HQ encoder.

protocol instance-attribute

protocol: NotRequired[Protocol]

The protocol that is used by the source or output.

Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.

remote_id instance-attribute

remote_id: NotRequired[str]

The remote ID for the Zixi-pull stream.

sender_control_port instance-attribute

sender_control_port: NotRequired[int]

The port that the flow uses to send outbound requests to initiate connection with the sender.

sender_ip_address instance-attribute

sender_ip_address: NotRequired[str]

The IP address that the flow communicates with to initiate connection with the sender.

smoothing_latency instance-attribute

smoothing_latency: NotRequired[int]

The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

source_listener_address instance-attribute

source_listener_address: NotRequired[str]

Source IP or domain name for SRT-caller protocol.

source_listener_port instance-attribute

source_listener_port: NotRequired[int]

Source port for SRT-caller protocol.

stream_id instance-attribute

stream_id: NotRequired[str]

The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.