NvNmos
Loading...
Searching...
No Matches
Public Attributes | List of all members
_NvNmosSenderConfig Struct Reference

#include <nvnmos.h>

Public Attributes

NvNmosTransport transport
 
const char * transport_file
 

Detailed Description

Defines configuration settings used to create senders in an NvNmosNodeServer.

Member Data Documentation

◆ transport

NvNmosTransport _NvNmosSenderConfig::transport

Holds the transport used by the sender. Determines the format of transport_file. Defaults to NVNMOS_TRANSPORT_RTP for a zero-initialised configuration.

◆ transport_file

const char* _NvNmosSenderConfig::transport_file

Holds the transport file data used to configure the sender. Must not be null.

For NVNMOS_TRANSPORT_RTP, this is Session Description Protocol (SDP) data, which must be valid as per the relevant IETF RFC and SMPTE standards for the media format and transport. The 'ts-refclk' attributes are used to specify the node clock. The 'x-nvnmos-name' session-level attribute specifies the caller-chosen name for the sender, unique within the Node. The 'x-nvnmos-group-hint' session-level attribute may be used to specify a group hint tag for the sender. The 'x-nvnmos-src-port' media-level attribute is used to specify the source port from which the stream is transmitted. The 'x-nvnmos-iface-ip' media-level attribute is used to specify the interface IP address on which the stream is transmitted. The optional 'x-nvnmos-iface' media-level attribute supplies IS-04 interface metadata; otherwise the library attempts to resolve the interface IP automatically. The attribute value is: <interface-name> [<chassis-id>] <port-id> [<attached-chassis-id> <attached-port-id>]

For NVNMOS_TRANSPORT_MXL, this is an MXL flow definition (JSON) of the form consumed by the MXL library, with NvNmos extensions carried as entries in the 'tags' property (following the same URN convention as the standard 'urn:x-nmos:tag:grouphint/v1.0'). The 'urn:x-nvnmos:tag:name' tag (single-string array, required) specifies the caller-chosen name for the sender, unique within the Node. A group hint tag may be specified via the standard 'urn:x-nmos:tag:grouphint/v1.0' tag. The 'urn:x-nvnmos:tag:mxl-domain-id' tag (single-string array of a UUID, required) specifies the MXL domain for the sender; the IS-05 transport parameter defaults to 'auto' and is resolved at activation time from this value. The flow definition's top-level 'id' field (UUID string), if present, is used as the MXL flow identity for the sender's IS-05 transport parameter 'mxl_flow_id'; if absent, the NMOS Flow id (derived from NvNmosNodeConfig::seed and the 'urn:x-nvnmos:tag:name' value) is used in its place.


The documentation for this struct was generated from the following file: