Networked Media Open Specifications

DOCS

Docs for v1.3.3

Overview

APIs

APIs - Common Keys

APIs - Client Side Implementation Notes

APIs - Server Side Implementation Notes

APIs - Load Balancing & Redundancy

APIs - Query Parameters

Discovery

Discovery - Registered Operation

Discovery - Peer to Peer Operation

Behaviour

Behaviour - Registration

Behaviour - Querying

Behaviour - Nodes

Controllers

Data Model

Data Model - Identifier Mapping

Upgrade Path

APIS

RAML APIs for v1.3.3

Node API

Query API

Registration API

JSON Schemas for v1.3.3

clock_internal

clock_ptp

device

devices

error

flow

flow_audio

flow_audio_coded

flow_audio_raw

flow_core

flow_data

flow_json_data

flow_mux

flow_sdianc_data

flow_video

flow_video_coded

flow_video_raw

flows

node

nodeapi-base

nodeapi-receiver-target

nodes

queryapi-base

queryapi-subscription-response

queryapi-subscriptions-post-request

queryapi-subscriptions-response

queryapi-subscriptions-websocket

receiver

receiver_audio

receiver_core

receiver_data

receiver_mux

receiver_video

receivers

registrationapi-base

registrationapi-health-response

registrationapi-resource-post-request

registrationapi-resource-response

resource_core

sender

senders

source

source_audio

source_core

source_data

source_generic

sources

EXAMPLES

JSON Examples for v1.3.3

nodeapi-base-get-200

nodeapi-deviceid-get-200

nodeapi-devices-get-200

nodeapi-flowid-get-200

nodeapi-flows-get-200

nodeapi-receiverid-get-200

nodeapi-receivers-get-200

nodeapi-self-get-200

nodeapi-senderid-get-200

nodeapi-senders-get-200

nodeapi-sourceid-get-200

nodeapi-sources-get-200

queryapi-base-get-200

queryapi-deviceid-get-200

queryapi-devices-get-200

queryapi-flowid-get-200

queryapi-flows-get-200

queryapi-nodeid-get-200

queryapi-nodes-get-200

queryapi-receiverid-get-200

queryapi-receivers-get-200

queryapi-senderid-get-200

queryapi-senders-get-200

queryapi-sourceid-get-200

queryapi-sources-get-200

queryapi-subscriptionid-get-200

queryapi-subscriptions-get-200

queryapi-subscriptions-post-200

queryapi-subscriptions-post-request

registrationapi-base-get-200

registrationapi-health-get-200

registrationapi-health-post-200

registrationapi-resource-get-200

registrationapi-resource-post-200

registrationapi-resource-post-request

VERSIONS

Branches

v1.3.x

v1.2.x

v1.1.x

v1.0.x

Releases

v1.3.3

v1.3.2

v1.3.1

v1.3.0

v1.2.2

v1.2.1

v1.2.0

v1.1.3

v1.1.2

v1.1.1

v1.1.0

v1.0.3

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-04 ➤ branches ➤ v1.3.x ➤ APIs ➤ schemas ➤ Viewing live branch. Click here for list of published releases.

Schema queryapi-subscriptions-websocket.json

Show original (referenced schemas with $ref)

Get raw JSON

{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes a data Grain sent via the a Query API WebSocket subscription", "properties": { "creation_timestamp": { "description": "TAI timestamp at which this data Grain's metadata was generated in the format <ts_secs>:<ts_nsecs>", "pattern": "^[0-9]+:[0-9]+$", "type": "string" }, "duration": { "description": "Duration over which this Grain is valid or should be presented (if applicable)", "properties": { "denominator": { "description": "Denominator of the Grain duration", "minimum": 1, "type": "integer" }, "numerator": { "description": "Numerator of the Grain duration", "minimum": 0, "type": "integer" } }, "required": [ "numerator", "denominator" ], "type": "object" }, "flow_id": { "description": "Subscription ID under the /subscriptions/ resource of the Query API", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain": { "description": "Payload of the data Grain", "properties": { "data": { "description": "An array of changes which have occurred and are being passed to the subscription client", "items": { "description": "A single object identifying a change which has occurred under a particular API resource", "properties": { "path": { "description": "ID of the resource which has undergone a change (may be a Node ID, Device ID etc.)", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "post": { "description": "Representation of the resource undergoing a change after the change had occurred. Omitted if the resource no longer exists.", "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "api": { "description": "URL fragments required to connect to the Node API", "properties": { "endpoints": { "description": "Host, port and protocol details required to connect to the API", "items": { "properties": { "authorization": { "default": false, "description": "This endpoint requires authorization", "type": "boolean" }, "host": { "anyOf": [ { "format": "hostname" }, { "format": "ipv4" }, { "format": "ipv6" } ], "description": "IP address or hostname which the Node API is running on", "type": "string" }, "port": { "description": "Port number which the Node API is running on", "maximum": 65535, "minimum": 1, "type": "integer" }, "protocol": { "description": "Protocol supported by this instance of the Node API", "enum": [ "http", "https" ], "type": "string" } }, "required": [ "host", "port", "protocol" ], "type": "object" }, "type": "array" }, "versions": { "description": "Supported API versions running on this Node", "items": { "pattern": "^v[0-9]+\\.[0-9]+$", "type": "string" }, "type": "array" } }, "required": [ "versions", "endpoints" ], "type": "object" }, "caps": { "description": "Capabilities (not yet defined)", "type": "object" }, "clocks": { "description": "Clocks made available to Devices owned by this Node", "items": { "anyOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes a clock with no external reference", "properties": { "name": { "description": "Name of this refclock (unique for this set of clocks)", "pattern": "^clk[0-9]+$", "type": "string" }, "ref_type": { "description": "Type of external reference used by this clock", "enum": [ "internal" ], "type": "string" } }, "required": [ "name", "ref_type" ], "title": "Clock with no external reference", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes a clock referenced to PTP", "properties": { "gmid": { "description": "ID of the PTP reference used by this clock", "pattern": "^[0-9a-f]{2}-[0-9a-f]{2}-[0-9a-f]{2}-[0-9a-f]{2}-[0-9a-f]{2}-[0-9a-f]{2}-[0-9a-f]{2}-[0-9a-f]{2}$", "type": "string" }, "locked": { "description": "Lock state of this clock to the external reference. If true, this device follows the external reference, otherwise it has no defined relationship to the external reference", "type": "boolean" }, "name": { "description": "Name of this refclock (unique for this set of clocks)", "pattern": "^clk[0-9]+$", "type": "string" }, "ref_type": { "description": "Type of external reference used by this clock", "enum": [ "ptp" ], "type": "string" }, "traceable": { "description": "External refclock is synchronised to International Atomic Time (TAI)", "type": "boolean" }, "version": { "description": "Version of PTP reference used by this clock", "enum": [ "IEEE1588-2008" ], "type": "string" } }, "required": [ "name", "ref_type", "traceable", "version", "gmid", "locked" ], "title": "PTP clock", "type": "object" } ] }, "type": "array" }, "hostname": { "description": "Node hostname (optional, deprecated)", "format": "hostname", "type": "string" }, "href": { "description": "HTTP access href for the Node's API (deprecated)", "format": "uri", "type": "string" }, "interfaces": { "description": "Network interfaces made available to devices owned by this Node. Port IDs and Chassis IDs are used to inform topology discovery via IS-06, and require that interfaces implement ARP at a minimum, and ideally LLDP.", "items": { "properties": { "attached_network_device": { "properties": { "chassis_id": { "anyOf": [ { "description": "When the Chassis ID is a MAC address, use this format", "pattern": "^([0-9a-f]{2}-){5}([0-9a-f]{2})$", "type": "string" }, { "description": "When the Chassis ID is anything other than a MAC address, a freeform string may be used", "pattern": "^.+$", "type": "string" } ], "description": "Chassis ID of the attached network device, as signalled in LLDP received by this Node." }, "port_id": { "anyOf": [ { "description": "When the Port ID is a MAC address, use this format", "pattern": "^([0-9a-f]{2}-){5}([0-9a-f]{2})$", "type": "string" }, { "description": "When the Port ID is anything other than a MAC address, a freeform string may be used", "pattern": "^.+$", "type": "string" } ], "description": "Port ID of the attached network device, as signalled in LLDP received by this Node." } }, "required": [ "chassis_id", "port_id" ], "type": "object" }, "chassis_id": { "anyOf": [ { "description": "When the Chassis ID is a MAC address, use this format", "pattern": "^([0-9a-f]{2}-){5}([0-9a-f]{2})$", "type": "string" }, { "description": "When the Chassis ID is anything other than a MAC address, a freeform string may be used", "pattern": "^.+$", "type": "string" }, { "description": "When the Chassis ID is unavailable it should be set to null", "type": "null" } ], "description": "Chassis ID of the interface, as signalled in LLDP from this node. Set to null where LLDP is unsuitable for use (ie. virtualised environments)" }, "name": { "description": "Name of the interface (unique in scope of this node). This attribute is used by sub-resources of this node such as senders and receivers to refer to interfaces to which they are bound.", "type": "string" }, "port_id": { "description": "Port ID of the interface, as signalled in LLDP or via ARP responses from this node. Must be a MAC address", "pattern": "^([0-9a-f]{2}-){5}([0-9a-f]{2})$", "type": "string" } }, "required": [ "chassis_id", "port_id", "name" ], "type": "object" }, "type": "array" }, "services": { "description": "Array of objects containing a URN format type and href", "items": { "properties": { "authorization": { "default": false, "description": "This endpoint requires authorization", "type": "boolean" }, "href": { "description": "URL to reach a service running on the Node", "format": "uri", "type": "string" }, "type": { "description": "URN identifying the type of service", "format": "uri", "type": "string" } }, "required": [ "href", "type" ], "type": "object" }, "type": "array" } }, "required": [ "href", "caps", "api", "services", "clocks", "interfaces" ], "type": "object" } ], "description": "Describes the Node and the services which run on it", "title": "Node resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "controls": { "description": "Control endpoints exposed for the Device", "items": { "properties": { "authorization": { "default": false, "description": "This endpoint requires authorization", "type": "boolean" }, "href": { "description": "URL to reach a control endpoint, whether http or otherwise", "format": "uri", "type": "string" }, "type": { "description": "URN identifying the control format", "format": "uri", "type": "string" } }, "required": [ "href", "type" ], "type": "object" }, "type": "array" }, "node_id": { "description": "Globally unique identifier for the Node which initially created the Device. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "receivers": { "description": "UUIDs of Receivers attached to the Device (deprecated)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "senders": { "description": "UUIDs of Senders attached to the Device (deprecated)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "type": { "description": "Device type URN", "format": "uri", "oneOf": [ { "pattern": "^urn:x-nmos:device:" }, { "not": { "pattern": "^urn:x-nmos:" } } ], "type": "string" } }, "required": [ "type", "node_id", "senders", "receivers", "controls" ], "type": "object" } ], "description": "Describes a Device", "title": "Device resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes a Source", "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities (not yet defined)", "type": "object" }, "clock_name": { "description": "Reference to clock in the originating Node", "pattern": "^clk[0-9]+$", "type": [ "string", "null" ] }, "device_id": { "description": "Globally unique identifier for the Device which initially created the Source. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Maximum number of Grains per second for Flows derived from this Source. Corresponding Flow Grain rates may override this attribute. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Sources only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Source IDs of Grains which came together at the input to this Source (may change over the lifetime of this Source)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" } }, "required": [ "caps", "device_id", "parents", "clock_name" ], "type": "object" } ], "description": "Describes a Source", "title": "Source resource", "type": "object" }, { "properties": { "format": { "description": "Format of the data coming from the Source as a URN", "enum": [ "urn:x-nmos:format:video", "urn:x-nmos:format:mux" ], "format": "uri", "type": "string" } }, "required": [ "format" ], "type": "object" } ], "description": "Describes a generic Source", "title": "Generic Source resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities (not yet defined)", "type": "object" }, "clock_name": { "description": "Reference to clock in the originating Node", "pattern": "^clk[0-9]+$", "type": [ "string", "null" ] }, "device_id": { "description": "Globally unique identifier for the Device which initially created the Source. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Maximum number of Grains per second for Flows derived from this Source. Corresponding Flow Grain rates may override this attribute. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Sources only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Source IDs of Grains which came together at the input to this Source (may change over the lifetime of this Source)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" } }, "required": [ "caps", "device_id", "parents", "clock_name" ], "type": "object" } ], "description": "Describes a Source", "title": "Source resource", "type": "object" }, { "properties": { "channels": { "description": "Array of objects describing the audio channels", "items": { "properties": { "label": { "description": "Label for this channel (free text)", "type": "string" }, "symbol": { "description": "Symbol for this channel (from VSF TR-03 Appendix A)", "oneOf": [ { "enum": [ "L", "R", "C", "LFE", "Ls", "Rs", "Lss", "Rss", "Lrs", "Rrs", "Lc", "Rc", "Cs", "HI", "VIN", "M1", "M2", "Lt", "Rt", "Lst", "Rst", "S" ] }, { "description": "Numbered Source Channel", "pattern": "^NSC(0[0-9][0-9]|1[0-1][0-9]|12[0-8])$" }, { "description": "Undefined channel", "pattern": "^U(0[1-9]|[1-5][0-9]|6[0-4])$" } ], "type": "string" } }, "required": [ "label" ], "title": "Component", "type": "object" }, "minItems": 1, "type": "array" }, "format": { "description": "Format of the data coming from the Source as a URN", "enum": [ "urn:x-nmos:format:audio" ], "format": "uri", "type": "string" } }, "required": [ "format", "channels" ], "type": "object" } ], "description": "Describes an audio Source", "title": "Audio Source resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities (not yet defined)", "type": "object" }, "clock_name": { "description": "Reference to clock in the originating Node", "pattern": "^clk[0-9]+$", "type": [ "string", "null" ] }, "device_id": { "description": "Globally unique identifier for the Device which initially created the Source. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Maximum number of Grains per second for Flows derived from this Source. Corresponding Flow Grain rates may override this attribute. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Sources only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Source IDs of Grains which came together at the input to this Source (may change over the lifetime of this Source)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" } }, "required": [ "caps", "device_id", "parents", "clock_name" ], "type": "object" } ], "description": "Describes a Source", "title": "Source resource", "type": "object" }, { "properties": { "event_type": { "description": "Event type generated by this Source, if applicable", "type": "string" }, "format": { "description": "Format of the data coming from the Source as a URN", "enum": [ "urn:x-nmos:format:data" ], "format": "uri", "type": "string" } }, "required": [ "format" ], "type": "object" } ], "description": "Describes a data Source", "title": "Data Source resource", "type": "object" } ], "title": "Source resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "anyOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "colorspace": { "anyOf": [ { "enum": [ "BT601", "BT709", "BT2020", "BT2100" ] }, { "pattern": "^\\S+$" } ], "description": "Colorspace used for the video. Any values not defined in the enum should be defined in the NMOS Parameter Registers", "type": "string" }, "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:video" ], "format": "uri", "type": "string" }, "frame_height": { "description": "Height of the picture in pixels", "type": "integer" }, "frame_width": { "description": "Width of the picture in pixels", "type": "integer" }, "interlace_mode": { "default": "progressive", "description": "Interlaced video mode for frames in this Flow", "enum": [ "progressive", "interlaced_tff", "interlaced_bff", "interlaced_psf" ], "type": "string" }, "transfer_characteristic": { "anyOf": [ { "enum": [ "SDR", "HLG", "PQ" ] }, { "pattern": "^\\S+$" } ], "default": "SDR", "description": "Transfer characteristic. Any values not defined in the enum should be defined in the NMOS Parameter Registers", "type": "string" } }, "required": [ "format", "frame_width", "frame_height", "colorspace" ], "type": "object" } ], "description": "Describes a Video Flow", "title": "Video Flow resource", "type": "object" }, { "properties": { "components": { "description": "Array of objects describing the components", "items": { "properties": { "bit_depth": { "description": "Number of bits used to describe each sample", "type": "integer" }, "height": { "description": "Height of this component in pixels", "type": "integer" }, "name": { "description": "Name of this component", "enum": [ "Y", "Cb", "Cr", "I", "Ct", "Cp", "A", "R", "G", "B", "DepthMap" ], "type": "string" }, "width": { "description": "Width of this component in pixels", "type": "integer" } }, "required": [ "name", "width", "height", "bit_depth" ], "title": "component", "type": "object" }, "minItems": 1, "type": "array" }, "media_type": { "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "enum": [ "video/raw" ], "type": "string" } }, "required": [ "media_type", "components" ], "type": "object" } ], "description": "Describes a raw Video Flow", "title": "Raw Video Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "colorspace": { "anyOf": [ { "enum": [ "BT601", "BT709", "BT2020", "BT2100" ] }, { "pattern": "^\\S+$" } ], "description": "Colorspace used for the video. Any values not defined in the enum should be defined in the NMOS Parameter Registers", "type": "string" }, "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:video" ], "format": "uri", "type": "string" }, "frame_height": { "description": "Height of the picture in pixels", "type": "integer" }, "frame_width": { "description": "Width of the picture in pixels", "type": "integer" }, "interlace_mode": { "default": "progressive", "description": "Interlaced video mode for frames in this Flow", "enum": [ "progressive", "interlaced_tff", "interlaced_bff", "interlaced_psf" ], "type": "string" }, "transfer_characteristic": { "anyOf": [ { "enum": [ "SDR", "HLG", "PQ" ] }, { "pattern": "^\\S+$" } ], "default": "SDR", "description": "Transfer characteristic. Any values not defined in the enum should be defined in the NMOS Parameter Registers", "type": "string" } }, "required": [ "format", "frame_width", "frame_height", "colorspace" ], "type": "object" } ], "description": "Describes a Video Flow", "title": "Video Flow resource", "type": "object" }, { "properties": { "media_type": { "anyOf": [ { "enum": [ "video/H264", "video/vc2" ] }, { "pattern": "^video\\/[^\\s\\/]+$" } ], "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "not": { "enum": [ "video/raw" ] }, "type": "string" } }, "required": [ "media_type" ], "type": "object" } ], "description": "Describes a coded Video Flow", "title": "Coded Video Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:audio" ], "format": "uri", "type": "string" }, "sample_rate": { "description": "Number of audio samples per second for this Flow", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" } }, "required": [ "format", "sample_rate" ], "type": "object" } ], "description": "Describes an audio Flow", "title": "Audio Flow resource", "type": "object" }, { "properties": { "bit_depth": { "description": "Bit depth of the audio samples", "type": "integer" }, "media_type": { "anyOf": [ { "enum": [ "audio/L24", "audio/L20", "audio/L16", "audio/L8" ] }, { "pattern": "^audio\\/[^\\s\\/]+$" } ], "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "type": "string" } }, "required": [ "media_type", "bit_depth" ], "type": "object" } ], "description": "Describes a raw audio Flow", "title": "Raw Audio Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:audio" ], "format": "uri", "type": "string" }, "sample_rate": { "description": "Number of audio samples per second for this Flow", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" } }, "required": [ "format", "sample_rate" ], "type": "object" } ], "description": "Describes an audio Flow", "title": "Audio Flow resource", "type": "object" }, { "properties": { "media_type": { "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "not": { "pattern": "^audio\\/L[0-9]+$" }, "pattern": "^audio\\/[^\\s\\/]+$", "type": "string" } }, "required": [ "media_type" ], "type": "object" } ], "description": "Describes a coded audio Flow", "title": "Coded Audio Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:data" ], "format": "uri", "type": "string" }, "media_type": { "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "not": { "enum": [ "video/smpte291", "application/json" ] }, "pattern": "^[^\\s\\/]+\\/[^\\s\\/]+$", "type": "string" } }, "required": [ "format", "media_type" ], "type": "object" } ], "description": "Describes a generic data Flow", "title": "Generic data Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "DID_SDID": { "description": "List of Data identification and Secondary data identification words", "items": { "properties": { "DID": { "description": "Data identification word", "pattern": "^0x[0-9a-fA-F]{2}$", "type": "string" }, "SDID": { "description": "Secondary data identification word", "pattern": "^0x[0-9a-fA-F]{2}$", "type": "string" } }, "title": "entry", "type": "object" }, "type": "array" }, "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:data" ], "format": "uri", "type": "string" }, "media_type": { "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "enum": [ "video/smpte291" ], "type": "string" } }, "required": [ "format", "media_type" ], "type": "object" } ], "description": "Describes an SDI ancillary Flow", "title": "SDI ancillary Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "event_type": { "description": "Event type generated by this Flow, if applicable", "type": "string" }, "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:data" ], "format": "uri", "type": "string" }, "media_type": { "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "enum": [ "application/json" ], "type": "string" } }, "required": [ "format", "media_type" ], "type": "object" } ], "description": "Describes a JSON based Flow", "title": "JSON based Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:mux" ], "format": "uri", "type": "string" }, "media_type": { "anyOf": [ { "enum": [ "video/SMPTE2022-6" ] }, { "pattern": "^[^\\s\\/]+\\/[^\\s\\/]+$" } ], "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "type": "string" } }, "required": [ "format", "media_type" ], "type": "object" } ], "description": "Describes a mux Flow", "title": "Mux Flow resource", "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities of this sender", "properties": {}, "type": "object" }, "device_id": { "description": "Device ID which this Sender forms part of. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "flow_id": { "default": null, "description": "ID of the Flow currently passing via this Sender. Set to null when a Flow is not currently internally routed to the Sender.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": [ "string", "null" ] }, "interface_bindings": { "description": "Binding of Sender egress ports to interfaces on the parent Node.", "items": { "type": "string" }, "type": "array" }, "manifest_href": { "description": "HTTP(S) accessible URL to a file describing how to connect to the Sender. Set to null when the transport type used by the Sender does not require a transport file.", "format": "uri", "type": [ "string", "null" ] }, "subscription": { "description": "Object indicating how this Sender is currently configured to send data.", "properties": { "active": { "default": false, "description": "Sender is enabled and configured to send data", "type": "boolean" }, "receiver_id": { "default": null, "description": "UUID of the Receiver to which this Sender is currently configured to send data. Only set if it is active, uses a unicast push-based transport and is sending to an NMOS Receiver; otherwise null.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": [ "string", "null" ] } }, "required": [ "receiver_id", "active" ], "type": "object" }, "transport": { "description": "Transport type used by the Sender in URN format", "format": "uri", "oneOf": [ { "pattern": "^urn:x-nmos:transport:" }, { "not": { "pattern": "^urn:x-nmos:" } } ], "type": "string" } }, "required": [ "flow_id", "transport", "device_id", "manifest_href", "interface_bindings", "subscription" ], "type": "object" } ], "description": "Describes a sender", "title": "Sender resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes a Receiver", "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Device ID which this Receiver forms part of. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "interface_bindings": { "description": "Binding of Receiver ingress ports to interfaces on the parent Node.", "items": { "type": "string" }, "type": "array" }, "subscription": { "description": "Object indicating how this Receiver is currently configured to receive data.", "properties": { "active": { "default": false, "description": "Receiver is enabled and configured to receive data", "type": "boolean" }, "sender_id": { "default": null, "description": "UUID of the Sender from which this Receiver is currently configured to receive data. Only set if it is active and receiving from an NMOS Sender; otherwise null.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": [ "string", "null" ] } }, "required": [ "sender_id", "active" ], "type": "object" }, "transport": { "description": "Transport type accepted by the Receiver in URN format", "format": "uri", "oneOf": [ { "pattern": "^urn:x-nmos:transport:" }, { "not": { "pattern": "^urn:x-nmos:" } } ], "type": "string" } }, "required": [ "device_id", "transport", "interface_bindings", "subscription" ], "type": "object" } ], "description": "Describes a receiver", "title": "Receiver resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities", "properties": { "media_types": { "description": "Subclassifications of the format accepted, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "items": { "anyOf": [ { "enum": [ "video/raw", "video/H264", "video/vc2" ] }, { "pattern": "^video\\/[^\\s\\/]+$" } ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object" }, "format": { "description": "Type of Flow accepted by the Receiver as a URN", "enum": [ "urn:x-nmos:format:video" ], "format": "uri", "type": "string" } }, "required": [ "format", "caps" ], "type": "object" } ], "description": "Describes a video Receiver", "title": "Video Receiver resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Device ID which this Receiver forms part of. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "interface_bindings": { "description": "Binding of Receiver ingress ports to interfaces on the parent Node.", "items": { "type": "string" }, "type": "array" }, "subscription": { "description": "Object indicating how this Receiver is currently configured to receive data.", "properties": { "active": { "default": false, "description": "Receiver is enabled and configured to receive data", "type": "boolean" }, "sender_id": { "default": null, "description": "UUID of the Sender from which this Receiver is currently configured to receive data. Only set if it is active and receiving from an NMOS Sender; otherwise null.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": [ "string", "null" ] } }, "required": [ "sender_id", "active" ], "type": "object" }, "transport": { "description": "Transport type accepted by the Receiver in URN format", "format": "uri", "oneOf": [ { "pattern": "^urn:x-nmos:transport:" }, { "not": { "pattern": "^urn:x-nmos:" } } ], "type": "string" } }, "required": [ "device_id", "transport", "interface_bindings", "subscription" ], "type": "object" } ], "description": "Describes a receiver", "title": "Receiver resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities", "properties": { "media_types": { "description": "Subclassifications of the format accepted, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "items": { "anyOf": [ { "enum": [ "audio/L24", "audio/L20", "audio/L16", "audio/L8" ] }, { "pattern": "^audio\\/[^\\s\\/]+$" } ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object" }, "format": { "description": "Type of Flow accepted by the Receiver as a URN", "enum": [ "urn:x-nmos:format:audio" ], "format": "uri", "type": "string" } }, "required": [ "format", "caps" ], "type": "object" } ], "description": "Describes an audio Receiver", "title": "Audio Receiver resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Device ID which this Receiver forms part of. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "interface_bindings": { "description": "Binding of Receiver ingress ports to interfaces on the parent Node.", "items": { "type": "string" }, "type": "array" }, "subscription": { "description": "Object indicating how this Receiver is currently configured to receive data.", "properties": { "active": { "default": false, "description": "Receiver is enabled and configured to receive data", "type": "boolean" }, "sender_id": { "default": null, "description": "UUID of the Sender from which this Receiver is currently configured to receive data. Only set if it is active and receiving from an NMOS Sender; otherwise null.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": [ "string", "null" ] } }, "required": [ "sender_id", "active" ], "type": "object" }, "transport": { "description": "Transport type accepted by the Receiver in URN format", "format": "uri", "oneOf": [ { "pattern": "^urn:x-nmos:transport:" }, { "not": { "pattern": "^urn:x-nmos:" } } ], "type": "string" } }, "required": [ "device_id", "transport", "interface_bindings", "subscription" ], "type": "object" } ], "description": "Describes a receiver", "title": "Receiver resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities", "properties": { "event_types": { "description": "Subclassification of the event types accepted defined by the AMWA IS-07 specification", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "media_types": { "description": "Subclassifications of the format accepted, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "items": { "anyOf": [ { "enum": [ "video/smpte291", "application/json" ] }, { "pattern": "^[^\\s\\/]+\\/[^\\s\\/]+$" } ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object" }, "format": { "description": "Type of Flow accepted by the Receiver as a URN", "enum": [ "urn:x-nmos:format:data" ], "format": "uri", "type": "string" } }, "required": [ "format", "caps" ], "type": "object" } ], "description": "Describes a data Receiver", "title": "Data Receiver resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Device ID which this Receiver forms part of. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "interface_bindings": { "description": "Binding of Receiver ingress ports to interfaces on the parent Node.", "items": { "type": "string" }, "type": "array" }, "subscription": { "description": "Object indicating how this Receiver is currently configured to receive data.", "properties": { "active": { "default": false, "description": "Receiver is enabled and configured to receive data", "type": "boolean" }, "sender_id": { "default": null, "description": "UUID of the Sender from which this Receiver is currently configured to receive data. Only set if it is active and receiving from an NMOS Sender; otherwise null.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": [ "string", "null" ] } }, "required": [ "sender_id", "active" ], "type": "object" }, "transport": { "description": "Transport type accepted by the Receiver in URN format", "format": "uri", "oneOf": [ { "pattern": "^urn:x-nmos:transport:" }, { "not": { "pattern": "^urn:x-nmos:" } } ], "type": "string" } }, "required": [ "device_id", "transport", "interface_bindings", "subscription" ], "type": "object" } ], "description": "Describes a receiver", "title": "Receiver resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities", "properties": { "media_types": { "description": "Subclassifications of the format accepted, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "items": { "anyOf": [ { "enum": [ "video/SMPTE2022-6" ] }, { "pattern": "^[^\\s\\/]+\\/[^\\s\\/]+$" } ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object" }, "format": { "description": "Type of Flow accepted by the Receiver as a URN", "enum": [ "urn:x-nmos:format:mux" ], "format": "uri", "type": "string" } }, "required": [ "format", "caps" ], "type": "object" } ], "description": "Describes a mux Receiver", "title": "Mux Receiver resource", "type": "object" } ], "title": "Receiver resource", "type": "object" } ], "type": "object" }, "pre": { "description": "Representation of the resource undergoing a change prior to the change occurring. Omitted if the resource didn't previously exist.", "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "api": { "description": "URL fragments required to connect to the Node API", "properties": { "endpoints": { "description": "Host, port and protocol details required to connect to the API", "items": { "properties": { "authorization": { "default": false, "description": "This endpoint requires authorization", "type": "boolean" }, "host": { "anyOf": [ { "format": "hostname" }, { "format": "ipv4" }, { "format": "ipv6" } ], "description": "IP address or hostname which the Node API is running on", "type": "string" }, "port": { "description": "Port number which the Node API is running on", "maximum": 65535, "minimum": 1, "type": "integer" }, "protocol": { "description": "Protocol supported by this instance of the Node API", "enum": [ "http", "https" ], "type": "string" } }, "required": [ "host", "port", "protocol" ], "type": "object" }, "type": "array" }, "versions": { "description": "Supported API versions running on this Node", "items": { "pattern": "^v[0-9]+\\.[0-9]+$", "type": "string" }, "type": "array" } }, "required": [ "versions", "endpoints" ], "type": "object" }, "caps": { "description": "Capabilities (not yet defined)", "type": "object" }, "clocks": { "description": "Clocks made available to Devices owned by this Node", "items": { "anyOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes a clock with no external reference", "properties": { "name": { "description": "Name of this refclock (unique for this set of clocks)", "pattern": "^clk[0-9]+$", "type": "string" }, "ref_type": { "description": "Type of external reference used by this clock", "enum": [ "internal" ], "type": "string" } }, "required": [ "name", "ref_type" ], "title": "Clock with no external reference", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes a clock referenced to PTP", "properties": { "gmid": { "description": "ID of the PTP reference used by this clock", "pattern": "^[0-9a-f]{2}-[0-9a-f]{2}-[0-9a-f]{2}-[0-9a-f]{2}-[0-9a-f]{2}-[0-9a-f]{2}-[0-9a-f]{2}-[0-9a-f]{2}$", "type": "string" }, "locked": { "description": "Lock state of this clock to the external reference. If true, this device follows the external reference, otherwise it has no defined relationship to the external reference", "type": "boolean" }, "name": { "description": "Name of this refclock (unique for this set of clocks)", "pattern": "^clk[0-9]+$", "type": "string" }, "ref_type": { "description": "Type of external reference used by this clock", "enum": [ "ptp" ], "type": "string" }, "traceable": { "description": "External refclock is synchronised to International Atomic Time (TAI)", "type": "boolean" }, "version": { "description": "Version of PTP reference used by this clock", "enum": [ "IEEE1588-2008" ], "type": "string" } }, "required": [ "name", "ref_type", "traceable", "version", "gmid", "locked" ], "title": "PTP clock", "type": "object" } ] }, "type": "array" }, "hostname": { "description": "Node hostname (optional, deprecated)", "format": "hostname", "type": "string" }, "href": { "description": "HTTP access href for the Node's API (deprecated)", "format": "uri", "type": "string" }, "interfaces": { "description": "Network interfaces made available to devices owned by this Node. Port IDs and Chassis IDs are used to inform topology discovery via IS-06, and require that interfaces implement ARP at a minimum, and ideally LLDP.", "items": { "properties": { "attached_network_device": { "properties": { "chassis_id": { "anyOf": [ { "description": "When the Chassis ID is a MAC address, use this format", "pattern": "^([0-9a-f]{2}-){5}([0-9a-f]{2})$", "type": "string" }, { "description": "When the Chassis ID is anything other than a MAC address, a freeform string may be used", "pattern": "^.+$", "type": "string" } ], "description": "Chassis ID of the attached network device, as signalled in LLDP received by this Node." }, "port_id": { "anyOf": [ { "description": "When the Port ID is a MAC address, use this format", "pattern": "^([0-9a-f]{2}-){5}([0-9a-f]{2})$", "type": "string" }, { "description": "When the Port ID is anything other than a MAC address, a freeform string may be used", "pattern": "^.+$", "type": "string" } ], "description": "Port ID of the attached network device, as signalled in LLDP received by this Node." } }, "required": [ "chassis_id", "port_id" ], "type": "object" }, "chassis_id": { "anyOf": [ { "description": "When the Chassis ID is a MAC address, use this format", "pattern": "^([0-9a-f]{2}-){5}([0-9a-f]{2})$", "type": "string" }, { "description": "When the Chassis ID is anything other than a MAC address, a freeform string may be used", "pattern": "^.+$", "type": "string" }, { "description": "When the Chassis ID is unavailable it should be set to null", "type": "null" } ], "description": "Chassis ID of the interface, as signalled in LLDP from this node. Set to null where LLDP is unsuitable for use (ie. virtualised environments)" }, "name": { "description": "Name of the interface (unique in scope of this node). This attribute is used by sub-resources of this node such as senders and receivers to refer to interfaces to which they are bound.", "type": "string" }, "port_id": { "description": "Port ID of the interface, as signalled in LLDP or via ARP responses from this node. Must be a MAC address", "pattern": "^([0-9a-f]{2}-){5}([0-9a-f]{2})$", "type": "string" } }, "required": [ "chassis_id", "port_id", "name" ], "type": "object" }, "type": "array" }, "services": { "description": "Array of objects containing a URN format type and href", "items": { "properties": { "authorization": { "default": false, "description": "This endpoint requires authorization", "type": "boolean" }, "href": { "description": "URL to reach a service running on the Node", "format": "uri", "type": "string" }, "type": { "description": "URN identifying the type of service", "format": "uri", "type": "string" } }, "required": [ "href", "type" ], "type": "object" }, "type": "array" } }, "required": [ "href", "caps", "api", "services", "clocks", "interfaces" ], "type": "object" } ], "description": "Describes the Node and the services which run on it", "title": "Node resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "controls": { "description": "Control endpoints exposed for the Device", "items": { "properties": { "authorization": { "default": false, "description": "This endpoint requires authorization", "type": "boolean" }, "href": { "description": "URL to reach a control endpoint, whether http or otherwise", "format": "uri", "type": "string" }, "type": { "description": "URN identifying the control format", "format": "uri", "type": "string" } }, "required": [ "href", "type" ], "type": "object" }, "type": "array" }, "node_id": { "description": "Globally unique identifier for the Node which initially created the Device. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "receivers": { "description": "UUIDs of Receivers attached to the Device (deprecated)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "senders": { "description": "UUIDs of Senders attached to the Device (deprecated)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "type": { "description": "Device type URN", "format": "uri", "oneOf": [ { "pattern": "^urn:x-nmos:device:" }, { "not": { "pattern": "^urn:x-nmos:" } } ], "type": "string" } }, "required": [ "type", "node_id", "senders", "receivers", "controls" ], "type": "object" } ], "description": "Describes a Device", "title": "Device resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes a Source", "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities (not yet defined)", "type": "object" }, "clock_name": { "description": "Reference to clock in the originating Node", "pattern": "^clk[0-9]+$", "type": [ "string", "null" ] }, "device_id": { "description": "Globally unique identifier for the Device which initially created the Source. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Maximum number of Grains per second for Flows derived from this Source. Corresponding Flow Grain rates may override this attribute. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Sources only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Source IDs of Grains which came together at the input to this Source (may change over the lifetime of this Source)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" } }, "required": [ "caps", "device_id", "parents", "clock_name" ], "type": "object" } ], "description": "Describes a Source", "title": "Source resource", "type": "object" }, { "properties": { "format": { "description": "Format of the data coming from the Source as a URN", "enum": [ "urn:x-nmos:format:video", "urn:x-nmos:format:mux" ], "format": "uri", "type": "string" } }, "required": [ "format" ], "type": "object" } ], "description": "Describes a generic Source", "title": "Generic Source resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities (not yet defined)", "type": "object" }, "clock_name": { "description": "Reference to clock in the originating Node", "pattern": "^clk[0-9]+$", "type": [ "string", "null" ] }, "device_id": { "description": "Globally unique identifier for the Device which initially created the Source. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Maximum number of Grains per second for Flows derived from this Source. Corresponding Flow Grain rates may override this attribute. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Sources only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Source IDs of Grains which came together at the input to this Source (may change over the lifetime of this Source)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" } }, "required": [ "caps", "device_id", "parents", "clock_name" ], "type": "object" } ], "description": "Describes a Source", "title": "Source resource", "type": "object" }, { "properties": { "channels": { "description": "Array of objects describing the audio channels", "items": { "properties": { "label": { "description": "Label for this channel (free text)", "type": "string" }, "symbol": { "description": "Symbol for this channel (from VSF TR-03 Appendix A)", "oneOf": [ { "enum": [ "L", "R", "C", "LFE", "Ls", "Rs", "Lss", "Rss", "Lrs", "Rrs", "Lc", "Rc", "Cs", "HI", "VIN", "M1", "M2", "Lt", "Rt", "Lst", "Rst", "S" ] }, { "description": "Numbered Source Channel", "pattern": "^NSC(0[0-9][0-9]|1[0-1][0-9]|12[0-8])$" }, { "description": "Undefined channel", "pattern": "^U(0[1-9]|[1-5][0-9]|6[0-4])$" } ], "type": "string" } }, "required": [ "label" ], "title": "Component", "type": "object" }, "minItems": 1, "type": "array" }, "format": { "description": "Format of the data coming from the Source as a URN", "enum": [ "urn:x-nmos:format:audio" ], "format": "uri", "type": "string" } }, "required": [ "format", "channels" ], "type": "object" } ], "description": "Describes an audio Source", "title": "Audio Source resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities (not yet defined)", "type": "object" }, "clock_name": { "description": "Reference to clock in the originating Node", "pattern": "^clk[0-9]+$", "type": [ "string", "null" ] }, "device_id": { "description": "Globally unique identifier for the Device which initially created the Source. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Maximum number of Grains per second for Flows derived from this Source. Corresponding Flow Grain rates may override this attribute. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Sources only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Source IDs of Grains which came together at the input to this Source (may change over the lifetime of this Source)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" } }, "required": [ "caps", "device_id", "parents", "clock_name" ], "type": "object" } ], "description": "Describes a Source", "title": "Source resource", "type": "object" }, { "properties": { "event_type": { "description": "Event type generated by this Source, if applicable", "type": "string" }, "format": { "description": "Format of the data coming from the Source as a URN", "enum": [ "urn:x-nmos:format:data" ], "format": "uri", "type": "string" } }, "required": [ "format" ], "type": "object" } ], "description": "Describes a data Source", "title": "Data Source resource", "type": "object" } ], "title": "Source resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "anyOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "colorspace": { "anyOf": [ { "enum": [ "BT601", "BT709", "BT2020", "BT2100" ] }, { "pattern": "^\\S+$" } ], "description": "Colorspace used for the video. Any values not defined in the enum should be defined in the NMOS Parameter Registers", "type": "string" }, "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:video" ], "format": "uri", "type": "string" }, "frame_height": { "description": "Height of the picture in pixels", "type": "integer" }, "frame_width": { "description": "Width of the picture in pixels", "type": "integer" }, "interlace_mode": { "default": "progressive", "description": "Interlaced video mode for frames in this Flow", "enum": [ "progressive", "interlaced_tff", "interlaced_bff", "interlaced_psf" ], "type": "string" }, "transfer_characteristic": { "anyOf": [ { "enum": [ "SDR", "HLG", "PQ" ] }, { "pattern": "^\\S+$" } ], "default": "SDR", "description": "Transfer characteristic. Any values not defined in the enum should be defined in the NMOS Parameter Registers", "type": "string" } }, "required": [ "format", "frame_width", "frame_height", "colorspace" ], "type": "object" } ], "description": "Describes a Video Flow", "title": "Video Flow resource", "type": "object" }, { "properties": { "components": { "description": "Array of objects describing the components", "items": { "properties": { "bit_depth": { "description": "Number of bits used to describe each sample", "type": "integer" }, "height": { "description": "Height of this component in pixels", "type": "integer" }, "name": { "description": "Name of this component", "enum": [ "Y", "Cb", "Cr", "I", "Ct", "Cp", "A", "R", "G", "B", "DepthMap" ], "type": "string" }, "width": { "description": "Width of this component in pixels", "type": "integer" } }, "required": [ "name", "width", "height", "bit_depth" ], "title": "component", "type": "object" }, "minItems": 1, "type": "array" }, "media_type": { "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "enum": [ "video/raw" ], "type": "string" } }, "required": [ "media_type", "components" ], "type": "object" } ], "description": "Describes a raw Video Flow", "title": "Raw Video Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "colorspace": { "anyOf": [ { "enum": [ "BT601", "BT709", "BT2020", "BT2100" ] }, { "pattern": "^\\S+$" } ], "description": "Colorspace used for the video. Any values not defined in the enum should be defined in the NMOS Parameter Registers", "type": "string" }, "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:video" ], "format": "uri", "type": "string" }, "frame_height": { "description": "Height of the picture in pixels", "type": "integer" }, "frame_width": { "description": "Width of the picture in pixels", "type": "integer" }, "interlace_mode": { "default": "progressive", "description": "Interlaced video mode for frames in this Flow", "enum": [ "progressive", "interlaced_tff", "interlaced_bff", "interlaced_psf" ], "type": "string" }, "transfer_characteristic": { "anyOf": [ { "enum": [ "SDR", "HLG", "PQ" ] }, { "pattern": "^\\S+$" } ], "default": "SDR", "description": "Transfer characteristic. Any values not defined in the enum should be defined in the NMOS Parameter Registers", "type": "string" } }, "required": [ "format", "frame_width", "frame_height", "colorspace" ], "type": "object" } ], "description": "Describes a Video Flow", "title": "Video Flow resource", "type": "object" }, { "properties": { "media_type": { "anyOf": [ { "enum": [ "video/H264", "video/vc2" ] }, { "pattern": "^video\\/[^\\s\\/]+$" } ], "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "not": { "enum": [ "video/raw" ] }, "type": "string" } }, "required": [ "media_type" ], "type": "object" } ], "description": "Describes a coded Video Flow", "title": "Coded Video Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:audio" ], "format": "uri", "type": "string" }, "sample_rate": { "description": "Number of audio samples per second for this Flow", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" } }, "required": [ "format", "sample_rate" ], "type": "object" } ], "description": "Describes an audio Flow", "title": "Audio Flow resource", "type": "object" }, { "properties": { "bit_depth": { "description": "Bit depth of the audio samples", "type": "integer" }, "media_type": { "anyOf": [ { "enum": [ "audio/L24", "audio/L20", "audio/L16", "audio/L8" ] }, { "pattern": "^audio\\/[^\\s\\/]+$" } ], "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "type": "string" } }, "required": [ "media_type", "bit_depth" ], "type": "object" } ], "description": "Describes a raw audio Flow", "title": "Raw Audio Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:audio" ], "format": "uri", "type": "string" }, "sample_rate": { "description": "Number of audio samples per second for this Flow", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" } }, "required": [ "format", "sample_rate" ], "type": "object" } ], "description": "Describes an audio Flow", "title": "Audio Flow resource", "type": "object" }, { "properties": { "media_type": { "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "not": { "pattern": "^audio\\/L[0-9]+$" }, "pattern": "^audio\\/[^\\s\\/]+$", "type": "string" } }, "required": [ "media_type" ], "type": "object" } ], "description": "Describes a coded audio Flow", "title": "Coded Audio Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:data" ], "format": "uri", "type": "string" }, "media_type": { "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "not": { "enum": [ "video/smpte291", "application/json" ] }, "pattern": "^[^\\s\\/]+\\/[^\\s\\/]+$", "type": "string" } }, "required": [ "format", "media_type" ], "type": "object" } ], "description": "Describes a generic data Flow", "title": "Generic data Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "DID_SDID": { "description": "List of Data identification and Secondary data identification words", "items": { "properties": { "DID": { "description": "Data identification word", "pattern": "^0x[0-9a-fA-F]{2}$", "type": "string" }, "SDID": { "description": "Secondary data identification word", "pattern": "^0x[0-9a-fA-F]{2}$", "type": "string" } }, "title": "entry", "type": "object" }, "type": "array" }, "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:data" ], "format": "uri", "type": "string" }, "media_type": { "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "enum": [ "video/smpte291" ], "type": "string" } }, "required": [ "format", "media_type" ], "type": "object" } ], "description": "Describes an SDI ancillary Flow", "title": "SDI ancillary Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "event_type": { "description": "Event type generated by this Flow, if applicable", "type": "string" }, "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:data" ], "format": "uri", "type": "string" }, "media_type": { "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "enum": [ "application/json" ], "type": "string" } }, "required": [ "format", "media_type" ], "type": "object" } ], "description": "Describes a JSON based Flow", "title": "JSON based Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Globally unique identifier for the Device which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.1 onwards).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "grain_rate": { "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.", "properties": { "denominator": { "default": 1, "description": "Denominator", "type": "integer" }, "numerator": { "description": "Numerator", "type": "integer" } }, "required": [ "numerator" ], "type": "object" }, "parents": { "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)", "items": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "type": "array" }, "source_id": { "description": "Globally unique identifier for the Source which initially created the Flow. This attribute is used to ensure referential integrity by registry implementations (v1.0 only).", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" } }, "required": [ "source_id", "device_id", "parents" ], "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "properties": { "format": { "description": "Format of the data coming from the Flow as a URN", "enum": [ "urn:x-nmos:format:mux" ], "format": "uri", "type": "string" }, "media_type": { "anyOf": [ { "enum": [ "video/SMPTE2022-6" ] }, { "pattern": "^[^\\s\\/]+\\/[^\\s\\/]+$" } ], "description": "Subclassification of the format, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "type": "string" } }, "required": [ "format", "media_type" ], "type": "object" } ], "description": "Describes a mux Flow", "title": "Mux Flow resource", "type": "object" } ], "description": "Describes a Flow", "title": "Flow resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities of this sender", "properties": {}, "type": "object" }, "device_id": { "description": "Device ID which this Sender forms part of. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "flow_id": { "default": null, "description": "ID of the Flow currently passing via this Sender. Set to null when a Flow is not currently internally routed to the Sender.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": [ "string", "null" ] }, "interface_bindings": { "description": "Binding of Sender egress ports to interfaces on the parent Node.", "items": { "type": "string" }, "type": "array" }, "manifest_href": { "description": "HTTP(S) accessible URL to a file describing how to connect to the Sender. Set to null when the transport type used by the Sender does not require a transport file.", "format": "uri", "type": [ "string", "null" ] }, "subscription": { "description": "Object indicating how this Sender is currently configured to send data.", "properties": { "active": { "default": false, "description": "Sender is enabled and configured to send data", "type": "boolean" }, "receiver_id": { "default": null, "description": "UUID of the Receiver to which this Sender is currently configured to send data. Only set if it is active, uses a unicast push-based transport and is sending to an NMOS Receiver; otherwise null.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": [ "string", "null" ] } }, "required": [ "receiver_id", "active" ], "type": "object" }, "transport": { "description": "Transport type used by the Sender in URN format", "format": "uri", "oneOf": [ { "pattern": "^urn:x-nmos:transport:" }, { "not": { "pattern": "^urn:x-nmos:" } } ], "type": "string" } }, "required": [ "flow_id", "transport", "device_id", "manifest_href", "interface_bindings", "subscription" ], "type": "object" } ], "description": "Describes a sender", "title": "Sender resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes a Receiver", "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Device ID which this Receiver forms part of. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "interface_bindings": { "description": "Binding of Receiver ingress ports to interfaces on the parent Node.", "items": { "type": "string" }, "type": "array" }, "subscription": { "description": "Object indicating how this Receiver is currently configured to receive data.", "properties": { "active": { "default": false, "description": "Receiver is enabled and configured to receive data", "type": "boolean" }, "sender_id": { "default": null, "description": "UUID of the Sender from which this Receiver is currently configured to receive data. Only set if it is active and receiving from an NMOS Sender; otherwise null.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": [ "string", "null" ] } }, "required": [ "sender_id", "active" ], "type": "object" }, "transport": { "description": "Transport type accepted by the Receiver in URN format", "format": "uri", "oneOf": [ { "pattern": "^urn:x-nmos:transport:" }, { "not": { "pattern": "^urn:x-nmos:" } } ], "type": "string" } }, "required": [ "device_id", "transport", "interface_bindings", "subscription" ], "type": "object" } ], "description": "Describes a receiver", "title": "Receiver resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities", "properties": { "media_types": { "description": "Subclassifications of the format accepted, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "items": { "anyOf": [ { "enum": [ "video/raw", "video/H264", "video/vc2" ] }, { "pattern": "^video\\/[^\\s\\/]+$" } ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object" }, "format": { "description": "Type of Flow accepted by the Receiver as a URN", "enum": [ "urn:x-nmos:format:video" ], "format": "uri", "type": "string" } }, "required": [ "format", "caps" ], "type": "object" } ], "description": "Describes a video Receiver", "title": "Video Receiver resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Device ID which this Receiver forms part of. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "interface_bindings": { "description": "Binding of Receiver ingress ports to interfaces on the parent Node.", "items": { "type": "string" }, "type": "array" }, "subscription": { "description": "Object indicating how this Receiver is currently configured to receive data.", "properties": { "active": { "default": false, "description": "Receiver is enabled and configured to receive data", "type": "boolean" }, "sender_id": { "default": null, "description": "UUID of the Sender from which this Receiver is currently configured to receive data. Only set if it is active and receiving from an NMOS Sender; otherwise null.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": [ "string", "null" ] } }, "required": [ "sender_id", "active" ], "type": "object" }, "transport": { "description": "Transport type accepted by the Receiver in URN format", "format": "uri", "oneOf": [ { "pattern": "^urn:x-nmos:transport:" }, { "not": { "pattern": "^urn:x-nmos:" } } ], "type": "string" } }, "required": [ "device_id", "transport", "interface_bindings", "subscription" ], "type": "object" } ], "description": "Describes a receiver", "title": "Receiver resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities", "properties": { "media_types": { "description": "Subclassifications of the format accepted, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "items": { "anyOf": [ { "enum": [ "audio/L24", "audio/L20", "audio/L16", "audio/L8" ] }, { "pattern": "^audio\\/[^\\s\\/]+$" } ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object" }, "format": { "description": "Type of Flow accepted by the Receiver as a URN", "enum": [ "urn:x-nmos:format:audio" ], "format": "uri", "type": "string" } }, "required": [ "format", "caps" ], "type": "object" } ], "description": "Describes an audio Receiver", "title": "Audio Receiver resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Device ID which this Receiver forms part of. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "interface_bindings": { "description": "Binding of Receiver ingress ports to interfaces on the parent Node.", "items": { "type": "string" }, "type": "array" }, "subscription": { "description": "Object indicating how this Receiver is currently configured to receive data.", "properties": { "active": { "default": false, "description": "Receiver is enabled and configured to receive data", "type": "boolean" }, "sender_id": { "default": null, "description": "UUID of the Sender from which this Receiver is currently configured to receive data. Only set if it is active and receiving from an NMOS Sender; otherwise null.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": [ "string", "null" ] } }, "required": [ "sender_id", "active" ], "type": "object" }, "transport": { "description": "Transport type accepted by the Receiver in URN format", "format": "uri", "oneOf": [ { "pattern": "^urn:x-nmos:transport:" }, { "not": { "pattern": "^urn:x-nmos:" } } ], "type": "string" } }, "required": [ "device_id", "transport", "interface_bindings", "subscription" ], "type": "object" } ], "description": "Describes a receiver", "title": "Receiver resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities", "properties": { "event_types": { "description": "Subclassification of the event types accepted defined by the AMWA IS-07 specification", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "media_types": { "description": "Subclassifications of the format accepted, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "items": { "anyOf": [ { "enum": [ "video/smpte291", "application/json" ] }, { "pattern": "^[^\\s\\/]+\\/[^\\s\\/]+$" } ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object" }, "format": { "description": "Type of Flow accepted by the Receiver as a URN", "enum": [ "urn:x-nmos:format:data" ], "format": "uri", "type": "string" } }, "required": [ "format", "caps" ], "type": "object" } ], "description": "Describes a data Receiver", "title": "Data Receiver resource", "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Describes the foundations of all NMOS resources", "properties": { "description": { "description": "Detailed description of the resource", "type": "string" }, "id": { "description": "Globally unique identifier for the resource", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "label": { "description": "Freeform string label for the resource", "type": "string" }, "tags": { "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.", "patternProperties": { "": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "version": { "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "id", "version", "label", "description", "tags" ], "title": "Base resource", "type": "object" }, { "properties": { "device_id": { "description": "Device ID which this Receiver forms part of. This attribute is used to ensure referential integrity by registry implementations.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "interface_bindings": { "description": "Binding of Receiver ingress ports to interfaces on the parent Node.", "items": { "type": "string" }, "type": "array" }, "subscription": { "description": "Object indicating how this Receiver is currently configured to receive data.", "properties": { "active": { "default": false, "description": "Receiver is enabled and configured to receive data", "type": "boolean" }, "sender_id": { "default": null, "description": "UUID of the Sender from which this Receiver is currently configured to receive data. Only set if it is active and receiving from an NMOS Sender; otherwise null.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": [ "string", "null" ] } }, "required": [ "sender_id", "active" ], "type": "object" }, "transport": { "description": "Transport type accepted by the Receiver in URN format", "format": "uri", "oneOf": [ { "pattern": "^urn:x-nmos:transport:" }, { "not": { "pattern": "^urn:x-nmos:" } } ], "type": "string" } }, "required": [ "device_id", "transport", "interface_bindings", "subscription" ], "type": "object" } ], "description": "Describes a receiver", "title": "Receiver resource", "type": "object" }, { "properties": { "caps": { "description": "Capabilities", "properties": { "media_types": { "description": "Subclassifications of the format accepted, using IANA assigned media types where available, or other values defined in the NMOS Parameter Registers", "items": { "anyOf": [ { "enum": [ "video/SMPTE2022-6" ] }, { "pattern": "^[^\\s\\/]+\\/[^\\s\\/]+$" } ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object" }, "format": { "description": "Type of Flow accepted by the Receiver as a URN", "enum": [ "urn:x-nmos:format:mux" ], "format": "uri", "type": "string" } }, "required": [ "format", "caps" ], "type": "object" } ], "description": "Describes a mux Receiver", "title": "Mux Receiver resource", "type": "object" } ], "title": "Receiver resource", "type": "object" } ], "type": "object" } }, "required": [ "path" ], "type": "object" }, "minItems": 1, "type": "array", "uniqueItems": true }, "topic": { "description": "Query API topic which has been subscribed to using this WebSocket", "enum": [ "/nodes/", "/devices/", "/sources/", "/flows/", "/senders/", "/receivers/" ], "type": "string" }, "type": { "description": "Format classifier for the data contained in this payload", "enum": [ "urn:x-nmos:format:data.event" ], "format": "uri", "type": "string" } }, "required": [ "type", "topic", "data" ], "type": "object" }, "grain_type": { "description": "Type of data contained within the 'grain' attribute's payload", "enum": [ "event" ], "type": "string" }, "origin_timestamp": { "description": "TAI timestamp at which this data Grain's payload was generated in the format <ts_secs>:<ts_nsecs>", "pattern": "^[0-9]+:[0-9]+$", "type": "string" }, "rate": { "description": "Rate at which Grains will be received within this Flow (if applicable)", "properties": { "denominator": { "description": "Denominator of the Grain rate", "minimum": 1, "type": "integer" }, "numerator": { "description": "Numerator of the Grain rate", "minimum": 0, "type": "integer" } }, "required": [ "numerator", "denominator" ], "type": "object" }, "source_id": { "description": "Source ID of the Query API instance issuing the data Grain", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "sync_timestamp": { "description": "TAI timestamp at which this data Grain's payload was generated in the format <ts_secs>:<ts_nsecs>", "pattern": "^[0-9]+:[0-9]+$", "type": "string" } }, "required": [ "grain_type", "source_id", "flow_id", "origin_timestamp", "sync_timestamp", "creation_timestamp", "rate", "duration", "grain" ], "title": "Query API data Grain", "type": "object" }

​x

 

{

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

    "description": "Describes a data Grain sent via the a Query API WebSocket subscription",

    "properties": {↤9↦},

    "required": [

        "grain_type",

        "source_id",

        "flow_id",

        "origin_timestamp",

        "sync_timestamp",

        "creation_timestamp",

        "rate",

        "duration",

        "grain"

    ],

    "title": "Query API data Grain",

    "type": "object"

}

​

Documentation built at 05:12:15 CST on 2024-12-11.
(c) AMWA 2024. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.