hi human interface®
English

AMWA NMOS Registry

AMWA NMOS Registry

Driver Maturity

Production

Recommended for normal production use.

Caution

Compatibility Note: This information is a general guide and may be incomplete, may not match a specific project implementation, and is subject to change as supported products and versions evolve. Confirm the exact implementation and requirements for each project with Riedel and the relevant equipment vendor, then validate the required functions end to end in the target environment before deployment.

Minimum hi Version: v2.5.1

Overview

The hi NMOS Registry provides IS-04 Registration, Query, Node, and subscription services for NMOS-compatible systems. It also exposes the IS-09 System API information used by participating Nodes.

Network Requirements

  • Connection Model: NMOS Nodes and clients initiate connections to the hi registry service.

  • Multicast / Unicast: Registry control traffic is unicast. Media transport is outside the registry service.

  • VLAN / IGMP: Follow the site's media-network design.

  • Bandwidth: Control-plane traffic only.

  • IP Version: IPv4 network-interface selection is exposed in hi.

  • Firewall: Permit NMOS Nodes and clients to reach TCP port 30010 and the registry WebSocket endpoint.

Standards Conformance

Standard

Conformance

Notes

AMWA NMOS IS-04

Implemented

Registration
Query
Node
health
and Query subscription services for v1.2 and v1.3

AMWA NMOS IS-09

Implemented

System API v1.0 global configuration resource

Operator Workflow

  • UI Surface in hi: Inventory and the generic Node configuration view

  • Configuration Workflow: Select the control-network interface and configure the registry settings.

  • Routing Semantics: The registry stores and serves NMOS resources. Signal routing is performed by the NMOS Core Integration.

Connection Methods

Connection: IS-04 Registration API

Property

Value

Protocol

AMWA NMOS IS-04 v1.2 and v1.3 Registration API

Transport

HTTP

Default Port

30010

Authentication

None

Encryption in Transit

None
the endpoint does not provide TLS

Connection Model

Inbound Node registration and health requests

Required License

hiNMOS

Traffic Flow

Requests from NMOS Nodes with responses from hi

Connection: IS-04 Query API

Property

Value

Protocol

AMWA NMOS IS-04 v1.2 and v1.3 Query API

Transport

HTTP

Default Port

30010

Authentication

None

Encryption in Transit

None
the endpoint does not provide TLS

Connection Model

Inbound resource queries

Required License

hiNMOS

Traffic Flow

Requests from Query clients with responses from hi

Connection: IS-04 Query Subscriptions

Property

Value

Protocol

AMWA NMOS IS-04 v1.2 and v1.3 Query subscriptions

Transport

WebSocket

Default Port

30010

Authentication

None

Encryption in Transit

None
the endpoint does not provide secure WebSocket

Connection Model

Inbound subscription establishment

Required License

hiNMOS

Traffic Flow

Resource-change updates from hi to subscribed clients

Connection: IS-04 Node API

Property

Value

Protocol

AMWA NMOS IS-04 v1.2 and v1.3 Node API

Transport

HTTP

Default Port

30010

Authentication

None

Encryption in Transit

None
the endpoint does not provide TLS

Connection Model

Inbound requests for the registry's Node resources

Required License

hiNMOS

Traffic Flow

Requests from clients with responses from hi

Connection: IS-09 System API

Property

Value

Protocol

AMWA NMOS IS-09 v1.0 System API

Transport

HTTP

Default Port

30010

Authentication

None

Encryption in Transit

None
the endpoint does not provide TLS

Connection Model

Inbound global-configuration queries

Required License

hiNMOS

Traffic Flow

Requests from clients with responses from hi

Required Configuration

Information

NMOS Nodes and clients connect to the hi server on TCP port 30010. The HTTP APIs and Query WebSocket subscriptions share this exposed endpoint.

Parameter

Description

Default

Interface

IPv4 network interface connected to the NMOS control network

Auto

Heartbeat interval

Expected IS-04 Node heartbeat interval in seconds

5

Device-Side Setup

Follow AMWA NMOS Registry Integration Configuration for the device-side and hi-side configuration steps.

Supported Features

Feature

Access

Exposed Operation and Scope

IS-04 Registration API

Write-only actions

Register, update, and remove resources and maintain Node health.

IS-04 Query API

Read-only

Query Nodes, devices, Sources, flows, senders, receivers, and subscriptions.

Query Subscriptions

Read/write subscription
read-only updates

Create/remove subscriptions and receive WebSocket updates.

Node API

Read-only endpoint

Expose the registry's own Node and related resources.

IS-09 System API

Read-only endpoint

Expose global configuration information.

Device Coverage

Tested With identifies devices that have been tested with hi. Potentially Compatible (Not Yet Verified) identifies devices that use the same protocol or connection method but have not been tested with hi. Device-specific configuration, firmware, and feature support can affect results.

Tested With

  • Panasonic KAIROS

  • Riedel 1200 Series SmartPanel

  • Riedel Artist-1024 (AES67 SIC)

  • Riedel MediorNet IP

  • Riedel MediorNet TDM

Potentially Compatible (Not Yet Verified)

  • Other NMOS Nodes that register through the AMWA NMOS IS-04 Registration API versions listed under Standards Conformance.

Known Limitations

  • Validate each connected Node and Query API client against IS-04 v1.2 or v1.3 during commissioning.

  • The registry serves IS-04 v1.2 and v1.3 and IS-09 v1.0 only. Nodes and clients that require TLS, IS-10 authorization, or other NMOS specifications cannot use this endpoint.

  • The registry removes the resources of a Node when no heartbeat arrives within twice the Heartbeat interval plus 2 seconds. With the default of 5, this is 12 seconds.

What's Not Supported

  • Firmware updates or vendor device management.

  • Media encoding, essence creation, stream-format authoring, or configuration and generation of media streams.

Trademarks

Note

NMOS is an open specification developed by the Advanced Media Workflow Association (AMWA).

All product names, logos, and brands are property of their respective owners. Copyright in third-party software and materials remains with the respective owners. Use of these names does not imply endorsement.

RIEDEL Communications is not affiliated with, endorsed by, or officially partnered with AMWA unless explicitly stated.