Skip to content

SetSourceRequest

Source code in docs_src/capo_mediaconnect/types/set_source_request.py
class SetSourceRequest(TypedDict, closed=True):
    decryption: NotRequired["capo_mediaconnect.types.encryption.Encryption"]
    """<p> The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.</p>"""
    description: NotRequired["str"]
    """<p> A description for the source. This value is not used or seen outside of the current MediaConnect account.</p>"""
    entitlement_arn: NotRequired["str"]
    """<p> The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.</p>"""
    ingest_port: NotRequired["int"]
    """<p> The port that the flow will be listening on for incoming content.</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>"""
    media_stream_source_configurations: NotRequired[
        "capo_mediaconnect.types.__list_of_media_stream_source_configuration_request.__listOfMediaStreamSourceConfigurationRequest"
    ]
    """<p> The media streams that are associated with the source, 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 source.</p>"""
    protocol: NotRequired["capo_mediaconnect.types.protocol.Protocol"]
    """<p> The protocol that is used by the source.</p> <note> <p>Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.</p> </note>"""
    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>"""
    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>"""
    vpc_interface_name: NotRequired["str"]
    """<p> The name of the VPC interface to use for this source.</p>"""
    whitelist_cidr: NotRequired["str"]
    """<p> The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.</p>"""
    gateway_bridge_source: NotRequired[
        "capo_mediaconnect.types.set_gateway_bridge_source_request.SetGatewayBridgeSourceRequest"
    ]
    """<p> The source configuration for cloud flows receiving a stream from a bridge.</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>"""
    source_tags: NotRequired["capo_mediaconnect.types.__map_of_string.__mapOfString"]
    """<p> The key-value pairs that can be used to tag and organize the source. </p>"""
    router_integration_state: NotRequired["capo_mediaconnect.types.state.State"]
    """<p>Indicates whether to enable or disable router integration when setting a flow source.</p>"""
    router_integration_transit_decryption: NotRequired[
        "capo_mediaconnect.types.flow_transit_encryption.FlowTransitEncryption"
    ]
    """<p>The decryption configuration for the flow source when router integration is enabled. Specifies how the source content should be decrypted when router integration is used.</p>"""

decryption instance-attribute

decryption: NotRequired[Encryption]

The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.

description instance-attribute

description: NotRequired[str]

A description for the source. This value is not used or seen outside of the current MediaConnect account.

entitlement_arn instance-attribute

entitlement_arn: NotRequired[str]

The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.

gateway_bridge_source instance-attribute

gateway_bridge_source: NotRequired[SetGatewayBridgeSourceRequest]

The source configuration for cloud flows receiving a stream from a bridge.

ingest_port instance-attribute

ingest_port: NotRequired[int]

The port that the flow will be listening on for incoming content.

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.

media_stream_source_configurations instance-attribute

media_stream_source_configurations: NotRequired[
    __listOfMediaStreamSourceConfigurationRequest
]

The media streams that are associated with the source, 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 source.

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.

protocol instance-attribute

protocol: NotRequired[Protocol]

The protocol that is used by the source.

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

router_integration_state instance-attribute

router_integration_state: NotRequired[State]

Indicates whether to enable or disable router integration when setting a flow source.

router_integration_transit_decryption instance-attribute

router_integration_transit_decryption: NotRequired[FlowTransitEncryption]

The decryption configuration for the flow source when router integration is enabled. Specifies how the source content should be decrypted when router integration is used.

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.

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.

source_tags instance-attribute

source_tags: NotRequired[__mapOfString]

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

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

vpc_interface_name: NotRequired[str]

The name of the VPC interface to use for this source.

whitelist_cidr instance-attribute

whitelist_cidr: NotRequired[str]

The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.