OcaMediaClockManager

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

Optional manager that collects all media clocks the device uses. Must be instantiated in every device that has more than one media clock object. In this context, "media clock" means an instance of OcaMediaClock, OcaMediaClock3, or any subclass of these classes., May be instantiated at most once in any device., If instantiated, object number must be 7.

---

Overview

• ClassID: 1.3.7
• Header: aes70/controller/OcaMediaClockManager.hpp
• Namespace: aes70::controller
• Inheritance: aes70::controller::OcaManager, aes70::controller::OcaRoot, aes70::controller::object

Class Declaration

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

    // Control Methods
    // Calls GetClocks and calls on_result or on_failure
    void GetClocks(auto on_result, failure_callback on_failure);
    // Calls GetMediaClockTypesSupported and calls on_result or on_failure
    void GetMediaClockTypesSupported(auto on_result, failure_callback on_failure);
    // Calls GetClock3s and calls on_result or on_failure
    void GetClock3s(auto on_result, failure_callback on_failure);

    // Observing Properties
    subscription observeClockSourceTypesSupported(auto callback, failure_callback on_failure);
    subscription observeClocks(auto callback, failure_callback on_failure);
    subscription observeClock3s(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnClockSourceTypesSupportedChanged(auto callback, failure_callback on_failure);
    subscription OnClocksChanged(auto callback, failure_callback on_failure);
    subscription OnClock3sChanged(auto callback, failure_callback on_failure);
  };
}

Methods

GetClocks

void GetClocks(auto on_result, failure_callback on_failure)

Calls the method GetClocks in the remote device.

Parameters:

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

GetMediaClockTypesSupported

void GetMediaClockTypesSupported(auto on_result, failure_callback on_failure)

Calls the method GetMediaClockTypesSupported in the remote device.

Parameters:

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

GetClock3s

void GetClock3s(auto on_result, failure_callback on_failure)

Calls the method GetClock3s in the remote device.

Parameters:

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

observeClockSourceTypesSupported

subscription observeClockSourceTypesSupported(auto callback, failure_callback on_failure)

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

Parameters:

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

observeClocks

subscription observeClocks(auto callback, failure_callback on_failure)

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

Parameters:

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

observeClock3s

subscription observeClock3s(auto callback, failure_callback on_failure)

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

Parameters:

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

OnClockSourceTypesSupportedChanged

subscription OnClockSourceTypesSupportedChanged(auto callback, failure_callback on_failure)

Parameters

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

OnClocksChanged

subscription OnClocksChanged(auto callback, failure_callback on_failure)

Parameters

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

OnClock3sChanged

subscription OnClock3sChanged(auto callback, failure_callback on_failure)

Parameters

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