OcaDynamicsDetector

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

Law

OcaLevelDetectionLaw

OcaLevelDetectionLaw

AttackTime

number

OcaTimeInterval

ReleaseTime

number

OcaTimeInterval

HoldTime

number

OcaTimeInterval

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency, Law, AttackTime, ReleaseTime and HoldTime.

class OcaDynamicsDetector(objectNumber, device)

Dynamics element : side-chain detector.

OcaDynamicsDetector.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. Detector attack time in seconds.

OcaDynamicsDetector.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. Detector hold time in seconds.

OcaDynamicsDetector.OnLawChanged

type: PropertyEvent.<OcaLevelDetectionLaw>

This event is emitted when the property Law changes in the remote object. The property Law is described in the AES70 standard as follows. Level detection law: RMS, Peak, possibly others

OcaDynamicsDetector.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. Detector release time in seconds.

OcaDynamicsDetector.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>> –

OcaDynamicsDetector.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>> –

OcaDynamicsDetector.GetLaw()

Gets the value of the Law property. Return status indicates whether the value was successfully retrieved.

Returns

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

OcaDynamicsDetector.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>> –

OcaDynamicsDetector.SetAttackTime(Time)

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

Arguments

  • Time (number) –

Returns

Promise.<void> –

OcaDynamicsDetector.SetHoldTime(Time)

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

Arguments

  • Time (number) –

Returns

Promise.<void> –

OcaDynamicsDetector.SetLaw(Law)

Sets the value of the Law property. Return status indicates whether the value was successfully set.

Arguments
Returns

Promise.<void> –

OcaDynamicsDetector.SetMultiple(Mask, Law, AttackTime, ReleaseTime, HoldTime)

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

  • Law (OcaLevelDetectionLaw) –

  • AttackTime (number) –

  • ReleaseTime (number) –

  • HoldTime (number) –

Returns

Promise.<void> –

OcaDynamicsDetector.SetReleaseTime(Time)

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

Arguments

  • Time (number) –

Returns

Promise.<void> –