Skip to content

OcaNetworkSignalChannel#

This document describes the controller implementation of OcaNetworkSignalChannel. This class is documented in the AES70 standard as:

DEPRECATED CLASS Replaced by features of the OcaMediaSinkConnector and OcaMediaSourceConnector datatypes in version 3 of Connection Management (CM3)

Worker that allows connection of one or more internal signal paths to a network signal channel.

For stream-oriented media connection management such as used by AVB, this worker will be linked to an OcaStreamConnector object and to the appropriate OcaStreamNetwork object., For channel-oriented media connection management, such as the Dante name-based routing mechanism, this worker will be linked only to the OcaStreamNetwork object.

Overview#

Class Declaration#

namespace aes70::controller
{
  class OcaNetworkSignalChannel : public OcaWorker
  {
  public:
    OcaNetworkSignalChannel(std::shared_ptr<connection> connection,
            uin32_t object_number);
    OcaNetworkSignalChannel(const OcaNetworkSignalChannel &o);

    // Control Methods
    // Calls GetIDAdvertised and calls on_result or on_failure
    void GetIDAdvertised(auto on_result, failure_callback on_failure);
    // Calls SetIDAdvertised and calls on_result or on_failure
    void SetIDAdvertised(OcaNetworkSignalChannelID IDAdvertised, auto on_result, failure_callback on_failure);
    // Calls SetIDAdvertised and does not wait for the response
    void SetIDAdvertised(OcaNetworkSignalChannelID IDAdvertised);
    // Calls GetNetwork and calls on_result or on_failure
    void GetNetwork(auto on_result, failure_callback on_failure);
    // Calls SetNetwork and calls on_result or on_failure
    void SetNetwork(OcaONo Network, auto on_result, failure_callback on_failure);
    // Calls SetNetwork and does not wait for the response
    void SetNetwork(OcaONo Network);
    // Calls GetConnectorPins and calls on_result or on_failure
    void GetConnectorPins(auto on_result, failure_callback on_failure);
    // Calls AddToConnector and calls on_result or on_failure
    void AddToConnector(OcaONo Connector, OcaStreamConnectorPinIndex Index, auto on_result, failure_callback on_failure);
    // Calls AddToConnector and does not wait for the response
    void AddToConnector(OcaONo Connector, OcaStreamConnectorPinIndex Index);
    // Calls RemoveFromConnector and calls on_result or on_failure
    void RemoveFromConnector(OcaONo Connector, auto on_result, failure_callback on_failure);
    // Calls RemoveFromConnector and does not wait for the response
    void RemoveFromConnector(OcaONo Connector);
    // Calls GetRemoteChannelID and calls on_result or on_failure
    void GetRemoteChannelID(auto on_result, failure_callback on_failure);
    // Calls SetRemoteChannelID and calls on_result or on_failure
    void SetRemoteChannelID(OcaNetworkSignalChannelID RemoteChannelID, auto on_result, failure_callback on_failure);
    // Calls SetRemoteChannelID and does not wait for the response
    void SetRemoteChannelID(OcaNetworkSignalChannelID RemoteChannelID);
    // Calls GetSourceOrSink and calls on_result or on_failure
    void GetSourceOrSink(auto on_result, failure_callback on_failure);
    // Calls GetStatus and calls on_result or on_failure
    void GetStatus(auto on_result, failure_callback on_failure);

