Skip to content

OcaMediaTransportApplication#

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

Connection Management 4 (CM4) class. Specifies the device's control interface to media transport functions. This is the anchoring class for CM4 data structures. Abstract class that shall be subclassed for each media transport Adaptation.

Overview#

Class Declaration#

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

    // Control Methods
    // Calls AddPort and calls on_result or on_failure
    void AddPort(OcaString Name, OcaIODirection Mode, auto on_result, failure_callback on_failure);
    // Calls AddPort and does not wait for the response
    void AddPort(OcaString Name, OcaIODirection Mode);
    // Calls DeletePort and calls on_result or on_failure
    void DeletePort(OcaPortID ID, auto on_result, failure_callback on_failure);
    // Calls DeletePort and does not wait for the response
    void DeletePort(OcaPortID ID);
    // 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 GetPortClockMap and calls on_result or on_failure
    void GetPortClockMap(auto on_result, failure_callback on_failure);
    // Calls SetPortClockMap and calls on_result or on_failure
    void SetPortClockMap(OcaMap<OcaPortID, OcaPortClockMapEntry> Map, auto on_result, failure_callback on_failure);
    // Calls SetPortClockMap and does not wait for the response
    void SetPortClockMap(OcaMap<OcaPortID, OcaPortClockMapEntry> Map);
    // Calls SetPortClockMapEntry and calls on_result or on_failure
    void SetPortClockMapEntry(OcaPortID ID, OcaPortClockMapEntry Entry, auto on_result, failure_callback on_failure);
    // Calls SetPortClockMapEntry and does not wait for the response
    void SetPortClockMapEntry(OcaPortID ID, OcaPortClockMapEntry Entry);
    // Calls DeletePortClockMapEntry and calls on_result or on_failure
    void DeletePortClockMapEntry(OcaPortID ID, auto on_result, failure_callback on_failure);
    // Calls DeletePortClockMapEntry and does not wait for the response
    void DeletePortClockMapEntry(OcaPortID ID);
    // Calls GetPortClockMapEntry and calls on_result or on_failure
    void GetPortClockMapEntry(OcaPortID ID, auto on_result, failure_callback on_failure);
    // Calls GetPortClockMapEntry and does not wait for the response
    void GetPortClockMapEntry(OcaPortID ID);
    // Calls GetMaxEndpointCounts and calls on_result or on_failure
    void GetMaxEndpointCounts(auto on_result, failure_callback on_failure);
    // Calls GetMaxPortsPerChannel and calls on_result or on_failure
    void GetMaxPortsPerChannel(auto on_result, failure_callback on_failure);
    // Calls GetMaxChannelsPerEndpoint and calls on_result or on_failure
    void GetMaxChannelsPerEndpoint(auto on_result, failure_callback on_failure);
    // Calls SetAlignmentLevelLimits and calls on_result or on_failure
    void SetAlignmentLevelLimits(OcaInterval<OcaDBFS> Limits, auto on_result, failure_callback on_failure);
    // Calls SetAlignmentLevelLimits and does not wait for the response
    void SetAlignmentLevelLimits(OcaInterval<OcaDBFS> Limits);
    // Calls GetMediaStreamModeCapabilities and calls on_result or on_failure
    void GetMediaStreamModeCapabilities(auto on_result, failure_callback on_failure);
    // Calls SetMediaStreamModeCapabilities and calls on_result or on_failure
    void SetMediaStreamModeCapabilities(OcaList<OcaMediaStreamModeCapability> Capabilities, auto on_result, failure_callback on_failure);
    // Calls SetMediaStreamModeCapabilities and does not wait for the response
    void SetMediaStreamModeCapabilities(OcaList<OcaMediaStreamModeCapability> Capabilities);
    // Calls GetMediaStreamModeCapability and calls on_result or on_failure
    void GetMediaStreamModeCapability(OcaID16 CapabilityID, auto on_result, failure_callback on_failure);
    // Calls GetMediaStreamModeCapability and does not wait for the response
    void GetMediaStreamModeCapability(OcaID16 CapabilityID);
    // Calls GetTransportTimingParameters and calls on_result or on_failure
    void GetTransportTimingParameters(auto on_result, failure_callback on_failure);
    // Calls SetTransportTimingParameters and calls on_result or on_failure
    void SetTransportTimingParameters(OcaMediaTransportTimingParameters Parameters, auto on_result, failure_callback on_failure);
    // Calls SetTransportTimingParameters and does not wait for the response
    void SetTransportTimingParameters(OcaMediaTransportTimingParameters Parameters);
    // Calls GetAlignmentLevelLimits and calls on_result or on_failure
    void GetAlignmentLevelLimits(auto on_result, failure_callback on_failure);
    // Calls GetEndpoints and calls on_result or on_failure
    void GetEndpoints(auto on_result, failure_callback on_failure);
    // Calls GetEndpoint and calls on_result or on_failure
    void GetEndpoint(OcaMediaStreamEndpointID ID, auto on_result, failure_callback on_failure);
    // Calls GetEndpoint and does not wait for the response
    void GetEndpoint(OcaMediaStreamEndpointID ID);
    // Calls GetEndpointStatuses and calls on_result or on_failure
    void GetEndpointStatuses(auto on_result, failure_callback on_failure);
    // Calls GetEndpointStatus and calls on_result or on_failure
    void GetEndpointStatus(OcaMediaStreamEndpointID ID, auto on_result, failure_callback on_failure);
    // Calls GetEndpointStatus and does not wait for the response
    void GetEndpointStatus(OcaMediaStreamEndpointID ID);
    // Calls AddEndpoint and calls on_result or on_failure
    void AddEndpoint(OcaMediaStreamEndpointState InitialStatus, auto on_result, failure_callback on_failure);
    // Calls AddEndpoint and does not wait for the response
    void AddEndpoint(OcaMediaStreamEndpointState InitialStatus);
    // Calls DeleteEndpoint and calls on_result or on_failure
    void DeleteEndpoint(OcaMediaStreamEndpointID ID, auto on_result, failure_callback on_failure);
    // Calls DeleteEndpoint and does not wait for the response
    void DeleteEndpoint(OcaMediaStreamEndpointID ID);
    // Calls ApplyEndpointCommand and calls on_result or on_failure
    void ApplyEndpointCommand(OcaMediaStreamEndpointID EndpointID, OcaMediaStreamEndpointCommand Command, auto on_result, failure_callback on_failure);
    // Calls ApplyEndpointCommand and does not wait for the response
    void ApplyEndpointCommand(OcaMediaStreamEndpointID EndpointID, OcaMediaStreamEndpointCommand Command);
    // Calls SetEndpointUserLabel and calls on_result or on_failure
    void SetEndpointUserLabel(OcaMediaStreamEndpointID EndpointID, OcaString Label, auto on_result, failure_callback on_failure);
    // Calls SetEndpointUserLabel and does not wait for the response
    void SetEndpointUserLabel(OcaMediaStreamEndpointID EndpointID, OcaString Label);
    // Calls SetEndpointMediaStreamMode and calls on_result or on_failure
    void SetEndpointMediaStreamMode(OcaMediaStreamEndpointID EndpointID, OcaMediaStreamMode StreamMode, auto on_result, failure_callback on_failure);
    // Calls SetEndpointMediaStreamMode and does not wait for the response
    void SetEndpointMediaStreamMode(OcaMediaStreamEndpointID EndpointID, OcaMediaStreamMode StreamMode);
    // Calls SetEndpointChannelMap and calls on_result or on_failure
    void SetEndpointChannelMap(OcaMediaStreamEndpointID EndpointID, OcaMultiMap<OcaID16, OcaPortID> ChannelMap, auto on_result, failure_callback on_failure);
    // Calls SetEndpointChannelMap and does not wait for the response
    void SetEndpointChannelMap(OcaMediaStreamEndpointID EndpointID, OcaMultiMap<OcaID16, OcaPortID> ChannelMap);
    // Calls SetEndpointAlignmentLevel and calls on_result or on_failure
    void SetEndpointAlignmentLevel(OcaMediaStreamEndpointID EndpointID, OcaDBFS Level, auto on_result, failure_callback on_failure);
    // Calls SetEndpointAlignmentLevel and does not wait for the response
    void SetEndpointAlignmentLevel(OcaMediaStreamEndpointID EndpointID, OcaDBFS Level);
    // Calls GetEndpointTimeSource and calls on_result or on_failure
    void GetEndpointTimeSource(OcaMediaStreamEndpointID ID, auto on_result, failure_callback on_failure);
    // Calls GetEndpointTimeSource and does not wait for the response
    void GetEndpointTimeSource(OcaMediaStreamEndpointID ID);
    // Calls SetEndpointAdaptationData and calls on_result or on_failure
    void SetEndpointAdaptationData(OcaMediaStreamEndpointID EndpointID, OcaAdaptationData Data, auto on_result, failure_callback on_failure);
    // Calls SetEndpointAdaptationData and does not wait for the response
    void SetEndpointAdaptationData(OcaMediaStreamEndpointID EndpointID, OcaAdaptationData Data);
    // Calls GetEndpointCounterSets and calls on_result or on_failure
    void GetEndpointCounterSets(auto on_result, failure_callback on_failure);
    // Calls GetEndpointCounterSet and calls on_result or on_failure
    void GetEndpointCounterSet(OcaMediaStreamEndpointID EndpointID, auto on_result, failure_callback on_failure);
    // Calls GetEndpointCounterSet and does not wait for the response
    void GetEndpointCounterSet(OcaMediaStreamEndpointID EndpointID);
    // Calls GetEndpointCounter and calls on_result or on_failure
    void GetEndpointCounter(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, auto on_result, failure_callback on_failure);
    // Calls GetEndpointCounter and does not wait for the response
    void GetEndpointCounter(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID);
    // Calls AttachEndpointCounterNotifier and calls on_result or on_failure
    void AttachEndpointCounterNotifier(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, OcaONo NotifierONo, auto on_result, failure_callback on_failure);
    // Calls AttachEndpointCounterNotifier and does not wait for the response
    void AttachEndpointCounterNotifier(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, OcaONo NotifierONo);
    // Calls DetachEndpointCounterNotifier and calls on_result or on_failure
    void DetachEndpointCounterNotifier(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, OcaONo NotifierONo, auto on_result, failure_callback on_failure);
    // Calls DetachEndpointCounterNotifier and does not wait for the response
    void DetachEndpointCounterNotifier(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, OcaONo NotifierONo);
    // Calls ResetEndpointCounterSet and calls on_result or on_failure
    void ResetEndpointCounterSet(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, auto on_result, failure_callback on_failure);
    // Calls ResetEndpointCounterSet and does not wait for the response
    void ResetEndpointCounterSet(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID);
    // Calls GetTransportSessionControlAgentONos and calls on_result or on_failure
    void GetTransportSessionControlAgentONos(auto on_result, failure_callback on_failure);
    // Calls SetTransportSessionControlAgentONos and calls on_result or on_failure
    void SetTransportSessionControlAgentONos(OcaList<OcaONo> ONos, auto on_result, failure_callback on_failure);
    // Calls SetTransportSessionControlAgentONos and does not wait for the response
    void SetTransportSessionControlAgentONos(OcaList<OcaONo> ONos);

    // Observing Properties
    subscription observePorts(auto callback, failure_callback on_failure);
    subscription observePortClockMap(auto callback, failure_callback on_failure);
    subscription observeMaxInputEndpoints(auto callback, failure_callback on_failure);
    subscription observeMaxOutputEndpoints(auto callback, failure_callback on_failure);
    subscription observeMaxPortsPerChannel(auto callback, failure_callback on_failure);
    subscription observeMaxChannelsPerEndpoint(auto callback, failure_callback on_failure);
    subscription observeMediaStreamModeCapabilities(auto callback, failure_callback on_failure);
    subscription observeTransportTimingParameters(auto callback, failure_callback on_failure);
    subscription observeAlignmentLevelLimits(auto callback, failure_callback on_failure);
    subscription observeEndpoints(auto callback, failure_callback on_failure);
    subscription observeEndpointStatuses(auto callback, failure_callback on_failure);
    subscription observeTransportSessionControlAgentONos(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnPortsChanged(auto callback, failure_callback on_failure);
    subscription OnPortClockMapChanged(auto callback, failure_callback on_failure);
    subscription OnMaxInputEndpointsChanged(auto callback, failure_callback on_failure);
    subscription OnMaxOutputEndpointsChanged(auto callback, failure_callback on_failure);
    subscription OnMaxPortsPerChannelChanged(auto callback, failure_callback on_failure);
    subscription OnMaxChannelsPerEndpointChanged(auto callback, failure_callback on_failure);
    subscription OnMediaStreamModeCapabilitiesChanged(auto callback, failure_callback on_failure);
    subscription OnTransportTimingParametersChanged(auto callback, failure_callback on_failure);
    subscription OnAlignmentLevelLimitsChanged(auto callback, failure_callback on_failure);
    subscription OnEndpointsChanged(auto callback, failure_callback on_failure);
    subscription OnEndpointStatusesChanged(auto callback, failure_callback on_failure);
    subscription OnTransportSessionControlAgentONosChanged(auto callback, failure_callback on_failure);
  };
}

Methods#

AddPort#

void AddPort(OcaString Name, OcaIODirection Mode, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaString Name
  • OcaIODirection Mode
  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaPortID ID
  • failure_callback on_failure: A callback which is called on error.

DeletePort#

void DeletePort(OcaPortID ID, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaPortID ID
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • 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.

GetPortClockMap#

void GetPortClockMap(auto on_result, failure_callback on_failure)

Calls the method GetPortClockMap in the remote device.

Parameters:#

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

SetPortClockMap#

void SetPortClockMap(OcaMap<OcaPortID, OcaPortClockMapEntry> Map, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaMap<OcaPortID, OcaPortClockMapEntry> Map
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

SetPortClockMapEntry#

void SetPortClockMapEntry(OcaPortID ID, OcaPortClockMapEntry Entry, auto on_result, failure_callback on_failure)

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

Parameters:#

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

DeletePortClockMapEntry#

void DeletePortClockMapEntry(OcaPortID ID, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetPortClockMapEntry#

void GetPortClockMapEntry(OcaPortID ID, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetMaxEndpointCounts#

void GetMaxEndpointCounts(auto on_result, failure_callback on_failure)

Calls the method GetMaxEndpointCounts in the remote device.

Parameters:#

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

GetMaxPortsPerChannel#

void GetMaxPortsPerChannel(auto on_result, failure_callback on_failure)

Calls the method GetMaxPortsPerChannel in the remote device.

Parameters:#

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

GetMaxChannelsPerEndpoint#

void GetMaxChannelsPerEndpoint(auto on_result, failure_callback on_failure)

Calls the method GetMaxChannelsPerEndpoint in the remote device.

Parameters:#

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

SetAlignmentLevelLimits#

void SetAlignmentLevelLimits(OcaInterval<OcaDBFS> Limits, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaInterval<OcaDBFS> Limits
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetMediaStreamModeCapabilities#

void GetMediaStreamModeCapabilities(auto on_result, failure_callback on_failure)

Calls the method GetMediaStreamModeCapabilities in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaMediaStreamModeCapability> Capabilities
  • failure_callback on_failure: A callback which is called on error.

SetMediaStreamModeCapabilities#

void SetMediaStreamModeCapabilities(OcaList<OcaMediaStreamModeCapability> Capabilities, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaList<OcaMediaStreamModeCapability> Capabilities
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetMediaStreamModeCapability#

void GetMediaStreamModeCapability(OcaID16 CapabilityID, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetTransportTimingParameters#

void GetTransportTimingParameters(auto on_result, failure_callback on_failure)

Calls the method GetTransportTimingParameters in the remote device.

Parameters:#

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

SetTransportTimingParameters#

void SetTransportTimingParameters(OcaMediaTransportTimingParameters Parameters, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetAlignmentLevelLimits#

void GetAlignmentLevelLimits(auto on_result, failure_callback on_failure)

Calls the method GetAlignmentLevelLimits in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaInterval<OcaDBFS> Limits
  • failure_callback on_failure: A callback which is called on error.

GetEndpoints#

void GetEndpoints(auto on_result, failure_callback on_failure)

Calls the method GetEndpoints in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaMediaStreamEndpoint> Endpoints
  • failure_callback on_failure: A callback which is called on error.

GetEndpoint#

void GetEndpoint(OcaMediaStreamEndpointID ID, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetEndpointStatuses#

void GetEndpointStatuses(auto on_result, failure_callback on_failure)

Calls the method GetEndpointStatuses in the remote device.

Parameters:#

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

GetEndpointStatus#

void GetEndpointStatus(OcaMediaStreamEndpointID ID, auto on_result, failure_callback on_failure)

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

Parameters:#

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

AddEndpoint#

void AddEndpoint(OcaMediaStreamEndpointState InitialStatus, auto on_result, failure_callback on_failure)

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

Parameters:#

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

DeleteEndpoint#

void DeleteEndpoint(OcaMediaStreamEndpointID ID, auto on_result, failure_callback on_failure)

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

Parameters:#

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

ApplyEndpointCommand#

void ApplyEndpointCommand(OcaMediaStreamEndpointID EndpointID, OcaMediaStreamEndpointCommand Command, auto on_result, failure_callback on_failure)

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

Parameters:#

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

SetEndpointUserLabel#

void SetEndpointUserLabel(OcaMediaStreamEndpointID EndpointID, OcaString Label, auto on_result, failure_callback on_failure)

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

Parameters:#

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

SetEndpointMediaStreamMode#

void SetEndpointMediaStreamMode(OcaMediaStreamEndpointID EndpointID, OcaMediaStreamMode StreamMode, auto on_result, failure_callback on_failure)

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

Parameters:#

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

SetEndpointChannelMap#

void SetEndpointChannelMap(OcaMediaStreamEndpointID EndpointID, OcaMultiMap<OcaID16, OcaPortID> ChannelMap, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaMediaStreamEndpointID EndpointID
  • OcaMultiMap<OcaID16, OcaPortID> ChannelMap
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

SetEndpointAlignmentLevel#

void SetEndpointAlignmentLevel(OcaMediaStreamEndpointID EndpointID, OcaDBFS Level, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaMediaStreamEndpointID EndpointID
  • 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.

GetEndpointTimeSource#

void GetEndpointTimeSource(OcaMediaStreamEndpointID ID, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaMediaStreamEndpointID ID
  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaTimeReferenceType ReferenceType
    • OcaString ReferenceID
  • failure_callback on_failure: A callback which is called on error.

SetEndpointAdaptationData#

void SetEndpointAdaptationData(OcaMediaStreamEndpointID EndpointID, OcaAdaptationData Data, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetEndpointCounterSets#

void GetEndpointCounterSets(auto on_result, failure_callback on_failure)

Calls the method GetEndpointCounterSets in the remote device.

Parameters:#

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

GetEndpointCounterSet#

void GetEndpointCounterSet(OcaMediaStreamEndpointID EndpointID, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetEndpointCounter#

void GetEndpointCounter(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaMediaStreamEndpointID EndpointID
  • OcaID16 CounterID
  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaCounter Counter
  • failure_callback on_failure: A callback which is called on error.

AttachEndpointCounterNotifier#

void AttachEndpointCounterNotifier(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, OcaONo NotifierONo, auto on_result, failure_callback on_failure)

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

Parameters:#

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

DetachEndpointCounterNotifier#

void DetachEndpointCounterNotifier(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, OcaONo NotifierONo, auto on_result, failure_callback on_failure)

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

Parameters:#

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

ResetEndpointCounterSet#

void ResetEndpointCounterSet(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetTransportSessionControlAgentONos#

void GetTransportSessionControlAgentONos(auto on_result, failure_callback on_failure)

Calls the method GetTransportSessionControlAgentONos in the remote device.

Parameters:#

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

SetTransportSessionControlAgentONos#

void SetTransportSessionControlAgentONos(OcaList<OcaONo> ONos, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaList<OcaONo> ONos
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • 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.

observePortClockMap#

subscription observePortClockMap(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeMaxInputEndpoints#

subscription observeMaxInputEndpoints(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeMaxOutputEndpoints#

subscription observeMaxOutputEndpoints(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeMaxPortsPerChannel#

subscription observeMaxPortsPerChannel(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeMaxChannelsPerEndpoint#

subscription observeMaxChannelsPerEndpoint(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeMediaStreamModeCapabilities#

subscription observeMediaStreamModeCapabilities(auto callback, failure_callback on_failure)

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

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaMediaStreamModeCapability> MediaStreamModeCapabilities
  • failure_callback on_failure: A callback which is called on error.

observeTransportTimingParameters#

subscription observeTransportTimingParameters(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeAlignmentLevelLimits#

subscription observeAlignmentLevelLimits(auto callback, failure_callback on_failure)

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

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaInterval<OcaDBFS> AlignmentLevelLimits
  • failure_callback on_failure: A callback which is called on error.

observeEndpoints#

subscription observeEndpoints(auto callback, failure_callback on_failure)

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

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaMediaStreamEndpoint> Endpoints
  • failure_callback on_failure: A callback which is called on error.

observeEndpointStatuses#

subscription observeEndpointStatuses(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeTransportSessionControlAgentONos#

subscription observeTransportSessionControlAgentONos(auto callback, failure_callback on_failure)

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

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaONo> TransportSessionControlAgentONos
  • 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.

OnPortClockMapChanged#

subscription OnPortClockMapChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnMaxInputEndpointsChanged#

subscription OnMaxInputEndpointsChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnMaxOutputEndpointsChanged#

subscription OnMaxOutputEndpointsChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnMaxPortsPerChannelChanged#

subscription OnMaxPortsPerChannelChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnMaxChannelsPerEndpointChanged#

subscription OnMaxChannelsPerEndpointChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnMediaStreamModeCapabilitiesChanged#

subscription OnMediaStreamModeCapabilitiesChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaMediaStreamModeCapability> MediaStreamModeCapabilities
  • failure_callback on_failure: A callback which is called on error.

OnTransportTimingParametersChanged#

subscription OnTransportTimingParametersChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnAlignmentLevelLimitsChanged#

subscription OnAlignmentLevelLimitsChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaInterval<OcaDBFS> AlignmentLevelLimits
  • failure_callback on_failure: A callback which is called on error.

OnEndpointsChanged#

subscription OnEndpointsChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaMediaStreamEndpoint> Endpoints
  • failure_callback on_failure: A callback which is called on error.

OnEndpointStatusesChanged#

subscription OnEndpointStatusesChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnTransportSessionControlAgentONosChanged#

subscription OnTransportSessionControlAgentONosChanged(auto callback, failure_callback on_failure)

Parameters#

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