A parametric equalizer section with various shape options.
static
readonly
OcaClassID ClassID
= 1.1.1.10
Level: 1 Index: 1
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.
Level: 1 Index: 2
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.
Level: 4 Index: 1
The frequency setpoint of the parametric filter.
Level: 4 Index: 2
The shape of the parametric filter - peak, shelf, etc.
Level: 4 Index: 3
Width parameter. For normal parametric implementations, this is the Q of the filter.
OcaDB InBandGain
Level: 4 Index: 4
In-band gain of the parametric filter.
Level: 4 Index: 5
Width parameter. For certain filter types, this parameter may be used to represent extra information about the shape of the transfer function.
Properties inherited from OcaWorker
Properties inherited from OcaRoot
OcaFilterParametric::GetFrequency (
)
→ (
OcaFrequency Frequency, OcaFrequency minFrequency, OcaFrequency maxFrequency)
Level: 4 Index: 1
Gets the equalizer frequency setpoint. The return value indicates whether the data was successfully retrieved.
OcaFilterParametric::SetFrequency (
OcaFrequency Frequency )
Level: 4 Index: 2
Sets the equalizer frequency. The return value indicates whether the value was successfully set.
OcaFilterParametric::GetShape (
)
→ (
OcaParametricEQShape type)
Level: 4 Index: 3
Gets the curve shape of the equalizer. The return value indicates whether the data was successfully retrieved.
Level: 4 Index: 4
Sets the curve shape shape of the equalizer. The return value indicates whether the shape was successfully set.
OcaFilterParametric::GetWidthParameter (
)
→ (
OcaFloat32 Width, OcaFloat32 minWidth, OcaFloat32 maxWidth)
Level: 4 Index: 5
Gets the width parameter property of the equalizer. The return value indicates whether the data was successfully retrieved.
OcaFilterParametric::SetWidthParameter (
OcaFloat32 Width )
Level: 4 Index: 6
Sets the width parameter property of the equalizer. The return value indicates whether the Q was successfully set.
OcaFilterParametric::GetInbandGain (
)
→ (
OcaDB gain, OcaDB minGain, OcaDB maxGain)
Level: 4 Index: 7
Returns the in-band gain of the equalizer. The return value indicates whether the data was successfully retrieved.
OcaFilterParametric::SetInbandgain (
OcaDB gain )
Level: 4 Index: 8
Sets the in-band gain of the equalizer. The return value indicates whether the gain was successfully set.
OcaFilterParametric::GetShapeParameter (
)
→ (
OcaFloat32 shape, OcaFloat32 minShape, OcaFloat32 maxShape)
Level: 4 Index: 9
Returns the shape parameter of the equalizer. The return value indicates whether the data was successfully retrieved.
OcaFilterParametric::SetShapeParameter (
OcaFloat32 shape )
Level: 4 Index: 10
Sets the shape parameter of the equalizer. The return value indicates whether the parameter was successfully set.
Level: 4 Index: 11
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.