is-13 | AMWA IS-13 NMOS Annotation Specification [Work In Progress]

<!DOCTYPE html> <meta name="viewport" content="width=device-width, initial-scale=1"> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1">  <title>is-13 | AMWA IS-13 NMOS Annotation Specification [Work In Progress]</title> <meta name="generator" content="Jekyll v3.9.3" /> <meta property="og:title" content="is-13" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="AMWA IS-13 NMOS Annotation Specification [Work In Progress]" /> <meta property="og:description" content="AMWA IS-13 NMOS Annotation Specification [Work In Progress]" /> <meta property="og:site_name" content="is-13" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary" /> <meta property="twitter:title" content="is-13" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebSite","description":"AMWA IS-13 NMOS Annotation Specification [Work In Progress]","headline":"is-13","name":"is-13","url":"/is-13/"}</script>  <link rel="stylesheet" href="/is-13/assets/css/style.css?v="> </head> <body> <div class="container-lg px-3 my-5 markdown-body adaptive-width"> <div id="logo-banner" class="adaptive-width"> <a href="https://specs.amwa.tv/nmos"><img id="nmos-logo" src="/is-13/assets/images/NMOS-logo.png" alt="NMOS logo"/></a> <span id="title">Networked Media Open Specifications</span> <a href="https://www.amwa.tv/"><img id="from-amwa-logo" src="/is-13/assets/images/from-AMWA-logo.png" target="_blank" alt="from AMWA logo"/></a> </div> <div id="menu-header" class="header adaptive-width"> <span class="dropdown">DOCS <div class="dropdown-content"> <p><b>Docs for v1.0-dev</b></p> <p><a href="/is-13/branches/v1.0-dev/docs/Overview.html">Overview</a></p> <p><a href="/is-13/branches/v1.0-dev/docs/APIs.html">APIs</a></p> <p><a href="/is-13/branches/v1.0-dev/docs/APIs_-_Server_Side_Implementation.html">APIs - Server Side Implementation</a></p> <p><a href="/is-13/branches/v1.0-dev/docs/APIs_-_Client_Side_Implementation.html">APIs - Client Side Implementation</a></p> <p><a href="/is-13/branches/v1.0-dev/docs/Behaviour.html">Behaviour</a></p> <p><a href="/is-13/branches/v1.0-dev/docs/Interoperability_-_IS-04.html">Interoperability - IS-04</a></p> </div> </span> <span class="dropdown">APIS <div class="dropdown-content"> <p><b>RAML APIs for v1.0-dev</b></p> <p><a href="/is-13/branches/v1.0-dev/APIs/AnnotationAPI.html">Annotation API</a></p> <p><b>JSON Schemas for v1.0-dev</b></p> <p><a href="/is-13/branches/v1.0-dev/APIs/schemas/with-refs/annotationapi-base.html">annotationapi-base</a></p> <p><a href="/is-13/branches/v1.0-dev/APIs/schemas/with-refs/annotationapi-node-base.html">annotationapi-node-base</a></p> <p><a href="/is-13/branches/v1.0-dev/APIs/schemas/with-refs/error.html">error</a></p> <p><a href="/is-13/branches/v1.0-dev/APIs/schemas/with-refs/resource-list.html">resource-list</a></p> <p><a href="/is-13/branches/v1.0-dev/APIs/schemas/with-refs/resource_core.html">resource_core</a></p> <p><a href="/is-13/branches/v1.0-dev/APIs/schemas/with-refs/resource_core_patch.html">resource_core_patch</a></p> </div> </span> <span class="dropdown">EXAMPLES <div class="dropdown-content"> <p><b>JSON Examples for v1.0-dev</b></p> <p><a href="/is-13/branches/v1.0-dev/examples/annotationapi-base-get-200.html">annotationapi-base-get-200</a></p> <p><a href="/is-13/branches/v1.0-dev/examples/annotationapi-node-base-get-200.html">annotationapi-node-base-get-200</a></p> <p><a href="/is-13/branches/v1.0-dev/examples/annotationapi-node-resource-get-200.html">annotationapi-node-resource-get-200</a></p> <p><a href="/is-13/branches/v1.0-dev/examples/annotationapi-node-resource-patch-tags.html">annotationapi-node-resource-patch-tags</a></p> <p><a href="/is-13/branches/v1.0-dev/examples/annotationapi-node-resource-patch.html">annotationapi-node-resource-patch</a></p> <p><a href="/is-13/branches/v1.0-dev/examples/annotationapi-node-resources-get-200.html">annotationapi-node-resources-get-200</a></p> </div> </span> <span class="dropdown">VERSIONS <div class="dropdown-content"> <p><b>Branches</b></p> <p><a href="/is-13/branches/v1.0-dev">v1.0-dev</a></p> <p><em>No releases yet</em></p> </div> </span> <span class="dropdown">IS <div class="dropdown-content"> <p><b>Interface Specifications</b></p> <p><a href="https://specs.amwa.tv/is-04">IS-04: Discovery & Registration</a></p> <p><a href="https://specs.amwa.tv/is-05">IS-05: Device Connection Management</a></p> <p><a href="https://specs.amwa.tv/is-07">IS-07: Event & Tally</a></p> <p><a href="https://specs.amwa.tv/is-08">IS-08: Audio Channel Mapping</a></p> <p><a href="https://specs.amwa.tv/is-09">IS-09: System Parameters</a></p> <p><a href="https://specs.amwa.tv/is-10">IS-10: Authorization</a></p> <p><a href="https://specs.amwa.tv/is-11">IS-11: Stream Compatibility Management</a></p> <p><a href="https://specs.amwa.tv/is-12">IS-12: Control Protocol</a></p> <p><a href="https://specs.amwa.tv/is-13">IS-13: Annotation</a></p> <p><a href="https://specs.amwa.tv/is-14">IS-14: Device Configuration</a></p> </div> </span> <span class="dropdown">BCP <div class="dropdown-content"> <p><b>Best Common Practices</b></p> <p><a href="https://specs.amwa.tv/bcp-002-01">BCP-002-01: Natural Grouping</a></p> <p><a href="https://specs.amwa.tv/bcp-002-02">BCP-002-02: Asset Distinguishing Information</a></p> <p><a href="https://specs.amwa.tv/bcp-003-01">BCP-003-01: Secure Communications in NMOS Systems</a></p> <p><a href="https://specs.amwa.tv/bcp-003-02">BCP-003-02: Authorization in NMOS Systems</a></p> <p><a href="https://specs.amwa.tv/bcp-003-03">BCP-003-03: Certificate Provisioning in NMOS Systems</a></p> <p><a href="https://specs.amwa.tv/bcp-004-01">BCP-004-01: Receiver Capabilities</a></p> <p><a href="https://specs.amwa.tv/bcp-005-01">BCP-005-01: EDID to Receiver Capabilities Mapping</a></p> <p><a href="https://specs.amwa.tv/bcp-006-01">BCP-006-01: NMOS With JPEG XS</a></p> <p><a href="https://specs.amwa.tv/bcp-006-02">BCP-006-02: NMOS With H.264</a></p> <p><a href="https://specs.amwa.tv/bcp-006-03">BCP-006-03: NMOS With H.265</a></p> <p><a href="https://specs.amwa.tv/bcp-007-01">BCP-007-01: NMOS With NDI</a></p> <p><a href="https://specs.amwa.tv/bcp-008-01">BCP-008-01: NMOS Receiver Status</a></p> </div> </span> <span class="dropdown">MS <div class="dropdown-content"> <p><b>Data Model Specifications</b></p> <p><a href="https://specs.amwa.tv/ms-04">MS-04: ID & Timing Model</a></p> <p><a href="https://specs.amwa.tv/ms-05-01">MS-05-01: NMOS Control Architecture</a></p> <p><a href="https://specs.amwa.tv/ms-05-02">MS-05-02: AMWA NMOS Control Framework</a></p> <p><a href="https://specs.amwa.tv/ms-05-03">MS-05-03: AMWA NMOS Control Block Specs</a></p> </div> </span> <span class="dropdown">INFO <div class="dropdown-content"> <p><b>Informative Documents</b></p> <p><a href="https://specs.amwa.tv/info-002">INFO-002: Security Implementation Guide</a></p> <p><a href="https://specs.amwa.tv/info-003">INFO-003: Sink Metadata Processing Architecture</a></p> <p><a href="https://specs.amwa.tv/info-004">INFO-004: Implementation Guide for DNS-SD</a></p> <p><a href="https://specs.amwa.tv/info-005">INFO-005: Implementation Guide for NMOS Controllers</a></p> <p><a href="https://specs.amwa.tv/info-006">INFO-006: Implementation guide for NMOS Device Capabilities Control</a></p> </div> </span> <span class="dropdown">REG <div class="dropdown-content"> <p><b>Parameter Registers</b></p> <p><a href="https://specs.amwa.tv/nmos-parameter-registers/branches/main/common">General Procedures and Criteria</a></p> <p><a href="https://specs.amwa.tv/nmos-parameter-registers/branches/main/capabilities">Capabilities</a></p> <p><a href="https://specs.amwa.tv/nmos-parameter-registers/branches/main/device-control-types">Device Control Types</a></p> <p><a href="https://specs.amwa.tv/nmos-parameter-registers/branches/main/device-types">Device Types</a></p> <p><a href="https://specs.amwa.tv/nmos-parameter-registers/branches/main/flow-attributes">Flow Attributes</a></p> <p><a href="https://specs.amwa.tv/nmos-parameter-registers/branches/main/formats">Formats</a></p> <p><a href="https://specs.amwa.tv/nmos-parameter-registers/branches/main/node-service-types">Node Service Types</a></p> <p><a href="https://specs.amwa.tv/nmos-parameter-registers/branches/main/sender-attributes">Sender Attributes</a></p> <p><a href="https://specs.amwa.tv/nmos-parameter-registers/branches/main/source-attributes">Source Attributes</a></p> <p><a href="https://specs.amwa.tv/nmos-parameter-registers/branches/main/tags">Tags</a></p> <p><a href="https://specs.amwa.tv/nmos-parameter-registers/branches/main/transports">Transports</a></p> <p><a href="https://specs.amwa.tv/nmos-parameter-registers/branches/main/transport-parameters">Transport Parameters</a></p> </div> </span> <span class="dropdown">F-SETS <div class="dropdown-content"> <p><b>Control Feature Sets</b></p> <p><a href="https://specs.amwa.tv/nmos-control-feature-sets/branches/main/identification">Identification</a></p> <p><a href="https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring">Monitoring</a></p> </div> </span> <span class="dropdown">DEVEL <div class="dropdown-content"> <p><b>Developer Links</b></p> <p><a href="https://github.com/AMWA-TV/is-13">GitHub Repo</a></p> <p><a href="https://specs.amwa.tv/nmos-testing">API Testing Tool</a></p> <p><a href="https://specs.amwa.tv/nmos-dashboard/dashboard.html">CI Dashboard</a></p> </div> </span> <span class="dropdown">SEARCH <div class="dropdown-content"> <script async src="https://cse.google.com/cse.js?cx=70787015d40930818"></script> <div class="gcse-searchbox-only"></div> </div> </span> <div class="breadcrumbs"> <a href="/is-13/">IS-13</a> ➤ </div> </div> <div class="content"> <br/>  <h1 id="amwa-is-13-nmos-annotation-specification-work-in-progress">AMWA IS-13 NMOS Annotation Specification [Work In Progress]</h1> <h2 id="about-is-13">About IS-13</h2> <h3 id="what-does-it-do">What does it do?</h3> <ul> <li>Allows control and monitoring applications to update resource labels, descriptions and tags</li> </ul> <h3 id="why-does-it-matter">Why does it matter?</h3> <ul> <li>Operators need to be able to distinguish between different resources</li> <li>Often this is aided by user-provided information (beyond what is provided by the vendor through BCP-002-02)</li> </ul> <h3 id="how-does-it-work">How does it work?</h3> <ul> <li>Media Nodes advertise it in their Node <code class="language-plaintext highlighter-rouge">services</code></li> </ul> <hr /> <p>IS-13 has been developed by the <a href="https://www.amwa.tv">Advanced Media Workflow Association</a> as part of the <a href="https://www.amwa.tv/nmos-overview">Networked Media Open Specifications</a> initiative. See <a href="https://specs.amwa.tv/nmos">here</a> for an overview of NMOS specifications.</p> <p>The <a href="https://specs.amwa.tv/nmos-testing">NMOS Testing Tool</a> creates a simple web service for testing implementations of all NMOS APIs.</p> <p>The links to documentation, API and examples below, and for SPEC links in the page menu bar are for this release or branch: <strong>branches/v1.0-dev</strong>. Links to <a href="releases/">other published releases</a> and <a href="branches/">other live branches</a> appear later in the page, or in the VERSIONS menu.</p> <h2 id="documentation-for-branch-v10-dev">Documentation for branch v1.0-dev</h2> <h3 id="introduction">Introduction</h3> <ul> <li><a href="branches/v1.0-dev/docs/Overview.html">Overview</a></li> </ul> <h3 id="apis">APIs</h3> <ul> <li><a href="branches/v1.0-dev/docs/APIs.html">General</a> <ul> <li><a href="branches/v1.0-dev/docs/APIs_-_Server_Side_Implementation.html">Server Side Implementation</a></li> <li><a href="branches/v1.0-dev/docs/APIs_-_Client_Side_Implementation.html">Client Side Implementation</a></li> </ul> </li> </ul> <h3 id="behaviour">Behaviour</h3> <ul> <li><a href="branches/v1.0-dev/docs/Behaviour.html">Behaviour</a></li> </ul> <h3 id="interoperability">Interoperability</h3> <ul> <li><a href="branches/v1.0-dev/docs/Interoperability_-_IS-04.html">IS-04</a></li> </ul> <h2 id="apis-for-branch-v10-dev">APIs for branch v1.0-dev</h2> <ul> <li><a href="/is-13/branches/v1.0-dev/APIs/AnnotationAPI.html">AnnotationAPI</a></li> </ul> <h3 id="json-schemas-for-branch-v10-dev"><a href="branches/v1.0-dev/APIs/schemas">JSON Schemas</a> for branch v1.0-dev</h3> <h3 id="examples-for-branch-v10-dev"><a href="branches/v1.0-dev/examples">Examples</a> for branch v1.0-dev</h3> <h2 id="published-releases">Published Releases</h2> <h2 id="live-branches">Live Branches</h2> <p><a href="branches/v1.0-dev/">v1.0-dev</a></p> <hr /> <p>These pages are rendered from the source of the specification, which is in <a href="https://github.com/AMWA-TV/is-13">this GitHub repository</a>.</p> <table> <thead> <tr> <th>Repository</th> <th>Default Branch</th> <th>Lint (default)</th> <th>Render (all)</th> </tr> </thead> <tbody> <tr> <td><a href="https://github.com/AMWA-TV/is-13">is-13</a></td> <td>v1.0-dev</td> <td><a href="https://github.com/AMWA-TV/is-13/actions?query=workflow%3ALint"><img src="https://github.com/AMWA-TV/is-13/workflows/Lint/badge.svg" alt="Lint Status" /></a></td> <td><a href="https://github.com/AMWA-TV/is-13/actions?query=workflow%3ARender"><img src="https://github.com/AMWA-TV/is-13/workflows/Render/badge.svg" alt="Render Status" /></a></td> </tr> </tbody> </table> </div> <div class="footer border-top border-gray-light mt-5 pt-3 text-center text-gray"> Documentation built at 04:52:01 CDT on 2024-08-29. <br/> (c) AMWA 2024. RAML/JSON licensed under <a href="https://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0</a>. Documentation licensed under <a href="http://creativecommons.org/licenses/by-nd/4.0/">CC BY-ND 4.0</a>. </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js" integrity="sha256-lZaRhKri35AyJSypXXs4o6OPFTbTmUoltBbDCbdzegg=" crossorigin="anonymous"></script> <script>anchors.add();</script> <script> window.onscroll = function() {myFunction()}; var header = document.getElementById("menu-header"); var sticky = header.offsetTop; function myFunction() { if (window.pageYOffset > sticky) { header.classList.add("sticky"); } else { header.classList.remove("sticky"); } } </script> </body> </html>

CINXE.COM

is-13 | AMWA IS-13 NMOS Annotation Specification [Work In Progress]