Networked Media Open Specifications

AMWA NMOS Annotation Specification: Overview [Work In Progress]

Index↑ · APIs→


AMWA IS-13 specifies how to update resource annotations in an NMOS system.

The Specification includes:

IS-13 is intended to be implemented on Nodes that support IS-04 NMOS Discovery & Registration, but it does not depend on such support.

The NMOS Glossary defines several common terms that have specific meanings in NMOS.

Use of Normative Language

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this documentation set are to be interpreted as described in RFC 2119.


Node Resources

IS-13 shares a common set of resource types with IS-04 and the Annotation API has endpoints which correspond with the IS-04 Node API. Under the Annotation API /node/ path, there is a Node resource at the /self endpoint, and a number of Devices, Sources, Flows, Senders and Receivers at /{resourceType}/{resourceId} endpoints.

Core Resource Properties

In the Annotation API, each resource provides only the core identity and annotation properties. That is, the id, version, label, description and tags. These properties are described in the IS-04 APIs: Common Keys section.

The id provides persistent identity for resources and the version identifies the instant at which a resource most recently changed. These are assigned by the Node implementing the API.

The label, description and tags of each resource have initial values assigned by the Node. IS-13 enables these annotation properties to be updated by a client with a PATCH request, subject to a node’s internal limitations.

Index↑ · APIs→