OcaDynamics

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

Triggered

boolean

OcaBoolean

DynamicGain

number

OcaDB

Function

OcaDynamicsFunction

OcaDynamicsFunction

Ratio

number

OcaFloat32

Threshold

OcaDBr

OcaDBr

ThresholdPresentationUnits

OcaPresentationUnit

OcaPresentationUnit

DetectorLaw

OcaLevelDetectionLaw

OcaLevelDetectionLaw

AttackTime

number

OcaTimeInterval

ReleaseTime

number

OcaTimeInterval

HoldTime

number

OcaTimeInterval

DynamicGainCeiling

number

OcaDB

DynamicGainFloor

number

OcaDB

KneeParameter

number

OcaFloat32

Slope

number

OcaFloat32

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency, Triggered, DynamicGain, Function, Ratio, Threshold, ThresholdPresentationUnits, DetectorLaw, AttackTime, ReleaseTime, HoldTime, DynamicGainCeiling, DynamicGainFloor, KneeParameter and Slope.

class OcaDynamics(objectNumber, device)

A multipurpose dynamics processor. Can be configured as compressor, limiter, expander, or gate. This class is expected to handle the majority of the basic cases. More complex devices may be described in a different manner, using one or more OcaDynamicsDetector and OcaDynamicsCurve objects, in conjunction with other Worker objects as needed.

OcaDynamics.OnAttackTimeChanged

type: PropertyEvent.<number>

This event is emitted when the property AttackTime changes in the remote object. The property AttackTime is described in the AES70 standard as follows. Attack time in seconds.

OcaDynamics.OnDetectorLawChanged

type: PropertyEvent.<OcaLevelDetectionLaw>

This event is emitted when the property DetectorLaw changes in the remote object.

OcaDynamics.OnDynamicGainCeilingChanged

type: PropertyEvent.<number>

This event is emitted when the property DynamicGainCeiling changes in the remote object. The property DynamicGainCeiling is described in the AES70 standard as follows. Upper limit for DynamicGain

OcaDynamics.OnDynamicGainChanged

type: PropertyEvent.<number>

This event is emitted when the property DynamicGain changes in the remote object. The property DynamicGain is described in the AES70 standard as follows. Current instantaneous gain of dynamics object. Readonly.

OcaDynamics.OnDynamicGainFloorChanged

type: PropertyEvent.<number>

This event is emitted when the property DynamicGainFloor changes in the remote object. The property DynamicGainFloor is described in the AES70 standard as follows. Lower limit for for DynamicGain

OcaDynamics.OnFunctionChanged

type: PropertyEvent.<OcaDynamicsFunction>

This event is emitted when the property Function changes in the remote object. The property Function is described in the AES70 standard as follows. Dynamics element function - compressor, limiter, expander, etc.

OcaDynamics.OnHoldTimeChanged

type: PropertyEvent.<number>

This event is emitted when the property HoldTime changes in the remote object. The property HoldTime is described in the AES70 standard as follows. Hold time in seconds.

OcaDynamics.OnKneeParameterChanged

type: PropertyEvent.<number>

This event is emitted when the property KneeParameter changes in the remote object. The property KneeParameter is described in the AES70 standard as follows. Soft knee parameter. Interpretation is device-dependent.

OcaDynamics.OnRatioChanged

type: PropertyEvent.<number>

This event is emitted when the property Ratio changes in the remote object. The property Ratio is described in the AES70 standard as follows. DEPRECATED PROPERTY - please use property <b>Slope </b>instead. Compression or expansion ratio. For Function = Compress or Limit, value is d(input amplitude)/d(output amplitude). For Function = Expand or Gate, value is d(output amplitude)/d(input amplitude).

OcaDynamics.OnReleaseTimeChanged

type: PropertyEvent.<number>

This event is emitted when the property ReleaseTime changes in the remote object. The property ReleaseTime is described in the AES70 standard as follows. Release time in seconds.

OcaDynamics.OnSlopeChanged

type: PropertyEvent.<number>

This event is emitted when the property Slope changes in the remote object. The property Slope is described in the AES70 standard as follows. Slope of transfer function = d(output amplitude) / d(input amplitude). See notes for class OcaDynamicsCurve for further detail. Note that the definition of this value does not depend on the value of property Function.

OcaDynamics.OnThresholdChanged

type: PropertyEvent.<OcaDBr>

This event is emitted when the property Threshold changes in the remote object. The property Threshold is described in the AES70 standard as follows. Compression or expansion threshold.

OcaDynamics.OnThresholdPresentationUnitsChanged

type: PropertyEvent.<OcaPresentationUnit>

This event is emitted when the property ThresholdPresentationUnits changes in the remote object. The property ThresholdPresentationUnits is described in the AES70 standard as follows. Compression or expansion threshold presentation units.

OcaDynamics.OnTriggeredChanged

type: PropertyEvent.<boolean>

This event is emitted when the property Triggered changes in the remote object. The property Triggered is described in the AES70 standard as follows. Read-only property that indicates whether the dynamics processor is currently triggered (i.e. the signal level is above upper threshold or below lower threshold). This property can be monitored via a periodic event subscription.

OcaDynamics.GetAttackTime()

