1.1.1.14 OcaDynamics

Class Hierarchy:

OcaRoot : OcaWorker : OcaActuator : OcaDynamics

class OcaDynamics : OcaActuator

Multipurpose dynamics processor. Can be configured as compressor, limiter, expander, or gate. This class is designed 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.

Properties:

OcaTimeInterval AttackTime

Attack time in seconds.

This property has id 4.8.

static const OcaClassID ClassID = "1.1.1.14"

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the OcaRoot property.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 3

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

This property has id 1.2.

OcaLevelDetectionLaw DetectorLaw

Level detection law - peak, RMS, etc

This property has id 4.7.

OcaDB DynamicGain

Current instantaneous gain of dynamics object. Readonly.

This property has id 4.2.

OcaDB DynamicGainCeiling

Upper limit for value of DynamicGain

This property has id 4.11.

OcaDB DynamicGainFloor

Lower limit for for value of DynamicGain

This property has id 4.12.

OcaDynamicsFunction Function

Dynamics element function - compressor, limiter, expander, etc.

This property has id 4.3.

OcaTimeInterval HoldTime

Hold time in seconds.

This property has id 4.10.

OcaFloat32 KneeParameter

Soft knee parameter. Interpretation shall be device-dependent.

This property has id 4.13.

OcaFloat32 Ratio

DEPRECATED PROPERTY - please use property Slope instead. Compression or expansion ratio. For Function = Compress or Limit, value shall be d(input amplitude)/d(output amplitude). For Function = Expand or Gate, value shall be d(output amplitude)/d(input amplitude).

This property has id 4.4.

OcaTimeInterval ReleaseTime

Release time in seconds.

This property has id 4.9.

OcaFloat32 Slope

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.

This property has id 4.14.

OcaDBr Threshold

Compression or expansion threshold.

This property has id 4.5.

OcaPresentationUnit ThresholdPresentationUnits

Compression or expansion threshold presentation units.

This property has id 4.6.

OcaBoolean Triggered

Read-only property that shall indicate whether the dynamics processor is currently triggered (i.e. the signal level is above upper threshold or below lower threshold).

This property has id 4.1.

Properties inherited from 1.1.1 OcaActuator:

Methods:

OcaStatus GetTriggered(OcaBoolean &triggered)

Gets the value of the Triggered property.

This method has id 4.1.

OcaStatus GetDynamicGain(OcaDB &Gain)

Gets the value of the DynamicGain property.

This method has id 4.2.

  • Gain: Output parameter.

OcaStatus GetFunction(OcaDynamicsFunction &Func)

Sets the value of the Function property.

This method has id 4.3.

  • Func: Output parameter.

OcaStatus SetFunction(OcaDynamicsFunction Func)

Sets the value of the Function property.

This method has id 4.4.

  • Func: Input parameter.

OcaStatus GetRatio(OcaFloat32 &Ratio, OcaFloat32 &minRatio, OcaFloat32 &maxRatio)

Gets the value and limits of the Ratio property. DEPRECATED method, please use GetSlope() instead.

This method has id 4.5.

OcaStatus SetRatio(OcaFloat32 Ratio)

Sets the value of the Ratio property. DEPRECATED method, please use SetSlope() instead.

This method has id 4.6.

  • Ratio: Input parameter.

OcaStatus GetThreshold(OcaDBr &Threshold, OcaDBz &minThreshold, OcaDBz &maxThreshold)

Gets the value and limits of the Threshold property.

This method has id 4.7.

OcaStatus SetThreshold(OcaDBr threshold)

Sets the value of the Threshold property.

This method has id 4.8.

OcaStatus GetThresholdPresentationUnits(OcaPresentationUnit &Units)

Gets the value of the ThresholdPresentationUnits property.

This method has id 4.9.

  • Units: Output parameter.

OcaStatus SetThresholdPresentationUnits(OcaPresentationUnit Units)

Sets the value of the ThresholdPresentationUnits property.

This method has id 4.10.

  • Units: Input parameter.

OcaStatus GetDetectorLaw(OcaLevelDetectionLaw &Law)

Sets the value of the DetectorLaw property.

This method has id 4.11.

  • Law: Output parameter.

OcaStatus SetDetectorLaw(OcaLevelDetectionLaw Law)

Sets the value of the DetectorLaw property.

This method has id 4.12.

  • Law: Input parameter.

OcaStatus GetAttackTime(OcaTimeInterval &Time, OcaTimeInterval &minTime, OcaTimeInterval &maxTime)

Gets the value and limits of the AttackTime property.

This method has id 4.13.

OcaStatus SetAttackTime(OcaTimeInterval Time)

Sets the value of the AttackTime property.

This method has id 4.14.

  • Time: Input parameter.

OcaStatus GetReleaseTime(OcaTimeInterval &Time, OcaTimeInterval &minTime, OcaTimeInterval &maxTime)

Gets the value and limits of the ReleaseTime property.

This method has id 4.15.

OcaStatus SetReleaseTime(OcaTimeInterval Time)

Sets the value of the ReleaseTime property.

This method has id 4.16.

  • Time: Input parameter.

OcaStatus GetHoldTime(OcaTimeInterval &Time, OcaTimeInterval &minTime, OcaTimeInterval &maxTime)

Gets the value and limits of the HoldTime property.

This method has id 4.17.

OcaStatus SetHoldTime(OcaTimeInterval Time)

Sets the value of the HoldTime property.

This method has id 4.18.

  • Time: Input parameter.

OcaStatus GetDynamicGainFloor(OcaDB &Limit, OcaDB &minLimit, OcaDB &maxLimit)

Gets the value and limits of the DynamicGainFloor property.

This method has id 4.19.

OcaStatus SetDynamicGainFloor(OcaDB Limit)

Sets the value of the DynamicGainFloor property.

This method has id 4.20.

  • Limit: Input parameter.

OcaStatus GetDynamicGainCeiling(OcaDB &Limit, OcaDB &minLimit, OcaDB &maxLimit)

Gets the value and limits of the DynamicGainCeiling property.

This method has id 4.21.

OcaStatus SetDynamicGainCeiling(OcaDB Limit)

Value to which the DynamicGainCeiling property shall be set if the method succeeds

This method has id 4.22.

  • Limit: Input parameter.

OcaStatus GetKneeParameter(OcaFloat32 &Parameter, OcaFloat32 &minParameter, OcaFloat32 &maxParameter)

Gets the value and limits of the KneeParameter property.

This method has id 4.23.

OcaStatus SetKneeParameter(OcaFloat32 Parameter)

Sets the value of the KneeParameter property.

This method has id 4.24.

OcaStatus GetSlope(OcaFloat32 &Slope, OcaFloat32 &minSlope, OcaFloat32 &maxSlope)

Gets the value and limits of the Slope property.

This method has id 4.25.

OcaStatus SetSlope(OcaFloat32 Slope)

Sets the value of the Slope property.

This method has id 4.26.

  • Slope: Input parameter.

OcaStatus SetMultiple(OcaParameterMask Mask, OcaDynamicsFunction Function, OcaDBr Threshold, OcaPresentationUnit ThresholdPresentationUnits, OcaLevelDetectionLaw DetectorLaw, OcaTimeInterval AttackTime, OcaTimeInterval ReleaseTime, OcaTimeInterval HoldTime, OcaDB DynamicGainCeiling, OcaDB DynamicGainFloor, OcaFloat32 KneeParameter, OcaFloat32 Slope)

Sets some or all dynamics parameters. The action of this method shall be atomic - if any of the value changes fails, none of the changes shall be made.

This method has id 4.27.

Methods inherited from 1.1.1 OcaActuator: