Networked Media Open Specifications

DOCS

Docs for v1.1.2

Overview

APIs

APIs - Client Side Implementation

APIs - Server Side Implementation

Interoperability

Interoperability - IS-04

Interoperability - Non-NMOS Devices

Behaviour

Behaviour - RTP Transport Type

Behaviour - MQTT Transport Type

Behaviour - WebSocket Transport Type

Controllers

Upgrade Path

APIS

RAML APIs for v1.1.2

Connection API

JSON Schemas for v1.1.2

activation-response-schema

activation-schema

bulk-receiver-post-schema

bulk-response-schema

bulk-sender-post-schema

connectionapi-base

connectionapi-bulk

connectionapi-receiver

connectionapi-sender

connectionapi-single

constraint-schema

constraints-schema-mqtt

constraints-schema-rtp

constraints-schema-websocket

constraints-schema

error

receiver-response-schema

receiver-stage-schema

receiver-transport-file

receiver_transport_params

receiver_transport_params_dash

receiver_transport_params_ext

receiver_transport_params_mqtt

receiver_transport_params_rtp

receiver_transport_params_websocket

sender-receiver-base

sender-response-schema

sender-stage-schema

sender_transport_params

sender_transport_params_dash

sender_transport_params_ext

sender_transport_params_mqtt

sender_transport_params_rtp

sender_transport_params_websocket

transporttype-response-schema

EXAMPLES

JSON Examples for v1.1.2

base-get-200

bulk-base-get-200

bulk-post-confirm

bulk-post-fail

bulk-receiver-post

bulk-sender-post

receiver-active-get-200-mqtt

receiver-active-get-200-uninit

receiver-active-get-200

receiver-constraints-get-200-2022-7

receiver-constraints-get-200-mqtt

receiver-constraints-get-200-websocket-ext

receiver-constraints-get-200

receiver-get-200-uninit

receiver-get-200

receiver-patch-absolute

receiver-patch-activation-only

receiver-patch-redundant-streams

receiver-patch-relative

receiver-patch-transportfile

receiver-patch-unicast

receiver-patch

receiver-pending-get-200

receiver-resource-get-200

receiver-stage-scheduled-absolute

receiver-stage-scheduled-relative

receiver-stage-scheduled-transportfile

receiver-stage-success-redundant-streams

receiver-stage-success

resourcelist-get-200

sender-active-get-mqtt

sender-active-get-uninit

sender-active-get

sender-constraints-get-200-2022-7

sender-constraints-get-200-mqtt

sender-constraints-get-200-websocket-ext

sender-constraints-get-200

sender-get-200-uninit

sender-get-200

sender-patch-absolute

sender-patch-activation-only

sender-patch-redundant-streams

sender-patch-relative

sender-patch-unicast

sender-patch

sender-resource-get-200

sender-stage-absolute-success

sender-stage-relative-success

sender-stage-success-redundant-streams

sender-stage-success

single-root

stage-error

stage-fail

transporttype-get

VERSIONS

Branches

v1.2-dev

v1.1.x

v1.0.x

Releases

v1.1.2

v1.1.1

v1.1.0

v1.0.2

v1.0.1

v1.0.0

IS

Interface Specifications

IS-04: Discovery & Registration

IS-05: Device Connection Management

IS-07: Event & Tally

IS-08: Audio Channel Mapping

IS-09: System Parameters

IS-10: Authorization

IS-11: Stream Compatibility Management

IS-12: Control Protocol

IS-13: Annotation

IS-14: Device Configuration

BCP

Best Common Practices

BCP-002-01: Natural Grouping

BCP-002-02: Asset Distinguishing Information

BCP-003-01: Secure Communications in NMOS Systems

BCP-003-02: Authorization in NMOS Systems

BCP-003-03: Certificate Provisioning in NMOS Systems

BCP-004-01: Receiver Capabilities

BCP-005-01: EDID to Receiver Capabilities Mapping

BCP-006-01: NMOS With JPEG XS

BCP-006-02: NMOS With H.264

BCP-006-03: NMOS With H.265

