1.1.1.10 OcaFilterParametric

Class Hirarchy:

OcaRootOcaWorkerOcaActuatorOcaFilterParametric

class OcaFilterParametric : OcaActuator

A parametric equalizer section with various shape options.

Properties:

OcaClassID ClassID

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the OcaRoot property.

This property has id 4.1.

OcaClassVersionNumber ClassVersion

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

This property has id 4.2.

OcaFrequency Frequency

The frequency setpoint of the parametric filter.

This property has id 4.1.

OcaParametricEQShape Shape

The shape of the parametric filter - peak, shelf, etc.

This property has id 4.2.

OcaFloat32 WidthParameter

Width parameter. For normal parametric implementations, this is the Q of the filter.

This property has id 4.3.

OcaDB InbandGain

In-band gain of the parametric filter.

This property has id 4.4.

OcaFloat32 ShapeParameter

Width parameter. For certain filter types, this parameter may be used to represent extra information about the shape of the transfer function.

This property has id 4.5.

Properties inherited from OcaWorker:

Properties inherited from OcaRoot:

Methods:

OcaStatus GetFrequency(OcaFrequency &Frequency, OcaFrequency &minFrequency, OcaFrequency &maxFrequency)

Gets the equalizer frequency setpoint. The return value indicates whether the data was successfully retrieved.

This method has id 4.1.

Parameters
  • OcaFrequency Frequency – Output parameter.

  • OcaFrequency minFrequency – Output parameter.

  • OcaFrequency maxFrequency – Output parameter.

OcaStatus SetFrequency(OcaFrequency Frequency)

Sets the equalizer frequency. The return value indicates whether the value was successfully set.

This method has id 4.2.

Parameters

OcaFrequency Frequency – Input parameter.

OcaStatus GetShape(OcaParametricEQShape &type)

Gets the curve shape of the equalizer. The return value indicates whether the data was successfully retrieved.

This method has id 4.3.

Parameters

OcaParametricEQShape type – Output parameter.

OcaStatus SetShape(OcaParametricEQShape type)

Sets the curve shape shape of the equalizer. The return value indicates whether the shape was successfully set.

This method has id 4.4.

Parameters

OcaParametricEQShape type – Input parameter.

OcaStatus GetWidthParameter(OcaFloat32 &Width, OcaFloat32 &minWidth, OcaFloat32 &maxWidth)

Gets the width parameter property of the equalizer. The return value indicates whether the data was successfully retrieved.

This method has id 4.5.

Parameters
  • OcaFloat32 Width – Output parameter.

  • OcaFloat32 minWidth – Output parameter.

  • OcaFloat32 maxWidth – Output parameter.

OcaStatus SetWidthParameter(OcaFloat32 Width)

Sets the width parameter property of the equalizer. The return value indicates whether the Q was successfully set.

This method has id 4.6.

Parameters

OcaFloat32 Width – Input parameter.

OcaStatus GetInbandGain(OcaDB &gain, OcaDB &minGain, OcaDB &maxGain)

Returns the in-band gain of the equalizer. The return value indicates whether the data was successfully retrieved.

This method has id 4.7.

Parameters
  • OcaDB gain – Output parameter.

  • OcaDB minGain – Output parameter.

  • OcaDB maxGain – Output parameter.

OcaStatus SetInbandGain(OcaDB gain)

Sets the in-band gain of the equalizer. The return value indicates whether the gain was successfully set.

This method has id 4.8.

Parameters

OcaDB gain – Input parameter.

OcaStatus GetShapeParameter(OcaFloat32 &shape, OcaFloat32 &minShape, OcaFloat32 &maxShape)

Returns the shape parameter of the equalizer. The return value indicates whether the data was successfully retrieved.

This method has id 4.9.

Parameters
  • OcaFloat32 shape – Output parameter.

  • OcaFloat32 minShape – Output parameter.

  • OcaFloat32 maxShape – Output parameter.

OcaStatus SetShapeParameter(OcaFloat32 shape)

Sets the shape parameter of the equalizer. The return value indicates whether the parameter was successfully set.

This method has id 4.10.

Parameters

OcaFloat32 shape – Input parameter.

OcaStatus SetMultiple(OcaParameterMask Mask, OcaFrequency Frequency, OcaParametricEQShape Shape, OcaFloat32 WidthParameter, OcaDB InBandGain, OcaFloat32 ShapeParameter)

Sets some or all filter parameters. The return value indicates if the parameters were successfully set. The action of this method is atomic - if any of the value changes fails, none of the changes are made.

This method has id 4.11.

Parameters
  • OcaParameterMask Mask – Input parameter.

  • OcaFrequency Frequency – Input parameter.

  • OcaParametricEQShape Shape – Input parameter.

  • OcaFloat32 WidthParameter – Input parameter.

  • OcaDB InBandGain – Input parameter.

  • OcaFloat32 ShapeParameter – Input parameter.

Methods inherited from OcaWorker:

Methods inherited from OcaRoot: