OcaFilterFIR

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

Length

number

OcaUint32

Coefficients

number[]

OcaList<OcaFloat32>

SampleRate

number

OcaFrequency

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency, Length, Coefficients and SampleRate.

class OcaFilterFIR(objectNumber, device)

A finite impulse response (FIR) filter.

OcaFilterFIR.OnCoefficientsChanged

type: PropertyEvent.<Array.<number>>

This event is emitted when the property Coefficients changes in the remote object. The property Coefficients is described in the AES70 standard as follows. Array of FIR Coefficients. The size of the array (number of entries) is equal to the Order property plus 1.

OcaFilterFIR.OnSampleRateChanged

type: PropertyEvent.<number>

This event is emitted when the property SampleRate changes in the remote object. The property SampleRate is described in the AES70 standard as follows. Sample rate inside the filter. We can’t assume it’s the same as the device input or output rate.

OcaFilterFIR.GetCoefficients()

Gets the coefficients of the FIR filter. The return value indicates whether the coefficients were successfully retrieved.

Returns

Promise.<Array.<number>> – A promise which resolves to a single value of type number[].

OcaFilterFIR.GetLength()

Gets the length of the FIR filter. The return value indicates whether the value was successfully retrieved. The return values of this method are

  • Length of type number

  • minLength of type number

  • maxLength of type number

Returns

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

OcaFilterFIR.GetSampleRate()

Gets the sample rate of the FIR filter. The return value indicates whether the data was successfully retrieved. The return values of this method are

  • Rate of type number

  • minRate of type number

  • maxRate of type number

Returns

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

OcaFilterFIR.SetCoefficients(Coefficients)

Sets the value of the properties of the FIR filter. The return value indicates whether the properties were successfully set.

Arguments

  • Coefficients (Array.<number>) –

Returns

Promise.<void> –

OcaFilterFIR.SetSampleRate(Rate)

Sets the sample rate of the FIR filter. The return value indicates whether the rate was successfully set.

Arguments

  • Rate (number) –

Returns

Promise.<void> –