OcaMediaTransportNetwork#
This document describes the controller implementation of OcaMediaTransportNetwork. This class is documented in the AES70 standard as:
Overview#
- ClassID: 1.4.2
- Header:
aes70/controller/OcaMediaTransportNetwork.hpp
- Namespace:
aes70::controller
- Inheritance: aes70::controller::OcaApplicationNetwork, aes70::controller::OcaRoot, aes70::controller::object
Class Declaration#
namespace aes70::controller
{
class OcaMediaTransportNetwork : public OcaApplicationNetwork
{
public:
OcaMediaTransportNetwork(std::shared_ptr<connection> connection,
uin32_t object_number);
OcaMediaTransportNetwork(const OcaMediaTransportNetwork &o);
// Control Methods
// Calls GetMediaProtocol and calls on_result or on_failure
void GetMediaProtocol(auto on_result, failure_callback on_failure);
// Calls GetPorts and calls on_result or on_failure
void GetPorts(auto on_result, failure_callback on_failure);
// Calls GetPortName and calls on_result or on_failure
void GetPortName(OcaPortID PortID, auto on_result, failure_callback on_failure);
// Calls GetPortName and does not wait for the response
void GetPortName(OcaPortID PortID);
// Calls SetPortName and calls on_result or on_failure
void SetPortName(OcaPortID PortID, OcaString Name, auto on_result, failure_callback on_failure);
// Calls SetPortName and does not wait for the response
void SetPortName(OcaPortID PortID, OcaString Name);
// Calls GetMaxSourceConnectors and calls on_result or on_failure
void GetMaxSourceConnectors(auto on_result, failure_callback on_failure);
// Calls GetMaxSinkConnectors and calls on_result or on_failure
void GetMaxSinkConnectors(auto on_result, failure_callback on_failure);
// Calls GetMaxPinsPerConnector and calls on_result or on_failure
void GetMaxPinsPerConnector(auto on_result, failure_callback on_failure);
// Calls GetMaxPortsPerPin and calls on_result or on_failure
void GetMaxPortsPerPin(auto on_result, failure_callback on_failure);
// Calls GetSourceConnectors and calls on_result or on_failure
void GetSourceConnectors(auto on_result, failure_callback on_failure);
// Calls GetSourceConnector and calls on_result or on_failure
void GetSourceConnector(OcaMediaConnectorID ID, auto on_result, failure_callback on_failure);
// Calls GetSourceConnector and does not wait for the response
void GetSourceConnector(OcaMediaConnectorID ID);
// Calls GetSinkConnectors and calls on_result or on_failure
void GetSinkConnectors(auto on_result, failure_callback on_failure);
// Calls GetSinkConnector and calls on_result or on_failure
void GetSinkConnector(OcaMediaConnectorID ID, auto on_result, failure_callback on_failure);
// Calls GetSinkConnector and does not wait for the response
void GetSinkConnector(OcaMediaConnectorID ID);
// Calls GetConnectorsStatuses and calls on_result or on_failure
void GetConnectorsStatuses(auto on_result, failure_callback on_failure);
// Calls GetConnectorStatus and calls on_result or on_failure
void GetConnectorStatus(OcaMediaConnectorID ConnectorID, auto on_result, failure_callback on_failure);
// Calls GetConnectorStatus and does not wait for the response
void GetConnectorStatus(OcaMediaConnectorID ConnectorID);
// Calls AddSourceConnector and calls on_result or on_failure
void AddSourceConnector(OcaMediaSourceConnector Connector, OcaMediaConnectorState InitialStatus, auto on_result, failure_callback on_failure);
// Calls AddSourceConnector and does not wait for the response
void AddSourceConnector(OcaMediaSourceConnector Connector, OcaMediaConnectorState InitialStatus);
// Calls AddSinkConnector and calls on_result or on_failure
void AddSinkConnector(OcaMediaConnectorStatus InitialStatus, auto on_result, failure_callback on_failure);
// Calls AddSinkConnector and does not wait for the response
void AddSinkConnector(OcaMediaConnectorStatus InitialStatus);
// Calls ControlConnector and calls on_result or on_failure
void ControlConnector(OcaMediaConnectorID ConnectorID, OcaMediaConnectorCommand Command, auto on_result, failure_callback on_failure);
// Calls ControlConnector and does not wait for the response
void ControlConnector(OcaMediaConnectorID ConnectorID, OcaMediaConnectorCommand Command);
// Calls SetSourceConnectorPinMap and calls on_result or on_failure
void SetSourceConnectorPinMap(OcaMediaConnectorID ConnectorID, OcaMap<OcaUint16, OcaPortID> ChannelPinMap, auto on_result, failure_callback on_failure);
// Calls SetSourceConnectorPinMap and does not wait for the response
void SetSourceConnectorPinMap(OcaMediaConnectorID ConnectorID, OcaMap<OcaUint16, OcaPortID> ChannelPinMap);
// Calls SetSinkConnectorPinMap and calls on_result or on_failure
void SetSinkConnectorPinMap(OcaMediaConnectorID ConnectorID, OcaMultiMap<OcaUint16, OcaPortID> ChannelPinMap, auto on_result, failure_callback on_failure);
// Calls SetSinkConnectorPinMap and does not wait for the response
void SetSinkConnectorPinMap(OcaMediaConnectorID ConnectorID, OcaMultiMap<OcaUint16, OcaPortID> ChannelPinMap);
// Calls SetConnectorConnection and calls on_result or on_failure
void SetConnectorConnection(OcaMediaConnectorID ConnectorID, OcaMediaConnection Connection, auto on_result, failure_callback on_failure);
// Calls SetConnectorConnection and does not wait for the response
void SetConnectorConnection(OcaMediaConnectorID ConnectorID, OcaMediaConnection Connection);
// Calls SetConnectorCoding and calls on_result or on_failure
void SetConnectorCoding(OcaMediaConnectorID ConnectorID, OcaMediaCoding Coding, auto on_result, failure_callback on_failure);
// Calls SetConnectorCoding and does not wait for the response
void SetConnectorCoding(OcaMediaConnectorID ConnectorID, OcaMediaCoding Coding);
// Calls SetConnectorAlignmentLevel and calls on_result or on_failure
void SetConnectorAlignmentLevel(OcaMediaConnectorID ConnectorID, OcaDBFS Level, auto on_result, failure_callback on_failure);
// Calls SetConnectorAlignmentLevel and does not wait for the response
void SetConnectorAlignmentLevel(OcaMediaConnectorID ConnectorID, OcaDBFS Level);
// Calls SetConnectorAlignmentGain and calls on_result or on_failure
void SetConnectorAlignmentGain(OcaMediaConnectorID ConnectorID, OcaDB Gain, auto on_result, failure_callback on_failure);
// Calls SetConnectorAlignmentGain and does not wait for the response
void SetConnectorAlignmentGain(OcaMediaConnectorID ConnectorID, OcaDB Gain);
// Calls DeleteConnector and calls on_result or on_failure
void DeleteConnector(OcaMediaConnectorID ID, auto on_result, failure_callback on_failure);
// Calls DeleteConnector and does not wait for the response
void DeleteConnector(OcaMediaConnectorID ID);
// Calls GetAlignmentLevel and calls on_result or on_failure
void GetAlignmentLevel(auto on_result, failure_callback on_failure);
// Calls GetAlignmentGain and calls on_result or on_failure
void GetAlignmentGain(auto on_result, failure_callback on_failure);
// Observing Properties
subscription observeProtocol(auto callback, failure_callback on_failure);
subscription observePorts(auto callback, failure_callback on_failure);
subscription observeMaxSourceConnectors(auto callback, failure_callback on_failure);
subscription observeMaxSinkConnectors(auto callback, failure_callback on_failure);
subscription observeMaxPinsPerConnector(auto callback, failure_callback on_failure);
subscription observeMaxPortsPerPin(auto callback, failure_callback on_failure);
subscription observeAlignmentLevel(auto callback, failure_callback on_failure);
subscription observeAlignmentGain(auto callback, failure_callback on_failure);
// Property Changed Subscriptions
subscription OnProtocolChanged(auto callback, failure_callback on_failure);
subscription OnPortsChanged(auto callback, failure_callback on_failure);
subscription OnMaxSourceConnectorsChanged(auto callback, failure_callback on_failure);
subscription OnMaxSinkConnectorsChanged(auto callback, failure_callback on_failure);
subscription OnMaxPinsPerConnectorChanged(auto callback, failure_callback on_failure);
subscription OnMaxPortsPerPinChanged(auto callback, failure_callback on_failure);
subscription OnAlignmentLevelChanged(auto callback, failure_callback on_failure);
subscription OnAlignmentGainChanged(auto callback, failure_callback on_failure);
};
}
Methods#
GetMediaProtocol#
void GetMediaProtocol(auto on_result, failure_callback on_failure)
Calls the method GetMediaProtocol in the remote device.
Parameters:#
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaNetworkMediaProtocol Protocol
failure_callback on_failure
: A callback which is called on error.
GetPorts#
void GetPorts(auto on_result, failure_callback on_failure)
Calls the method GetPorts in the remote device.
Parameters:#
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaList<OcaPort> OcaPorts
failure_callback on_failure
: A callback which is called on error.
GetPortName#
void GetPortName(OcaPortID PortID, auto on_result, failure_callback on_failure)
Calls the method GetPortName in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaPortID PortID
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaString Name
failure_callback on_failure
: A callback which is called on error.
SetPortName#
void SetPortName(OcaPortID PortID, OcaString Name, auto on_result, failure_callback on_failure)
Calls the method SetPortName in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaPortID PortID
OcaString Name
auto on_result
: A callable (e.g. a lambda) with 0 arguments.failure_callback on_failure
: A callback which is called on error.
GetMaxSourceConnectors#
void GetMaxSourceConnectors(auto on_result, failure_callback on_failure)
Calls the method GetMaxSourceConnectors in the remote device.
Parameters:#
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaUint16 MaxSourceConnectors
failure_callback on_failure
: A callback which is called on error.
GetMaxSinkConnectors#
void GetMaxSinkConnectors(auto on_result, failure_callback on_failure)
Calls the method GetMaxSinkConnectors in the remote device.
Parameters:#
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaUint16 MaxSinkConnectors
failure_callback on_failure
: A callback which is called on error.
GetMaxPinsPerConnector#
void GetMaxPinsPerConnector(auto on_result, failure_callback on_failure)
Calls the method GetMaxPinsPerConnector in the remote device.
Parameters:#
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaUint16 MaxPins
failure_callback on_failure
: A callback which is called on error.
GetMaxPortsPerPin#
void GetMaxPortsPerPin(auto on_result, failure_callback on_failure)
Calls the method GetMaxPortsPerPin in the remote device.
Parameters:#
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaUint16 MaxPins
failure_callback on_failure
: A callback which is called on error.
GetSourceConnectors#
void GetSourceConnectors(auto on_result, failure_callback on_failure)
Calls the method GetSourceConnectors in the remote device.
Parameters:#
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaList<OcaMediaSourceConnector> Connectors
failure_callback on_failure
: A callback which is called on error.
GetSourceConnector#
void GetSourceConnector(OcaMediaConnectorID ID, auto on_result, failure_callback on_failure)
Calls the method GetSourceConnector in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaConnectorID ID
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaMediaSourceConnector Connector
failure_callback on_failure
: A callback which is called on error.
GetSinkConnectors#
void GetSinkConnectors(auto on_result, failure_callback on_failure)
Calls the method GetSinkConnectors in the remote device.
Parameters:#
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaList<OcaMediaSinkConnector> Connectors
failure_callback on_failure
: A callback which is called on error.
GetSinkConnector#
void GetSinkConnector(OcaMediaConnectorID ID, auto on_result, failure_callback on_failure)
Calls the method GetSinkConnector in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaConnectorID ID
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaMediaSinkConnector Connector
failure_callback on_failure
: A callback which is called on error.
GetConnectorsStatuses#
void GetConnectorsStatuses(auto on_result, failure_callback on_failure)
Calls the method GetConnectorsStatuses in the remote device.
Parameters:#
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaList<OcaMediaConnectorStatus> Statuses
failure_callback on_failure
: A callback which is called on error.
GetConnectorStatus#
void GetConnectorStatus(OcaMediaConnectorID ConnectorID, auto on_result, failure_callback on_failure)
Calls the method GetConnectorStatus in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaConnectorID ConnectorID
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaMediaConnectorStatus Status
failure_callback on_failure
: A callback which is called on error.
AddSourceConnector#
void AddSourceConnector(OcaMediaSourceConnector Connector, OcaMediaConnectorState InitialStatus, auto on_result, failure_callback on_failure)
Calls the method AddSourceConnector in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaSourceConnector Connector
OcaMediaConnectorState InitialStatus
auto on_result
: A callable (e.g. a lambda) with 0 arguments.failure_callback on_failure
: A callback which is called on error.
AddSinkConnector#
void AddSinkConnector(OcaMediaConnectorStatus InitialStatus, auto on_result, failure_callback on_failure)
Calls the method AddSinkConnector in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaConnectorStatus InitialStatus
auto on_result
: A callable (e.g. a lambda) with 0 arguments.failure_callback on_failure
: A callback which is called on error.
ControlConnector#
void ControlConnector(OcaMediaConnectorID ConnectorID, OcaMediaConnectorCommand Command, auto on_result, failure_callback on_failure)
Calls the method ControlConnector in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaConnectorID ConnectorID
OcaMediaConnectorCommand Command
auto on_result
: A callable (e.g. a lambda) with 0 arguments.failure_callback on_failure
: A callback which is called on error.
SetSourceConnectorPinMap#
void SetSourceConnectorPinMap(OcaMediaConnectorID ConnectorID, OcaMap<OcaUint16, OcaPortID> ChannelPinMap, auto on_result, failure_callback on_failure)
Calls the method SetSourceConnectorPinMap in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaConnectorID ConnectorID
OcaMap<OcaUint16, OcaPortID> ChannelPinMap
auto on_result
: A callable (e.g. a lambda) with 0 arguments.failure_callback on_failure
: A callback which is called on error.
SetSinkConnectorPinMap#
void SetSinkConnectorPinMap(OcaMediaConnectorID ConnectorID, OcaMultiMap<OcaUint16, OcaPortID> ChannelPinMap, auto on_result, failure_callback on_failure)
Calls the method SetSinkConnectorPinMap in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaConnectorID ConnectorID
OcaMultiMap<OcaUint16, OcaPortID> ChannelPinMap
auto on_result
: A callable (e.g. a lambda) with 0 arguments.failure_callback on_failure
: A callback which is called on error.
SetConnectorConnection#
void SetConnectorConnection(OcaMediaConnectorID ConnectorID, OcaMediaConnection Connection, auto on_result, failure_callback on_failure)
Calls the method SetConnectorConnection in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaConnectorID ConnectorID
OcaMediaConnection Connection
auto on_result
: A callable (e.g. a lambda) with 0 arguments.failure_callback on_failure
: A callback which is called on error.
SetConnectorCoding#
void SetConnectorCoding(OcaMediaConnectorID ConnectorID, OcaMediaCoding Coding, auto on_result, failure_callback on_failure)
Calls the method SetConnectorCoding in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaConnectorID ConnectorID
OcaMediaCoding Coding
auto on_result
: A callable (e.g. a lambda) with 0 arguments.failure_callback on_failure
: A callback which is called on error.
SetConnectorAlignmentLevel#
void SetConnectorAlignmentLevel(OcaMediaConnectorID ConnectorID, OcaDBFS Level, auto on_result, failure_callback on_failure)
Calls the method SetConnectorAlignmentLevel in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaConnectorID ConnectorID
OcaDBFS Level
auto on_result
: A callable (e.g. a lambda) with 0 arguments.failure_callback on_failure
: A callback which is called on error.
SetConnectorAlignmentGain#
void SetConnectorAlignmentGain(OcaMediaConnectorID ConnectorID, OcaDB Gain, auto on_result, failure_callback on_failure)
Calls the method SetConnectorAlignmentGain in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaConnectorID ConnectorID
OcaDB Gain
auto on_result
: A callable (e.g. a lambda) with 0 arguments.failure_callback on_failure
: A callback which is called on error.
DeleteConnector#
void DeleteConnector(OcaMediaConnectorID ID, auto on_result, failure_callback on_failure)
Calls the method DeleteConnector in the remote device. If no result and error callback is specified, the method will be called without requesting a response.
Parameters:#
OcaMediaConnectorID ID
auto on_result
: A callable (e.g. a lambda) with 0 arguments.failure_callback on_failure
: A callback which is called on error.
GetAlignmentLevel#
void GetAlignmentLevel(auto on_result, failure_callback on_failure)
Calls the method GetAlignmentLevel in the remote device.
Parameters:#
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaDBFS Level
OcaDBFS MinLevel
OcaDBFS MaxLevel
failure_callback on_failure
: A callback which is called on error.
GetAlignmentGain#
void GetAlignmentGain(auto on_result, failure_callback on_failure)
Calls the method GetAlignmentGain in the remote device.
Parameters:#
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaDB Gain
OcaDB minGain
OcaDB maxGain
failure_callback on_failure
: A callback which is called on error.
observeProtocol#
subscription observeProtocol(auto callback, failure_callback on_failure)
Fetches the remote property Protocol and subscribes for modifications. The callback is called with the initial values of Protocol and whenever it changes.
Parameters:#
auto callback
: A callable (e.g. a lambda) with one argument:OcaNetworkMediaProtocol Protocol
failure_callback on_failure
: A callback which is called on error.
observePorts#
subscription observePorts(auto callback, failure_callback on_failure)
Fetches the remote property Ports and subscribes for modifications. The callback is called with the initial values of Ports and whenever it changes.
Parameters:#
auto callback
: A callable (e.g. a lambda) with one argument:OcaList<OcaPort> Ports
failure_callback on_failure
: A callback which is called on error.
observeMaxSourceConnectors#
subscription observeMaxSourceConnectors(auto callback, failure_callback on_failure)
Fetches the remote property MaxSourceConnectors and subscribes for modifications. The callback is called with the initial values of MaxSourceConnectors and whenever it changes.
Parameters:#
auto callback
: A callable (e.g. a lambda) with one argument:OcaUint16 MaxSourceConnectors
failure_callback on_failure
: A callback which is called on error.
observeMaxSinkConnectors#
subscription observeMaxSinkConnectors(auto callback, failure_callback on_failure)
Fetches the remote property MaxSinkConnectors and subscribes for modifications. The callback is called with the initial values of MaxSinkConnectors and whenever it changes.
Parameters:#
auto callback
: A callable (e.g. a lambda) with one argument:OcaUint16 MaxSinkConnectors
failure_callback on_failure
: A callback which is called on error.
observeMaxPinsPerConnector#
subscription observeMaxPinsPerConnector(auto callback, failure_callback on_failure)
Fetches the remote property MaxPinsPerConnector and subscribes for modifications. The callback is called with the initial values of MaxPinsPerConnector and whenever it changes.
Parameters:#
auto callback
: A callable (e.g. a lambda) with one argument:OcaUint16 MaxPinsPerConnector
failure_callback on_failure
: A callback which is called on error.
observeMaxPortsPerPin#
subscription observeMaxPortsPerPin(auto callback, failure_callback on_failure)
Fetches the remote property MaxPortsPerPin and subscribes for modifications. The callback is called with the initial values of MaxPortsPerPin and whenever it changes.
Parameters:#
auto callback
: A callable (e.g. a lambda) with one argument:OcaUint16 MaxPortsPerPin
failure_callback on_failure
: A callback which is called on error.
observeAlignmentLevel#
subscription observeAlignmentLevel(auto callback, failure_callback on_failure)
Fetches the remote property AlignmentLevel and subscribes for modifications. The callback is called with the initial values of AlignmentLevel and whenever it changes.
Parameters:#
auto callback
: A callable (e.g. a lambda) with one argument:OcaDBFS AlignmentLevel
failure_callback on_failure
: A callback which is called on error.
observeAlignmentGain#
subscription observeAlignmentGain(auto callback, failure_callback on_failure)
Fetches the remote property AlignmentGain and subscribes for modifications. The callback is called with the initial values of AlignmentGain and whenever it changes.
Parameters:#
auto callback
: A callable (e.g. a lambda) with one argument:OcaDB AlignmentGain
failure_callback on_failure
: A callback which is called on error.
OnProtocolChanged#
subscription OnProtocolChanged(auto callback, failure_callback on_failure)
Parameters#
auto callback
: A callable (e.g. a lambda) with one argument:OcaNetworkMediaProtocol Protocol
failure_callback on_failure
: A callback which is called on error.
OnPortsChanged#
subscription OnPortsChanged(auto callback, failure_callback on_failure)
Parameters#
auto callback
: A callable (e.g. a lambda) with one argument:OcaList<OcaPort> Ports
failure_callback on_failure
: A callback which is called on error.
OnMaxSourceConnectorsChanged#
subscription OnMaxSourceConnectorsChanged(auto callback, failure_callback on_failure)
Parameters#
auto callback
: A callable (e.g. a lambda) with one argument:OcaUint16 MaxSourceConnectors
failure_callback on_failure
: A callback which is called on error.
OnMaxSinkConnectorsChanged#
subscription OnMaxSinkConnectorsChanged(auto callback, failure_callback on_failure)
Parameters#
auto callback
: A callable (e.g. a lambda) with one argument:OcaUint16 MaxSinkConnectors
failure_callback on_failure
: A callback which is called on error.
OnMaxPinsPerConnectorChanged#
subscription OnMaxPinsPerConnectorChanged(auto callback, failure_callback on_failure)
Parameters#
auto callback
: A callable (e.g. a lambda) with one argument:OcaUint16 MaxPinsPerConnector
failure_callback on_failure
: A callback which is called on error.
OnMaxPortsPerPinChanged#
subscription OnMaxPortsPerPinChanged(auto callback, failure_callback on_failure)
Parameters#
auto callback
: A callable (e.g. a lambda) with one argument:OcaUint16 MaxPortsPerPin
failure_callback on_failure
: A callback which is called on error.
OnAlignmentLevelChanged#
subscription OnAlignmentLevelChanged(auto callback, failure_callback on_failure)
Parameters#
auto callback
: A callable (e.g. a lambda) with one argument:OcaDBFS AlignmentLevel
failure_callback on_failure
: A callback which is called on error.
OnAlignmentGainChanged#
subscription OnAlignmentGainChanged(auto callback, failure_callback on_failure)
Parameters#
auto callback
: A callable (e.g. a lambda) with one argument:OcaDB AlignmentGain
failure_callback on_failure
: A callback which is called on error.