Schema receiver_transport_params_ndi_json.json

Show original (referenced schemas with $ref)

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "description": "Describes the transport parameters associated with the NDI transport. The constraints in this schema are minimum constraints, but may be further constrained at the constraints endpoint. NDI Receivers MUST support machine_name and source_name in the Receiver transport_params. Receivers MAY also support source_url, source_address and source_port.",
    "patternProperties": {
        "^ext_[a-zA-Z0-9_]+$": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "description": "Describes external Receiver transport parameters defined in other AMWA specifications. The constraints in this schema are minimum constraints, but may be further constrained at the constraints endpoint.",
            "title": "External Receiver Transport Parameters",
            "type": [
                "string",
                "boolean",
                "null",
                "number"
            ]
        }
    },
    "properties": {
        "interface_ip": {
            "anyOf": [
                {
                    "format": "ipv4"
                },
                {
                    "format": "ipv6"
                },
                {
                    "pattern": "^auto$"
                }
            ],
            "description": "IP address of the network interface the receiver should use. The receiver should provide an enum in the constraints endpoint, which contain the available interface addresses. If set to auto the receiver must determine which interface to use for itself.",
            "type": "string"
        },
        "machine_name": {
            "anyOf": [
                {
                    "format": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "The device name of the Native NDI Sender that is to be connected, as utilized by the NDI SDK. A controller MUST specify machine_name when making a connection. A null value indicates that the Receiver has not yet been configured.",
            "type": [
                "string",
                "null"
            ]
        },
        "source_ip": {
            "anyOf": [
                {
                    "format": "ipv4"
                },
                {
                    "format": "ipv6"
                },
                {
                    "type": "null"
                }
            ],
            "description": "The IP address that the sender is utilizing for the stream. If a receiver or controller specifies the source_address it MUST also specify source_port. If supported by the Receiver, a controller SHOULD specify source_address when making a connection if it is known, otherwise the controller MUST set it to null",
            "type": [
                "string",
                "null"
            ]
        },
        "source_name": {
            "anyOf": [
                {
                    "format": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "The name of the Native NDI Sender stream in the NDI domain that is to be connected. This property MUST NOT be concatenated with machine_name in the format machine_name (source_name). A controller MUST specify source_name when making a connection. A null value indicates that the Receiver has not yet been configured.",
            "type": [
                "string",
                "null"
            ]
        },
        "source_port": {
            "anyOf": [
                {
                    "maximum": 65535,
                    "minimum": 0
                },
                {
                    "type": "null"
                }
            ],
            "description": "The port number that the sender is utilizing for the stream. If a receiver or controller specifies the source_port it MUST also specify source_address. If supported by the Receiver, a controller SHOULD specify source_port when making a connection if it is known, otherwise the controller MUST set it to null.",
            "type": [
                "integer",
                "null"
            ]
        },
        "source_url": {
            "anyOf": [
                {
                    "format": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "The URL of the NDI Native Sender as utilized by the NDI SDK. The contents are proprietary to the NDI SDK and SHOULD NOT be interpreted.If supported by the Receiver, a controller MAY specify source_url when making a connection if it is known, otherwise the controller MUST set it to null.",
            "type": [
                "string",
                "null"
            ]
        }
    },
    "title": "NDI Receiver Transport Parameters",
    "type": "object"
}

 
{    "$schema": "http://json-schema.org/draft-04/schema#",    "additionalProperties": false,    "description": "Describes the transport parameters associated with the NDI transport. The constraints in this schema are minimum constraints, but may be further constrained at the constraints endpoint. NDI Receivers MUST support machine_name and source_name in the Receiver transport_params. Receivers MAY also support source_url, source_address and source_port.",    "patternProperties": {        "^ext_[a-zA-Z0-9_]+$": {            "$schema": "http://json-schema.org/draft-04/schema#",            "description": "Describes external Receiver transport parameters defined in other AMWA specifications. The constraints in this schema are minimum constraints, but may be further constrained at the constraints endpoint.",            "title": "External Receiver Transport Parameters",            "type": [                "string",                "boolean",                "null",                "number"            ]        }    },    "properties": {        "interface_ip": {            "anyOf": [                {                    "format": "ipv4"                },                {                    "format": "ipv6"                },                {                    "pattern": "^auto$"                }            ],            "description": "IP address of the network interface the receiver should use. The receiver should provide an enum in the constraints endpoint, which contain the available interface addresses. If set to auto the receiver must determine which interface to use for itself.",            "type": "string"        },        "machine_name": {            "anyOf": [                {                    "format": "string"                },                {                    "type": "null"

Documentation built at 04:50:57 CDT on 2024-08-29.
(c) AMWA 2024. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.