1.1.1.10 OcaFilterParametric

Class Hierarchy:

OcaRoot : OcaWorker : OcaActuator : OcaFilterParametric

class OcaFilterParametric : OcaActuator 

Parametric equalizer section with various shape options.

Properties:

static const OcaClassID ClassID = "1.1.1.10"

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

static const OcaClassVersionNumber ClassVersion = 3

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

OcaFrequency Frequency

Frequency setpoint of the parametric filter.

This property has id 4.1.

OcaDB InBandGain

In-band gain of the parametric filter.

This property has id 4.4.

OcaParametricEQShape Shape

Shape of the parametric filter - peak, shelf, etc.

This property has id 4.2.

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.

OcaFloat32 WidthParameter

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

This property has id 4.3.

Properties inherited from 1.1.1 OcaActuator:

Methods:

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

Gets the value and limits of the Frequency property.

This method has id 4.1.

Frequency: Output parameter.
minFrequency: Output parameter.
maxFrequency: Output parameter.

OcaStatus SetFrequency(OcaFrequency Frequency)

Sets the value of the Frequency property.

This method has id 4.2.

Frequency: Input parameter.

OcaStatus GetShape(OcaParametricEQShape &type)

Gets the value of the Shape property.

This method has id 4.3.

type: Output parameter.

OcaStatus SetShape(OcaParametricEQShape type)

Sets the value of the Shape property.

This method has id 4.4.

type: Input parameter.

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

Gets the value and limits of the WidthParameter property.

This method has id 4.5.

Width: Output parameter.
minWidth: Output parameter.
maxWidth: Output parameter.

OcaStatus SetWidthParameter(OcaFloat32 Width)

Sets the value of the WidthParameter property.

This method has id 4.6.

Width: Input parameter.

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

Gets the value, min, and max of the InBandGain property.

This method has id 4.7.

gain: Output parameter.
minGain: Output parameter.
maxGain: Output parameter.

OcaStatus SetInbandGain(OcaDB gain)

Sets the value of the InBandGain property.

This method has id 4.8.

gain: Input parameter.

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

Gets the value and limits of the ShapeParameter property.

This method has id 4.9.

shape: Output parameter.
minShape: Output parameter.
maxShape: Output parameter.

OcaStatus SetShapeParameter(OcaFloat32 shape)

Sets the value of the S**hapeParameter** property.

This method has id 4.10.

shape: Input parameter.

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

Sets some or all filter parameters. 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.

Mask: Input parameter.
Frequency: Input parameter.
Shape: Input parameter.
WidthParameter: Input parameter.
InBandGain: Input parameter.
ShapeParameter: Input parameter.

Methods inherited from 1.1.1 OcaActuator: