Networked Media Open Specifications

DOCS

Docs for v1.0.1

Overview

APIs

APIs - Client Side Implementation

APIs - Server Side Implementation

APIs - Query Parameters

APIs - Discovery

Data Model

Data Model - Endpoint

Data Model - Network Flow

Data Model - Network Device

Data Model - Network Link

APIS

RAML APIs for v1.0.1

NetworkControl API

JSON Schemas for v1.0.1

endpoint-patch

endpoint

endpoints

error

netctrl-base

network-device

network-devices

network-flow-patch

network-flow-receivers

network-flow

network-flows

network-link

network-links

EXAMPLES

JSON Examples for v1.0.1

netctrl-base-get-200

netctrl-endpoint-id-get-200

netctrl-endpoint-patch-request

netctrl-endpoint-put-request

netctrl-endpoints-get-200

netctrl-network-device-id-get-200

netctrl-network-devices-get-200

netctrl-network-flow-id-get-200

netctrl-network-flow-patch

netctrl-network-flow-put

netctrl-network-flow-receiver-post

netctrl-network-flows-get-200

netctrl-network-link-id-get-200

netctrl-network-links-get-200

VERSIONS

Branches

v1.1-dev

v1.0.x

Releases

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

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

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

DEVEL

Developer Links

GitHub Repo

API Testing Tool

CI Dashboard

SEARCH

IS-06 ➤ releases ➤ v1.0.0 ➤ examples ➤ Viewing old release. Click here for list of published releases.

Example netctrl-v1.0-endpoint-id-get-200.json

Get raw JSON

{ "id": "d9c88a0a-c0c8-4ec8-ade5-fde9106e5040", "chassis_id":"1e-a1-79-16-0a-6b", "port_id": "bf-f8-01-60-49-bc", "ip_address": "10.10.34.24", "attached_network_device": { "chassis_id": "7a-c9-d7-f0-e2-03", "port_id": "Ethernet 2/2" }, "max_bandwidth": "10Gbit/s", "role": "sender", "label": "Video transmitter gateway endpoint." }

Documentation built at 13:05:31 CDT on 2023-07-12.
(c) AMWA 2023. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.