Skip to content

OcaCodingManager#

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

Optional manager that collects all media decoders/encoders (Codecs) which the device owns. Must be instantiated in every device that implements more than one media encoding scheme and/or more than one media decoding scheme., If instantiated, object number must be 12.

Overview#

Class Declaration#

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

    // Control Methods
    // Calls GetAvailableEncodingSchemes and calls on_result or on_failure
    void GetAvailableEncodingSchemes(auto on_result, failure_callback on_failure);
    // Calls GetAvailableDecodingSchemes and calls on_result or on_failure
    void GetAvailableDecodingSchemes(auto on_result, failure_callback on_failure);

    // Observing Properties
    subscription observeAvailableEncodingSchemes(auto callback, failure_callback on_failure);
    subscription observeAvailableDecodingSchemes(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnAvailableEncodingSchemesChanged(auto callback, failure_callback on_failure);
    subscription OnAvailableDecodingSchemesChanged(auto callback, failure_callback on_failure);
  };
}

Methods#

GetAvailableEncodingSchemes#

void GetAvailableEncodingSchemes(auto on_result, failure_callback on_failure)

Calls the method GetAvailableEncodingSchemes in the remote device.

Parameters:#

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

GetAvailableDecodingSchemes#

void GetAvailableDecodingSchemes(auto on_result, failure_callback on_failure)

Calls the method GetAvailableDecodingSchemes in the remote device.

Parameters:#

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

observeAvailableEncodingSchemes#

subscription observeAvailableEncodingSchemes(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeAvailableDecodingSchemes#

subscription observeAvailableDecodingSchemes(auto callback, failure_callback on_failure)

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

Parameters:#

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

OnAvailableEncodingSchemesChanged#

subscription OnAvailableEncodingSchemesChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnAvailableDecodingSchemesChanged#

subscription OnAvailableDecodingSchemesChanged(auto callback, failure_callback on_failure)

Parameters#

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