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 flows.json

Show original (referenced schemas with $ref)

Get raw JSON

{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "A list of Flow resources", "items": { "$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" }, "title": "Collection of Flows", "type": "array", "uniqueItems": true }

​x

 

{

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

    "description": "A list of Flow resources",

    "items": {↤5↦},

    "title": "Collection of Flows",

    "type": "array",

    "uniqueItems": true

}

​

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.