BCP-007-01: NMOS With NDI

BCP-008-01: NMOS Receiver Status

BCP-008-02: NMOS Sender Status

MS

Data Model Specifications

MS-04: ID & Timing Model

MS-05-01: NMOS Control Architecture

MS-05-02: AMWA NMOS Control Framework

MS-05-03: AMWA NMOS Control Block Specs

INFO

Informative Documents

INFO-002: Security Implementation Guide

INFO-003: Sink Metadata Processing Architecture

INFO-004: Implementation Guide for DNS-SD

INFO-005: Implementation Guide for NMOS Controllers

INFO-006: Implementation guide for NMOS Device Capabilities Control

REG

Parameter Registers

General Procedures and Criteria

Capabilities

Device Control Types

Device Types

Flow Attributes

Formats

Node Service Types

Sender Attributes

Source Attributes

Tags

Transports

Transport Parameters

F-SETS

Control Feature Sets

Identification

Monitoring

DEVEL

Developer Links

GitHub Repo

API Testing Tool

CI Dashboard

SEARCH

IS-05 ➤ releases ➤ v1.1.2 ➤ APIs ➤ schemas ➤

Schema constraints-schema-rtp.json

Show original (referenced schemas with $ref)

Get raw JSON

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "description": "Used to express the dynamic constraints on RTP transport parameters. These constraints may be set and changed at run time. Every transport parameter must have an entry, even if it is only an empty object.", "patternProperties": { "^ext_[a-zA-Z0-9_]+$": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" } }, "properties": { "destination_ip": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "destination_port": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "fec1D_destination_port": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "fec1D_source_port": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "fec2D_destination_port": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "fec2D_source_port": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "fec_block_height": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "fec_block_width": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "fec_destination_ip": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "fec_enabled": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "fec_mode": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "fec_type": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "interface_ip": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "multicast_ip": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "rtcp_destination_ip": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "rtcp_destination_port": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "rtcp_enabled": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "rtcp_source_port": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "rtp_enabled": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "source_ip": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" }, "source_port": { "additionalProperties": false, "description": "The constraints for a single transport parameter", "properties": { "description": { "description": "A human readable string describing the constraint (optional)", "type": "string" }, "enum": { "description": "An array of allowed values", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" }, { "type": "number" }, { "type": "string" } ] }, "minItems": 1, "type": "array", "uniqueItems": true }, "maximum": { "description": "The inclusive maximum value the parameter can be set to", "type": [ "integer", "number" ] }, "minimum": { "description": "The inclusive minimum value the parameter can be set to", "type": [ "integer", "number" ] }, "pattern": { "description": "A regex pattern that must be satisfied for this parameter", "format": "regex", "type": "string" } }, "type": "object" } }, "required": [ "source_ip", "destination_port", "rtp_enabled" ], "type": "object" }

 

{

    "$schema": "http://json-schema.org/draft-04/schema#",

    "additionalProperties": false,

    "description": "Used to express the dynamic constraints on RTP transport parameters. These constraints may be set and changed at run time. Every transport parameter must have an entry, even if it is only an empty object.",

    "patternProperties": {

        "^ext_[a-zA-Z0-9_]+$": {

            "additionalProperties": false,

            "description": "The constraints for a single transport parameter",

            "properties": {

                "description": {

                    "description": "A human readable string describing the constraint (optional)",

                    "type": "string"

                },

                "enum": {

                    "description": "An array of allowed values",

                    "items": {

                        "anyOf": [

                            {

                                "type": "boolean"

                            },

                            {

                                "type": "integer"

                            },

                            {

                                "type": "null"

                            },

                            {

                                "type": "number"

                            },

                            {

                                "type": "string"

                            }

                        ]

                    },

                    "minItems": 1,

                    "type": "array",

                    "uniqueItems": true

                },

                "maximum": {

                    "description": "The inclusive maximum value the parameter can be set to",

                    "type": [

                        "integer",

Documentation built at 04:16:11 CDT on 2025-04-02.
(c) AMWA 2025. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.