Gets the value of the AttackTime property. The return value indicates if the value was successfully retrieved. The return values of this method are

  • Time of type number

  • minTime of type number

  • maxTime of type number

Returns

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

OcaDynamics.GetDetectorLaw()

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

Returns

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

OcaDynamics.GetDynamicGain()

Gets the value of the DynamicGain property. The return value indicates whether the property was successfully retrieved.

Returns

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

OcaDynamics.GetDynamicGainCeiling()

Gets the value of the DynamicGainCeiling property. The return value indicates if the value was successfully retrieved. The return values of this method are

  • Limit of type number

  • minLimit of type number

  • maxLimit of type number

Returns

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

OcaDynamics.GetDynamicGainFloor()

Gets the value of the DynamicGainFLoor property. The return value indicates if the value was successfully retrieved. The return values of this method are

  • Limit of type number

  • minLimit of type number

  • maxLimit of type number

Returns

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

OcaDynamics.GetFunction()

Sets the value of the Function property. The return value indicates whether the property was successfully retrieved.

Returns

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

OcaDynamics.GetHoldTime()

Gets the value of the HoldTime property. The return value indicates if the value was successfully retrieved. The return values of this method are

  • Time of type number

  • minTime of type number

  • maxTime of type number

Returns

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

OcaDynamics.GetKneeParameter()

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

OcaDynamics.GetRatio()

Gets the value of the Ratio property. The return value indicates whether the property was successfully retrieved. GetRatio() is a DEPRECATED method. Please use GetSlope() instead. The return values of this method are

  • Ratio of type number

  • minRatio of type number

  • maxRatio of type number

Returns

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

OcaDynamics.GetReleaseTime()

Gets the value of the ReleaseTime property. The return value indicates if the value was successfully retrieved. The return values of this method are

  • Time of type number

  • minTime of type number

  • maxTime of type number

Returns

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

OcaDynamics.GetSlope()

Gets the value of the Slope property. The return value indicates whether the property was successfully retrieved. The return values of this method are

  • Slope of type number

  • minSlope of type number

  • maxSlope of type number

Returns

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

OcaDynamics.GetThreshold()

Gets the value of the Threshold property. The return value indicates if the value was successfully retrieved. The return values of this method are

  • Threshold of type OcaDBr()

  • minThreshold of type number

  • maxThreshold of type number

Returns

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

OcaDynamics.GetThresholdPresentationUnits()

Gets the value of the ThresholdPresentationUnits property. The return value indicates if the value was successfully retrieved.

Returns

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

OcaDynamics.GetTriggered()

Gets the value of the Triggered property. The return value indicates whether the property was successfully retrieved.

Returns

Promise.<boolean> – A promise which resolves to a single value of type boolean.

OcaDynamics.SetAttackTime(Time)

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

Arguments

  • Time (number) –

Returns

Promise.<void> –

OcaDynamics.SetDetectorLaw(Law)

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

Arguments
Returns

Promise.<void> –

OcaDynamics.SetDynamicGainCeiling(Limit)

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

Arguments

  • Limit (number) –

Returns

Promise.<void> –

OcaDynamics.SetDynamicGainFloor(Limit)

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

Arguments

  • Limit (number) –

Returns

Promise.<void> –

OcaDynamics.SetFunction(Func)

Sets the value of the Function property. The return value indicates whether the property was successfully set.

Arguments
Returns

Promise.<void> –

OcaDynamics.SetHoldTime(Time)

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

Arguments

  • Time (number) –

Returns

Promise.<void> –

OcaDynamics.SetKneeParameter(Parameter)

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

Arguments

  • Parameter (number) –

Returns

Promise.<void> –

OcaDynamics.SetMultiple(Mask, Function, Threshold, ThresholdPresentationUnits, DetectorLaw, AttackTime, ReleaseTime, HoldTime, DynamicGainCeiling, DynamicGainFloor, Slope, KneeParameter)

Sets some or all dynamics 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) –

  • Function (OcaDynamicsFunction) –

  • Threshold (OcaDBr) –

  • ThresholdPresentationUnits (OcaPresentationUnit) –

  • DetectorLaw (OcaLevelDetectionLaw) –

  • AttackTime (number) –

  • ReleaseTime (number) –

  • HoldTime (number) –

  • DynamicGainCeiling (number) –

  • DynamicGainFloor (number) –

  • Slope (number) –

  • KneeParameter (number) –

Returns

Promise.<void> –

OcaDynamics.SetRatio(Ratio)

Sets the value of the Ratio property. The return value indicates whether the property was successfully set. SetRatio() is a DEPRECATED method. Please use SetSlope() instead.

Arguments

  • Ratio (number) –

Returns

Promise.<void> –

OcaDynamics.SetReleaseTime(Time)

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

Arguments

  • Time (number) –

Returns

Promise.<void> –

OcaDynamics.SetSlope(Slope)

Sets the value of the Slope property. The return value indicates whether the property was successfully set.

Arguments

  • Slope (number) –

Returns

Promise.<void> –

OcaDynamics.SetThreshold(threshold)

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

Arguments
Returns

Promise.<void> –

OcaDynamics.SetThresholdPresentationUnits(Units)

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

Arguments
Returns

Promise.<void> –