    // Observing Properties
    subscription observeIDAdvertised(auto callback, failure_callback on_failure);
    subscription observeNetwork(auto callback, failure_callback on_failure);
    subscription observeConnectorPins(auto callback, failure_callback on_failure);
    subscription observeRemoteChannelID(auto callback, failure_callback on_failure);
    subscription observeSourceOrSink(auto callback, failure_callback on_failure);
    subscription observeStatus(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnIDAdvertisedChanged(auto callback, failure_callback on_failure);
    subscription OnNetworkChanged(auto callback, failure_callback on_failure);
    subscription OnConnectorPinsChanged(auto callback, failure_callback on_failure);
    subscription OnRemoteChannelIDChanged(auto callback, failure_callback on_failure);
    subscription OnSourceOrSinkChanged(auto callback, failure_callback on_failure);
    subscription OnStatusChanged(auto callback, failure_callback on_failure);
  };
}

Methods#

GetIDAdvertised#

void GetIDAdvertised(auto on_result, failure_callback on_failure)

Calls the method GetIDAdvertised in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaNetworkSignalChannelID IDAdvertised
  • failure_callback on_failure: A callback which is called on error.

SetIDAdvertised#

void SetIDAdvertised(OcaNetworkSignalChannelID IDAdvertised, auto on_result, failure_callback on_failure)

Calls the method SetIDAdvertised in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaNetworkSignalChannelID IDAdvertised
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetNetwork#

void GetNetwork(auto on_result, failure_callback on_failure)

Calls the method GetNetwork in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaONo Network
  • failure_callback on_failure: A callback which is called on error.

SetNetwork#

void SetNetwork(OcaONo Network, auto on_result, failure_callback on_failure)

Calls the method SetNetwork in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaONo Network
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetConnectorPins#

void GetConnectorPins(auto on_result, failure_callback on_failure)

Calls the method GetConnectorPins in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaMap<OcaONo, OcaStreamConnectorPinIndex> ConnectorPins
  • failure_callback on_failure: A callback which is called on error.

AddToConnector#

void AddToConnector(OcaONo Connector, OcaStreamConnectorPinIndex Index, auto on_result, failure_callback on_failure)

Calls the method AddToConnector in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaONo Connector
  • OcaStreamConnectorPinIndex Index
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

RemoveFromConnector#

void RemoveFromConnector(OcaONo Connector, auto on_result, failure_callback on_failure)

Calls the method RemoveFromConnector in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaONo Connector
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetRemoteChannelID#

void GetRemoteChannelID(auto on_result, failure_callback on_failure)

Calls the method GetRemoteChannelID in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaNetworkSignalChannelID RemoteChannelID
  • failure_callback on_failure: A callback which is called on error.

SetRemoteChannelID#

void SetRemoteChannelID(OcaNetworkSignalChannelID RemoteChannelID, auto on_result, failure_callback on_failure)

Calls the method SetRemoteChannelID in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaNetworkSignalChannelID RemoteChannelID
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetSourceOrSink#

void GetSourceOrSink(auto on_result, failure_callback on_failure)

Calls the method GetSourceOrSink in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaNetworkMediaSourceOrSink SourceOrSink
  • failure_callback on_failure: A callback which is called on error.

GetStatus#

void GetStatus(auto on_result, failure_callback on_failure)

Calls the method GetStatus in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaNetworkSignalChannelStatus Status
  • failure_callback on_failure: A callback which is called on error.

observeIDAdvertised#

subscription observeIDAdvertised(auto callback, failure_callback on_failure)

Fetches the remote property IDAdvertised and subscribes for modifications. The callback is called with the initial values of IDAdvertised and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkSignalChannelID IDAdvertised
  • failure_callback on_failure: A callback which is called on error.

observeNetwork#

subscription observeNetwork(auto callback, failure_callback on_failure)

Fetches the remote property Network and subscribes for modifications. The callback is called with the initial values of Network and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaONo Network
  • failure_callback on_failure: A callback which is called on error.

observeConnectorPins#

subscription observeConnectorPins(auto callback, failure_callback on_failure)

Fetches the remote property ConnectorPins and subscribes for modifications. The callback is called with the initial values of ConnectorPins and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaMap<OcaONo, OcaStreamConnectorPinIndex> ConnectorPins
  • failure_callback on_failure: A callback which is called on error.

observeRemoteChannelID#

subscription observeRemoteChannelID(auto callback, failure_callback on_failure)

Fetches the remote property RemoteChannelID and subscribes for modifications. The callback is called with the initial values of RemoteChannelID and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkSignalChannelID RemoteChannelID
  • failure_callback on_failure: A callback which is called on error.

observeSourceOrSink#

subscription observeSourceOrSink(auto callback, failure_callback on_failure)

Fetches the remote property SourceOrSink and subscribes for modifications. The callback is called with the initial values of SourceOrSink and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkMediaSourceOrSink SourceOrSink
  • failure_callback on_failure: A callback which is called on error.

observeStatus#

subscription observeStatus(auto callback, failure_callback on_failure)

Fetches the remote property Status and subscribes for modifications. The callback is called with the initial values of Status and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkSignalChannelStatus Status
  • failure_callback on_failure: A callback which is called on error.

OnIDAdvertisedChanged#

subscription OnIDAdvertisedChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkSignalChannelID IDAdvertised
  • failure_callback on_failure: A callback which is called on error.

OnNetworkChanged#

subscription OnNetworkChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaONo Network
  • failure_callback on_failure: A callback which is called on error.

OnConnectorPinsChanged#

subscription OnConnectorPinsChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaMap<OcaONo, OcaStreamConnectorPinIndex> ConnectorPins
  • failure_callback on_failure: A callback which is called on error.

OnRemoteChannelIDChanged#

subscription OnRemoteChannelIDChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkSignalChannelID RemoteChannelID
  • failure_callback on_failure: A callback which is called on error.

OnSourceOrSinkChanged#

subscription OnSourceOrSinkChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkMediaSourceOrSink SourceOrSink
  • failure_callback on_failure: A callback which is called on error.

OnStatusChanged#

subscription OnStatusChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkSignalChannelStatus Status
  • failure_callback on_failure: A callback which is called on error.