Skip to content

OcaFilterParametric#

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

Parametric equalizer section with various shape options.

Overview#

Class Declaration#

The device side implementation has the following signature.

namespace aes70::device
{
  template <class Implementation>
  class OcaFilterParametric : public OcaActuator<Implementation>
  {

  };
}

The template argument Implementation may implement the following methods.

Note

The signatures given here are just one possibility and that most methods are optional. Implement only those methods which make sense in the context of your device. See the documentation in Implementing AES70 Classes for more details.

class MyOcaFilterParametricImplementation
{
  // Methods defined by OcaFilterParametric
  std::tuple<OcaFrequency,OcaFrequency,OcaFrequency> GetFrequency();
  void SetFrequency(OcaFrequency Frequency);
  OcaParametricEQShape GetShape();
  void SetShape(OcaParametricEQShape type);
  std::tuple<OcaFloat32,OcaFloat32,OcaFloat32> GetWidthParameter();
  void SetWidthParameter(OcaFloat32 Width);
  std::tuple<OcaDB,OcaDB,OcaDB> GetInbandGain();
  void SetInbandGain(OcaDB gain);
  std::tuple<OcaFloat32,OcaFloat32,OcaFloat32> GetShapeParameter();
  void SetShapeParameter(OcaFloat32 shape);
  void SetMultiple(OcaParameterMask Mask, OcaFrequency Frequency, OcaParametricEQShape Shape, OcaFloat32 WidthParameter, OcaDB InBandGain, OcaFloat32 ShapeParameter);

  // Methods defined by OcaWorker
  OcaBoolean GetEnabled();
  void SetEnabled(OcaBoolean enabled);
  OcaPortID AddPort(OcaString Name, OcaIODirection Mode);
  void DeletePort(OcaPortID ID);
  OcaList<OcaPort> GetPorts();
  OcaString GetPortName(OcaPortID PortID);
  void SetPortName(OcaPortID ID, OcaString Name);
  OcaString GetLabel();
  void SetLabel(OcaString label);
  OcaONo GetOwner();
  OcaTimeInterval GetLatency();
  void SetLatency(OcaTimeInterval latency);
  std::tuple<OcaRolePath,OcaONoPath> GetPath();
  OcaMap<OcaPortID, OcaPortClockMapEntry> GetPortClockMap();
  void SetPortClockMap(OcaMap<OcaPortID, OcaPortClockMapEntry> Map);
  OcaPortClockMapEntry GetPortClockMapEntry(OcaPortID ID);
  void SetPortClockMapEntry(OcaPortID PortID, OcaPortClockMapEntry Entry);
  void DeletePortClockMapEntry(OcaPortID ID);

  // Methods defined by OcaRoot
  OcaBoolean GetLockable();
  void SetLockNoReadWrite();
  void Unlock();
  OcaString GetRole();
  void SetLockNoWrite();
  OcaLockState GetLockState();

};

Events#