OcaFilterArbitraryCurve¶
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 |
---|---|---|
TransferFunction |
OcaTransferFunction |
OcaTransferFunction |
SampleRate |
number |
OcaFrequency |
TFMinLength |
number |
OcaUint16 |
TFMaxLength |
number |
OcaUint16 |
Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency, TransferFunction, SampleRate, TFMinLength and TFMaxLength.
-
class
OcaFilterArbitraryCurve
(objectNumber, device)¶ An arbitrary-curve filter, with transfer function specified as amplitude and phase versus frequency.
-
OcaFilterArbitraryCurve.
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.
-
OcaFilterArbitraryCurve.
OnTFMaxLengthChanged
¶ type: PropertyEvent.<number>
This event is emitted when the property TFMaxLength changes in the remote object. The property
TFMaxLength
is described in the AES70 standard as follows. Maximum number of points that transfer function may specify
-
OcaFilterArbitraryCurve.
OnTFMinLengthChanged
¶ type: PropertyEvent.<number>
This event is emitted when the property TFMinLength changes in the remote object. The property
TFMinLength
is described in the AES70 standard as follows. Minimum number of points that transfer function must specify
-
OcaFilterArbitraryCurve.
OnTransferFunctionChanged
¶ type: PropertyEvent.<OcaTransferFunction>
This event is emitted when the property TransferFunction changes in the remote object. The property
TransferFunction
is described in the AES70 standard as follows. Transfer function of the filter.
-
OcaFilterArbitraryCurve.
GetSampleRate
()¶ Gets the filter sampling rate. 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>> –
-
OcaFilterArbitraryCurve.
GetTFMaxLength
()¶ Returns the maximum number of allowed points in the specified transfer function.
- Returns
Promise.<number> – A promise which resolves to a single value of type
number
.
-
OcaFilterArbitraryCurve.
GetTFMinLength
()¶ Returns the minimum number of required points in the specified transfer function.
- Returns
Promise.<number> – A promise which resolves to a single value of type
number
.
-
OcaFilterArbitraryCurve.
GetTransferFunction
()¶ Returns the complex transfer function.
- Returns
Promise.<OcaTransferFunction> – A promise which resolves to a single value of type
OcaTransferFunction()
.
-
OcaFilterArbitraryCurve.
SetSampleRate
(Rate)¶ Sets the filter sampling rate.
- Arguments
Rate (number) –
- Returns
Promise.<void> –
-
OcaFilterArbitraryCurve.
SetTransferFunction
(TransferFunction)¶ Sets the complex transfer function.
- Arguments
TransferFunction (OcaTransferFunction) –
- Returns
Promise.<void> –
-