Skip to content

AddOutputRequest

Source code in docs_src/capo_mediaconnect/types/add_output_request.py
class AddOutputRequest(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>"""
    description: NotRequired["str"]
    """<p> A description of the output. This description appears only on the Audit Manager console and will not be seen by the end user.</p>"""
    destination: NotRequired["str"]
    """<p> The IP address from which video will be sent to output destinations.</p>"""
    encryption: NotRequired["capo_mediaconnect.types.encryption.Encryption"]
    """<p> The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.</p>"""
    max_latency: NotRequired["int"]
    """<p> The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.</p>"""
    media_stream_output_configurations: NotRequired[
        "capo_mediaconnect.types.__list_of_media_stream_output_configuration_request.__listOfMediaStreamOutputConfigurationRequest"
    ]
    """<p> The media streams that are associated with the output, and the parameters for those associations.</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>"""
    name: NotRequired["str"]
    """<p> The name of the output. This value must be unique within the current flow.</p>"""
    port: NotRequired["int"]
    """<p> The port to use when content is distributed to this output.</p>"""
    protocol: NotRequired["capo_mediaconnect.types.protocol.Protocol"]
    """<p> The protocol to use for the 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 output 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>"""
    smoothing_latency: NotRequired["int"]
    """<p> The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.</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>"""
    vpc_interface_attachment: NotRequired[
        "capo_mediaconnect.types.vpc_interface_attachment.VpcInterfaceAttachment"
    ]
    """<p> The name of the VPC interface attachment to use for this output.</p>"""
    output_status: NotRequired["capo_mediaconnect.types.output_status.OutputStatus"]
    """<p> An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.</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>"""
    output_tags: NotRequired["capo_mediaconnect.types.__map_of_string.__mapOfString"]
    """<p> The key-value pairs that can be used to tag and organize the output. </p>"""
    router_integration_state: NotRequired["capo_mediaconnect.types.state.State"]
    """<p>Indicates whether to enable or disable router integration when creating a new flow output.</p>"""
    router_integration_transit_encryption: NotRequired[
        "capo_mediaconnect.types.flow_transit_encryption.FlowTransitEncryption"
    ]
    ndi_output_timecode_source: NotRequired[
        "capo_mediaconnect.types.ndi_output_timecode_source.NdiOutputTimecodeSource"
    ]
    """<p>Controls how MediaConnect generates timecodes for NDI output frames. If you don't specify this field, MediaConnect uses <code>EMBEDDED_TIMECODE</code>.</p> <ul> <li> <p> <code>EMBEDDED_TIMECODE</code> (default) - 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). If you don't specify this field, MediaConnect uses <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.

description instance-attribute

description: NotRequired[str]

A description of the output. This description appears only on the Audit Manager console and will not be seen by the end user.

destination instance-attribute

destination: NotRequired[str]

The IP address from which video will be sent to output destinations.

encryption instance-attribute

encryption: NotRequired[Encryption]

The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.

max_latency instance-attribute

max_latency: NotRequired[int]

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

media_stream_output_configurations instance-attribute

media_stream_output_configurations: NotRequired[
    __listOfMediaStreamOutputConfigurationRequest
]

The media streams that are associated with the output, and the parameters for those associations.

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.

name instance-attribute

name: NotRequired[str]

The name of the output. This value must be unique within the current flow.

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). If you don't specify this field, MediaConnect uses -20.

ndi_output_timecode_source instance-attribute

ndi_output_timecode_source: NotRequired[NdiOutputTimecodeSource]

Controls how MediaConnect generates timecodes for NDI output frames. If you don't specify this field, MediaConnect uses EMBEDDED_TIMECODE.

  • EMBEDDED_TIMECODE (default) - 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_speed_hq_quality instance-attribute

ndi_speed_hq_quality: NotRequired[int]

A quality setting for the NDI Speed HQ encoder.

output_status instance-attribute

output_status: NotRequired[OutputStatus]

An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.

output_tags instance-attribute

output_tags: NotRequired[__mapOfString]

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

port instance-attribute

port: NotRequired[int]

The port to use when content is distributed to this output.

protocol instance-attribute

protocol: NotRequired[Protocol]

The protocol to use for the 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 output stream.

router_integration_state instance-attribute

router_integration_state: NotRequired[State]

Indicates whether to enable or disable router integration when creating a new flow output.

router_integration_transit_encryption instance-attribute

router_integration_transit_encryption: NotRequired[FlowTransitEncryption]

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.

smoothing_latency instance-attribute

smoothing_latency: NotRequired[int]

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

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.

vpc_interface_attachment instance-attribute

vpc_interface_attachment: NotRequired[VpcInterfaceAttachment]

The name of the VPC interface attachment to use for this output.