OcaFilterClassical

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

Passband

OcaFilterPassband

OcaFilterPassband

Shape

OcaClassicalFilterShape

OcaClassicalFilterShape

Order

number

OcaUint16

Parameter

number

OcaFloat32

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency, Frequency, Passband, Shape, Order and Parameter.

class OcaFilterClassical(objectNumber, device)

A classical analog-style filter - highpass, lowpass, bandpass, etc., with shape characteristics such as Butterworth, Chebyshev, Bessel, and Linkwitz-Riley. Frequently used in loudspeaker crossover networks.

OcaFilterClassical.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 of the filter.

OcaFilterClassical.OnOrderChanged

type: PropertyEvent.<number>

This event is emitted when the property Order changes in the remote object. The property Order is described in the AES70 standard as follows. Filter order

OcaFilterClassical.OnParameterChanged

type: PropertyEvent.<number>

This event is emitted when the property Parameter changes in the remote object. The property Parameter is described in the AES70 standard as follows. Ripple or other filter parameter, depending on shape. Not used by some shapes.

OcaFilterClassical.OnPassbandChanged

type: PropertyEvent.<OcaFilterPassband>

This event is emitted when the property Passband changes in the remote object. The property Passband is described in the AES70 standard as follows. Lowpass, highpass, bandpass, bandreject

OcaFilterClassical.OnShapeChanged

type: PropertyEvent.<OcaClassicalFilterShape>

This event is emitted when the property Shape changes in the remote object. The property Shape is described in the AES70 standard as follows. Shape family - Butterworth, Bessell, etc.

OcaFilterClassical.GetFrequency()

Gets the value of the Frequency property. The return value indicates if the property 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>> –

OcaFilterClassical.GetOrder()

Returns the order of the filter. The return value indicates if the property was successfully retrieved. The return values of this method are

  • Order of type number

  • minOrder of type number

  • maxOrder of type number

Returns

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

OcaFilterClassical.GetParameter()

Returns the filter parameter. The return value indicates if the property was successfully retrieved. The return values of this method are

  • Parameter of type number

  • minParameter of type number

  • maxParameter of type number

Returns

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

OcaFilterClassical.GetPassband()

Returns the passband specification of the filter object. The return value indicates if the specification was successfully retrieved.

Returns

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

OcaFilterClassical.GetShape()

Returns the Shape property of the filter. The return value indicates if the property was successfully retrieved.

Returns

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

OcaFilterClassical.SetFrequency(frequency)

Sets the value of the Frequency property. The return value indicates if the property was successfully set.

Arguments

  • frequency (number) –

Returns

Promise.<void> –

OcaFilterClassical.SetMultiple(Mask, Frequency, Passband, Shape, Order, Parameter)

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

Promise.<void> –

OcaFilterClassical.SetOrder(Order)

Sets the order of the filter. The return value indicates if the property was successfully set.

Arguments

  • Order (number) –

Returns

Promise.<void> –

OcaFilterClassical.SetParameter(Parameter)

Sets the filter parameter. The return value indicates if the parameter was successfully set.

Arguments

  • Parameter (number) –

Returns

Promise.<void> –

OcaFilterClassical.SetPassband(Passband)

Sets the passband specification of the filter object. The return value indicates if the specification was successfully set.

Arguments
Returns

Promise.<void> –

OcaFilterClassical.SetShape(Shape)

Sets the Shape property of the filter. The return value indicates if the property was successfully set.

Arguments
Returns

Promise.<void> –