Skip to content

Commit

Permalink
Clarify Sender/Receiver subscription indicates current configuration,…
Browse files Browse the repository at this point in the history
… not connection status, as per IS-05 change by AMWA-TV/is-05#97
  • Loading branch information
garethsb authored and andrewbonney committed Sep 6, 2019
1 parent d362f03 commit bb830e4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/4.3. Behaviour - Nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ Where the behaviour associated with an API attribute is not sufficiently clear f

### Senders

`subscription`: The 'subscription' key is used to indicate how a Sender currently connects to Receivers in a networked media system. The subscription MUST be updated to reflect the current state of the Sender whether it was modified via an NMOS mechanism or an externally-defined control mechanism.
`subscription`: The 'subscription' key is used to indicate how a Sender currently connects to Receivers in a networked media system. The subscription MUST be updated to reflect the current configuration of the Sender whether it was modified via an NMOS mechanism or an externally-defined control mechanism.

`subscription` `active`: The 'active' key MUST be set to 'true' when the Sender is configured to enable transmission of packets to the network, whether via a push- or pull-based mechanism. The key MUST be set to 'false' when the Sender is configured to disable transmission of packets to the network.

`subscription` `receiver_id`: The 'receiver_id' key MUST be set to `null` in all cases except where a unicast push-based Sender is configured to transmit to an NMOS Receiver, and the 'active' key is set to 'true'. When not set to `null`, the 'receiver_id' MUST be set to the UUID of an NMOS Receiver.

### Receivers

`subscription`: The 'subscription' key is used to indicate how a Receiver currently connects to Senders in a networked media system. The subscription MUST be updated to reflect the current state of the Receiver whether it was modified via an NMOS mechanism or an externally-defined control mechanism.
`subscription`: The 'subscription' key is used to indicate how a Receiver currently connects to Senders in a networked media system. The subscription MUST be updated to reflect the current configuration of the Receiver whether it was modified via an NMOS mechanism or an externally-defined control mechanism.

`subscription` `active`: The 'active' key MUST be set to 'true' when the Receiver is configured to enable reception of packets from the network. The key MUST be set to 'false' when the Receiver is configured to disable reception of packets from the network.

Expand Down

0 comments on commit bb830e4

Please sign in to comment.