OcaFilterParametric

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

Parametric equalizer section with various shape options.

---

Overview

• ClassID: 1.1.1.10
• Header: aes70/controller/OcaFilterParametric.hpp
• Namespace: aes70::controller
• Inheritance: aes70::controller::OcaActuator, aes70::controller::OcaWorker, aes70::controller::OcaRoot, aes70::controller::object

Class Declaration

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

    // Control Methods
    // Calls GetFrequency and calls on_result or on_failure
    void GetFrequency(auto on_result, failure_callback on_failure);
    // Calls SetFrequency and calls on_result or on_failure
    void SetFrequency(OcaFrequency Frequency, auto on_result, failure_callback on_failure);
    // Calls SetFrequency and does not wait for the response
    void SetFrequency(OcaFrequency Frequency);
    // Calls GetShape and calls on_result or on_failure
    void GetShape(auto on_result, failure_callback on_failure);
    // Calls SetShape and calls on_result or on_failure
    void SetShape(OcaParametricEQShape type, auto on_result, failure_callback on_failure);
    // Calls SetShape and does not wait for the response
    void SetShape(OcaParametricEQShape type);
    // Calls GetWidthParameter and calls on_result or on_failure
    void GetWidthParameter(auto on_result, failure_callback on_failure);
    // Calls SetWidthParameter and calls on_result or on_failure
    void SetWidthParameter(OcaFloat32 Width, auto on_result, failure_callback on_failure);
    // Calls SetWidthParameter and does not wait for the response
    void SetWidthParameter(OcaFloat32 Width);
    // Calls GetInbandGain and calls on_result or on_failure
    void GetInbandGain(auto on_result, failure_callback on_failure);
    // Calls SetInbandGain and calls on_result or on_failure
    void SetInbandGain(OcaDB gain, auto on_result, failure_callback on_failure);
    // Calls SetInbandGain and does not wait for the response
    void SetInbandGain(OcaDB gain);
    // Calls GetShapeParameter and calls on_result or on_failure
    void GetShapeParameter(auto on_result, failure_callback on_failure);
    // Calls SetShapeParameter and calls on_result or on_failure
    void SetShapeParameter(OcaFloat32 shape, auto on_result, failure_callback on_failure);
    // Calls SetShapeParameter and does not wait for the response
    void SetShapeParameter(OcaFloat32 shape);
    // Calls SetMultiple and calls on_result or on_failure
    void SetMultiple(OcaParameterMask Mask, OcaFrequency Frequency, OcaParametricEQShape Shape, OcaFloat32 WidthParameter, OcaDB InBandGain, OcaFloat32 ShapeParameter, auto on_result, failure_callback on_failure);
    // Calls SetMultiple and does not wait for the response
    void SetMultiple(OcaParameterMask Mask, OcaFrequency Frequency, OcaParametricEQShape Shape, OcaFloat32 WidthParameter, OcaDB InBandGain, OcaFloat32 ShapeParameter);

    // Observing Properties
    subscription observeFrequency(auto callback, failure_callback on_failure);
    subscription observeShape(auto callback, failure_callback on_failure);
    subscription observeWidthParameter(auto callback, failure_callback on_failure);
    subscription observeInBandGain(auto callback, failure_callback on_failure);
    subscription observeShapeParameter(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnFrequencyChanged(auto callback, failure_callback on_failure);
    subscription OnShapeChanged(auto callback, failure_callback on_failure);
    subscription OnWidthParameterChanged(auto callback, failure_callback on_failure);
    subscription OnInBandGainChanged(auto callback, failure_callback on_failure);
    subscription OnShapeParameterChanged(auto callback, failure_callback on_failure);
  };
}

Methods

GetFrequency

void GetFrequency(auto on_result, failure_callback on_failure)

Calls the method GetFrequency in the remote device.

Parameters:

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

SetFrequency

void SetFrequency(OcaFrequency Frequency, auto on_result, failure_callback on_failure)

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

Parameters:

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

GetShape

void GetShape(auto on_result, failure_callback on_failure)

Calls the method GetShape in the remote device.

Parameters:

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

SetShape

void SetShape(OcaParametricEQShape type, auto on_result, failure_callback on_failure)

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

Parameters:

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

GetWidthParameter

void GetWidthParameter(auto on_result, failure_callback on_failure)

Calls the method GetWidthParameter in the remote device.

Parameters:

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

SetWidthParameter

void SetWidthParameter(OcaFloat32 Width, auto on_result, failure_callback on_failure)

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

Parameters:

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

GetInbandGain

void GetInbandGain(auto on_result, failure_callback on_failure)

Calls the method GetInbandGain 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.

SetInbandGain

void SetInbandGain(OcaDB gain, auto on_result, failure_callback on_failure)

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

Parameters:

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

GetShapeParameter

void GetShapeParameter(auto on_result, failure_callback on_failure)

Calls the method GetShapeParameter in the remote device.

Parameters:

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

SetShapeParameter

void SetShapeParameter(OcaFloat32 shape, auto on_result, failure_callback on_failure)

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

Parameters:

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

SetMultiple

void SetMultiple(OcaParameterMask Mask, OcaFrequency Frequency, OcaParametricEQShape Shape, OcaFloat32 WidthParameter, OcaDB InBandGain, OcaFloat32 ShapeParameter, auto on_result, failure_callback on_failure)

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

Parameters:

• OcaParameterMask Mask
• OcaFrequency Frequency
• OcaParametricEQShape Shape
• OcaFloat32 WidthParameter
• OcaDB InBandGain
• OcaFloat32 ShapeParameter
• auto on_result: A callable (e.g. a lambda) with 0 arguments.
• failure_callback on_failure: A callback which is called on error.

observeFrequency

subscription observeFrequency(auto callback, failure_callback on_failure)

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

Parameters:

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

observeShape

subscription observeShape(auto callback, failure_callback on_failure)

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

Parameters:

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

observeWidthParameter

subscription observeWidthParameter(auto callback, failure_callback on_failure)

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

Parameters:

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

observeInBandGain

subscription observeInBandGain(auto callback, failure_callback on_failure)

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

Parameters:

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

observeShapeParameter

subscription observeShapeParameter(auto callback, failure_callback on_failure)

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

Parameters:

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

OnFrequencyChanged

subscription OnFrequencyChanged(auto callback, failure_callback on_failure)

Parameters

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

OnShapeChanged

subscription OnShapeChanged(auto callback, failure_callback on_failure)

Parameters

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

OnWidthParameterChanged

subscription OnWidthParameterChanged(auto callback, failure_callback on_failure)

Parameters

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

OnInBandGainChanged

subscription OnInBandGainChanged(auto callback, failure_callback on_failure)

Parameters

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

OnShapeParameterChanged

subscription OnShapeParameterChanged(auto callback, failure_callback on_failure)

Parameters

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