Networked Media Open Specifications

DOCS

Docs for v1.0.1

Overview

Message types

Event types

Core models

Transports

Transport - MQTT

Transport - Websocket

Event and tally rest api

Measurement units guidelines

APIS

RAML APIs for v1.0.1

Events API

JSON Schemas for v1.0.1

base

command

command_health

command_subscription

error

event

event_boolean

event_core

event_number

event_object

event_string

message

message_connection_status

message_health

message_shutdown_reboot

number

receiver_transport_params_ext

sender_transport_params_ext

source

sources

type

type_boolean

type_boolean_enum

type_number

type_number_enum

type_string

type_string_enum

EXAMPLES

JSON Examples for v1.0.1

connection-status-message

connectionapi-v1.1-receiver-active-get-mqtt-200

connectionapi-v1.1-receiver-active-get-websocket-200

connectionapi-v1.1-sender-active-get-mqtt-200

connectionapi-v1.1-sender-active-get-websocket-200

eventsapi-base-get-200

eventsapi-sourceid-get-200

eventsapi-sources-get-200

eventsapi-state-boolean-get-200

eventsapi-state-number-get-200

eventsapi-state-number-measurement-get-200

eventsapi-state-number-rational-get-200

eventsapi-state-string-get-200

eventsapi-type-boolean-enum-get-200

eventsapi-type-boolean-get-200

eventsapi-type-number-enum-get-200

eventsapi-type-number-get-200

eventsapi-type-number-measurement-get-200

eventsapi-type-string-enum-get-200

eventsapi-type-string-get-200

health-command

health-message

reboot-message

shutdown-message

subscription-command

subscription-unsubscribe-command

VERSIONS

Branches

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-07 ➤ releases ➤ v1.0.1 ➤ APIs ➤ schemas ➤

Schema event_string.json

Show original (referenced schemas with $ref)

Get raw JSON

{ "$id": "https://www.amwa.tv/event_and_tally/event_string.json", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "description": "Describes an event with string payload", "title": "String event", "allOf": [ { "$ref": "event_core.json" }, { "type": "object", "required": [ "event_type", "payload" ], "properties": { "event_type": { "description": "Event type", "type": "string", "pattern": "^string(\\/[^\\s\\/]+)*$" }, "payload": { "description": "String payload", "type": "object", "required": [ "value" ], "properties": { "value": { "description": "String value", "type": "string" } } } } } ] }

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