OcaFilterParametric

A online version of the AES70 specification of this class can be found at http://docs.deuso.de.

The class is a subclass of OcaActuator().

This class defines the properties

Name

JavaScript Type

AES70 Type

Frequency

number

OcaFrequency

Shape

OcaParametricEQShape

OcaParametricEQShape

WidthParameter

number

OcaFloat32

InbandGain

number

OcaDB

ShapeParameter

number

OcaFloat32

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency, Frequency, Shape, WidthParameter, InbandGain and ShapeParameter.

class OcaFilterParametric(objectNumber, device)

A parametric equalizer section with various shape options.

OcaFilterParametric.OnFrequencyChanged

type: PropertyEvent.<number>

This event is emitted when the property Frequency changes in the remote object. The property Frequency is described in the AES70 standard as follows. The frequency setpoint of the parametric filter.

OcaFilterParametric.OnInbandGainChanged

type: PropertyEvent.<number>

This event is emitted when the property InbandGain changes in the remote object. The property InbandGain is described in the AES70 standard as follows. In-band gain of the parametric filter.

OcaFilterParametric.OnShapeChanged

type: PropertyEvent.<OcaParametricEQShape>

This event is emitted when the property Shape changes in the remote object. The property Shape is described in the AES70 standard as follows. The shape of the parametric filter - peak, shelf, etc.

OcaFilterParametric.OnShapeParameterChanged

type: PropertyEvent.<number>

This event is emitted when the property ShapeParameter changes in the remote object. The property ShapeParameter is described in the AES70 standard as follows. Width parameter. For certain filter types, this parameter may be used to represent extra information about the shape of the transfer function.

OcaFilterParametric.OnWidthParameterChanged

type: PropertyEvent.<number>

This event is emitted when the property WidthParameter changes in the remote object. The property WidthParameter is described in the AES70 standard as follows. Width parameter. For normal parametric implementations, this is the Q of the filter.

OcaFilterParametric.GetFrequency()

Gets the equalizer frequency setpoint. The return value indicates whether the data was successfully retrieved. The return values of this method are

  • Frequency of type number

  • minFrequency of type number

  • maxFrequency of type number

Returns

Promise.<Arguments.<number, number, number>> –

OcaFilterParametric.GetInbandGain()

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

  • gain of type number

  • minGain of type number

  • maxGain of type number

Returns

Promise.<Arguments.<number, number, number>> –

OcaFilterParametric.GetShape()

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

Returns

Promise.<OcaParametricEQShape> – A promise which resolves to a single value of type OcaParametricEQShape().

OcaFilterParametric.GetShapeParameter()

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

  • shape of type number

  • minShape of type number

  • maxShape of type number

Returns

Promise.<Arguments.<number, number, number>> –

OcaFilterParametric.GetWidthParameter()

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

  • Width of type number

  • minWidth of type number

  • maxWidth of type number

Returns

Promise.<Arguments.<number, number, number>> –

OcaFilterParametric.SetFrequency(Frequency)

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

Arguments

  • Frequency (number) –

Returns

Promise.<void> –

OcaFilterParametric.SetInbandGain(gain)

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

Arguments

  • gain (number) –

Returns

Promise.<void> –

OcaFilterParametric.SetMultiple(Mask, Frequency, Shape, WidthParameter, InBandGain, 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.

Arguments

  • Mask (int) –

  • Frequency (number) –

  • Shape (OcaParametricEQShape) –

  • WidthParameter (number) –

  • InBandGain (number) –

  • ShapeParameter (number) –

Returns

Promise.<void> –

OcaFilterParametric.SetShape(type)

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

Arguments
Returns

Promise.<void> –

OcaFilterParametric.SetShapeParameter(shape)

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

Arguments

  • shape (number) –

Returns

Promise.<void> –

OcaFilterParametric.SetWidthParameter(Width)

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

Arguments

  • Width (number) –

Returns

Promise.<void> –