Skip to content

NdiConfig

Used by
Source code in docs_src/capo_mediaconnect/types/ndi_config.py 
12
13
14
15
16
17
18
19
20
class NdiConfig(TypedDict, closed=True):
    ndi_state: NotRequired["capo_mediaconnect.types.ndi_state.NdiState"]
    """<p>A setting that controls whether NDI® sources or outputs can be used in the flow. </p> <p> The default value is <code>DISABLED</code>. This value must be set as <code>ENABLED</code> for your flow to support NDI sources or outputs. </p>"""
    machine_name: NotRequired["str"]
    """<p>A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix. </p>"""
    ndi_discovery_servers: NotRequired[
        "capo_mediaconnect.types.__list_of_ndi_discovery_server_config.__listOfNdiDiscoveryServerConfig"
    ]
    """<p>A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly. </p>"""

machine_name instance-attribute 

machine_name: NotRequired[str]

A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.

ndi_discovery_servers instance-attribute 

ndi_discovery_servers: NotRequired[__listOfNdiDiscoveryServerConfig]

A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly.

ndi_state instance-attribute 

ndi_state: NotRequired[NdiState]

A setting that controls whether NDI® sources or outputs can be used in the flow.

The default value is DISABLED. This value must be set as ENABLED for your flow to support NDI sources or outputs.