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 ➤ examples ➤ Viewing live branch. Click here for list of published releases.

Example queryapi-deviceid-get-200.json

Get raw JSON

{ "receivers": [ "863532de-a97d-4597-989a-e79688f2d5f9", "632d7e6d-7357-44de-a425-a94fbe94974e", "95ef711b-564d-4655-a98b-5b9ccfb419d7", "9ee74607-f831-42f5-af08-a614ce0706df", "1311bf13-869c-45b4-915e-8b4e8b8e26fd", "debcd758-129d-4e0b-a0e3-f1d9ce5edfbc", "0fee9741-e266-4c27-b480-1f897463ea4b", "ef9e58bd-431a-466d-a67f-0318858b981c", "68ca0867-ec4b-4eca-92e0-4c4c668a72b0" ], "label": "pipeline 1 default device", "description": "pipeline 1 default device", "tags": {}, "version": "1441723676:366608283", "senders": [], "id": "a370d258-69de-4422-860a-ee4cf32ee9f4", "node_id": "3a25a674-e6eb-4987-84ad-ef479fe4d527", "type": "urn:x-nmos:device:pipeline", "controls": [ { "type": "urn:x-manufacturer:control:generic", "href": "wss://154.67.62.2:4635", "authorization": false } ] }

​x

 

1

{

2

    "receivers": [

3

        "863532de-a97d-4597-989a-e79688f2d5f9",

4

        "632d7e6d-7357-44de-a425-a94fbe94974e",

5

        "95ef711b-564d-4655-a98b-5b9ccfb419d7",

6

        "9ee74607-f831-42f5-af08-a614ce0706df",

7

        "1311bf13-869c-45b4-915e-8b4e8b8e26fd",

8

        "debcd758-129d-4e0b-a0e3-f1d9ce5edfbc",

9

        "0fee9741-e266-4c27-b480-1f897463ea4b",

10

        "ef9e58bd-431a-466d-a67f-0318858b981c",

11

        "68ca0867-ec4b-4eca-92e0-4c4c668a72b0"

12

    ],

13

    "label": "pipeline 1 default device",

14

    "description": "pipeline 1 default device",

15

    "tags": {},

16

    "version": "1441723676:366608283",

17

    "senders": [],

18

    "id": "a370d258-69de-4422-860a-ee4cf32ee9f4",

19

    "node_id": "3a25a674-e6eb-4987-84ad-ef479fe4d527",

20

    "type": "urn:x-nmos:device:pipeline",

21

    "controls": [

22

        {

23

            "type": "urn:x-manufacturer:control:generic",

24

            "href": "wss://154.67.62.2:4635",

25

            "authorization": false

26

        }

27

    ]

28

}

29

​

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.