IS-04 interactions
←Data type marshalling · Index↑ · Backup & restore→
When this API is used alongside IS-04 in a deployment, the IS-04 APIs MUST operate at version 1.1 or greater in order to ensure full interoperability.
Discovery
Devices MUST advertise the Configuration API as a control endpoint when publishing a compliant NMOS Device.
Control endpoints MUST use the URN urn:x-nmos:control:configuration to identify all Devices which implement the Configuration API, and the URLs required to access them.
For more details see NMOS Device Control Types.
Example 1: The controls attribute of the NMOS Device of a simple Node with a single Configuration API endpoint.
{
...
"senders": [
"a65c15a4-a52e-4960-8cd2-e05c31196e5f",
"68f519a3-5523-4b2c-b72d-ec23cc80207d"
],
"receivers": [
"8a7bb1c1-4a82-4fd9-a4fb-96f68f560831",
"ab450c07-ce54-44da-9ea9-c3e62e7b06d0"
],
"controls": [
{
"type": "urn:x-nmos:control:configuration/v1.0",
"href": "http://192.168.10.3/x-nmos/configuration/v1.0/"
}
],
"tags": {},
"type": "urn:x-nmos:device:generic",
"label": "NMOS Device",
"version": "1529676926:000000000",
"node_id": "d1713110-7343-4d9e-b3f4-456c8f6ce765",
"id": "58f6b536-ca4c-43fd-880a-9df2501fc125",
"description": "NMOS Device"
...
}
Example 2: The controls attribute of an NMOS Device of a Node which advertises a different Configuration API endpoint for each device.
...
"controls": [
{
"type": "urn:x-nmos:control:configuration/v1.0",
"href": "http://192.168.10.3/x-nmos/configuration/v1.0/slot2B/"
}
]
...
In example 2, the path segment ‘slot2B’ is an <api selector> identifier as defined in API Paths.
Note that the API version is included in both the ‘type’, and in the ‘href’. As new versions of the Configuration API are published, Devices MAY advertise further control endpoints which support multiple versions simultaneously.