1.1.1.14 OcaDynamics

Class Hirarchy:

OcaRootOcaWorkerOcaActuatorOcaDynamics

class OcaDynamics : OcaActuator

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.

Properties:

OcaClassID ClassID

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 4.1.

OcaClassVersionNumber ClassVersion

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 4.2.

OcaBoolean Triggered

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.

This property has id 4.1.

OcaDB DynamicGain

Current instantaneous gain of dynamics object. Readonly.

This property has id 4.2.

OcaDynamicsFunction Function

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

This property has id 4.3.

OcaFloat32 Ratio

DEPRECATED PROPERTY - please use property Slope 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).

This property has id 4.4.

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.

OcaLevelDetectionLaw DetectorLaw

This property has id 4.7.

OcaTimeInterval AttackTime

Attack time in seconds.

This property has id 4.8.

OcaTimeInterval ReleaseTime

Release time in seconds.

This property has id 4.9.

OcaTimeInterval HoldTime

Hold time in seconds.

This property has id 4.10.

OcaDB DynamicGainCeiling

Upper limit for DynamicGain

This property has id 4.11.

OcaDB DynamicGainFloor

Lower limit for for DynamicGain

This property has id 4.12.

OcaFloat32 KneeParameter

Soft knee parameter. Interpretation is device-dependent.

This property has id 4.13.

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.

Properties inherited from OcaWorker:

Properties inherited from OcaRoot:

Methods:

OcaStatus GetTriggered(OcaBoolean &triggered)

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

This method has id 4.1.

Parameters

OcaBoolean triggered – Output parameter.

OcaStatus GetDynamicGain(OcaDB &Gain)

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

This method has id 4.2.

Parameters

OcaDB Gain – Output parameter.

OcaStatus GetFunction(OcaDynamicsFunction &Func)

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

This method has id 4.3.

Parameters

OcaDynamicsFunction Func – Output parameter.

OcaStatus SetFunction(OcaDynamicsFunction Func)

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

This method has id 4.4.

Parameters

OcaDynamicsFunction Func – Input parameter.

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

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.

This method has id 4.5.

Parameters
  • OcaFloat32 Ratio – Output parameter.

  • OcaFloat32 minRatio – Output parameter.

  • OcaFloat32 maxRatio – Output parameter.

OcaStatus SetRatio(OcaFloat32 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.

This method has id 4.6.

Parameters

OcaFloat32 Ratio – Input parameter.

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

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

This method has id 4.7.

Parameters
  • OcaDBr Threshold – Output parameter.

  • OcaDBz minThreshold – Output parameter.

  • OcaDBz maxThreshold – Output parameter.

OcaStatus SetThreshold(OcaDBr threshold)

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

This method has id 4.8.

Parameters

OcaDBr threshold – Input parameter.

OcaStatus GetThresholdPresentationUnits(OcaPresentationUnit &Units)

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

This method has id 4.9.

Parameters

OcaPresentationUnit Units – Output parameter.

OcaStatus SetThresholdPresentationUnits(OcaPresentationUnit Units)

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

This method has id 4.10.

Parameters

OcaPresentationUnit Units – Input parameter.

OcaStatus GetDetectorLaw(OcaLevelDetectionLaw &Law)

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

This method has id 4.11.

Parameters

OcaLevelDetectionLaw Law – Output parameter.

OcaStatus SetDetectorLaw(OcaLevelDetectionLaw Law)

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

This method has id 4.12.

Parameters

OcaLevelDetectionLaw Law – Input parameter.

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

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

This method has id 4.13.

Parameters
  • OcaTimeInterval Time – Output parameter.

  • OcaTimeInterval minTime – Output parameter.

  • OcaTimeInterval maxTime – Output parameter.

OcaStatus SetAttackTime(OcaTimeInterval Time)

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

This method has id 4.14.

Parameters

OcaTimeInterval Time – Input parameter.

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

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

This method has id 4.15.

Parameters
  • OcaTimeInterval Time – Output parameter.

  • OcaTimeInterval minTime – Output parameter.

  • OcaTimeInterval maxTime – Output parameter.

OcaStatus SetReleaseTime(OcaTimeInterval Time)

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

This method has id 4.16.

Parameters

OcaTimeInterval Time – Input parameter.

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

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

This method has id 4.17.

Parameters
  • OcaTimeInterval Time – Output parameter.

  • OcaTimeInterval minTime – Output parameter.

  • OcaTimeInterval maxTime – Output parameter.

OcaStatus SetHoldTime(OcaTimeInterval Time)

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

This method has id 4.18.

Parameters

OcaTimeInterval Time – Input parameter.

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

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

This method has id 4.19.

Parameters
  • OcaDB Limit – Output parameter.

  • OcaDB minLimit – Output parameter.

  • OcaDB maxLimit – Output parameter.

OcaStatus SetDynamicGainFloor(OcaDB Limit)

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

This method has id 4.20.

Parameters

OcaDB Limit – Input parameter.

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

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

This method has id 4.21.

Parameters
  • OcaDB Limit – Output parameter.

  • OcaDB minLimit – Output parameter.

  • OcaDB maxLimit – Output parameter.

OcaStatus SetDynamicGainCeiling(OcaDB Limit)

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

This method has id 4.22.

Parameters

OcaDB Limit – Input parameter.

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

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

This method has id 4.23.

Parameters
  • OcaFloat32 Parameter – Output parameter.

  • OcaFloat32 minParameter – Output parameter.

  • OcaFloat32 maxParameter – Output parameter.

OcaStatus SetKneeParameter(OcaFloat32 Parameter)

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

This method has id 4.24.

Parameters

OcaFloat32 Parameter – Input parameter.

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

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

This method has id 4.25.

Parameters
  • OcaFloat32 Slope – Output parameter.

  • OcaFloat32 minSlope – Output parameter.

  • OcaFloat32 maxSlope – Output parameter.

OcaStatus SetSlope(OcaFloat32 Slope)

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

This method has id 4.26.

Parameters

OcaFloat32 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 Slope, OcaFloat32 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.

This method has id 4.27.

Parameters
  • OcaParameterMask Mask – Input parameter.

  • OcaDynamicsFunction Function – Input parameter.

  • OcaDBr Threshold – Input parameter.

  • OcaPresentationUnit ThresholdPresentationUnits – Input parameter.

  • OcaLevelDetectionLaw DetectorLaw – Input parameter.

  • OcaTimeInterval AttackTime – Input parameter.

  • OcaTimeInterval ReleaseTime – Input parameter.

  • OcaTimeInterval HoldTime – Input parameter.

  • OcaDB DynamicGainCeiling – Input parameter.

  • OcaDB DynamicGainFloor – Input parameter.

  • OcaFloat32 Slope – Input parameter.

  • OcaFloat32 KneeParameter – Input parameter.

Methods inherited from OcaWorker:

Methods inherited from OcaRoot: