template<class Class>
OcaDynamics class
Template parameters | |
---|---|
Class | - Class to wrap. |
Contents
This class template detects the methods and events defined for the class OcaDynamics in the AES70 specification and exposes them through AES70. Note that all AES70 methods and event handlers need to be public in order to be detected.
Detects the following symbols with the corresponding detector classes:
GetTriggered : aes70::
device:: Getter Return values:
- triggered : OcaBoolean
GetDynamicGain : aes70::
device:: Getter Return values:
- Gain : OcaFloat32
GetFunction : aes70::
device:: Getter Return values:
- Func : OcaDynamicsFunction
SetFunction : aes70::
device:: Setter Arguments:
- Func : OcaDynamicsFunction
GetRatio : aes70::
device:: Getter Return values:
- Ratio : OcaFloat32
- minRatio : OcaFloat32
- maxRatio : OcaFloat32
SetRatio : aes70::
device:: Setter Arguments:
- Ratio : OcaFloat32
GetThreshold : aes70::
device:: Getter Return values:
- Threshold : OcaDBr
- minThreshold : OcaFloat32
- maxThreshold : OcaFloat32
SetThreshold : aes70::
device:: Setter Arguments:
- threshold : OcaDBr
GetThresholdPresentationUnits : aes70::
device:: Getter Return values:
- Units : OcaPresentationUnit
SetThresholdPresentationUnits : aes70::
device:: Setter Arguments:
- Units : OcaPresentationUnit
GetDetectorLaw : aes70::
device:: Getter Return values:
- Law : OcaLevelDetectionLaw
SetDetectorLaw : aes70::
device:: Setter Arguments:
- Law : OcaLevelDetectionLaw
GetAttackTime : aes70::
device:: Getter Return values:
- Time : OcaFloat32
- minTime : OcaFloat32
- maxTime : OcaFloat32
SetAttackTime : aes70::
device:: Setter Arguments:
- Time : OcaFloat32
GetReleaseTime : aes70::
device:: Getter Return values:
- Time : OcaFloat32
- minTime : OcaFloat32
- maxTime : OcaFloat32
SetReleaseTime : aes70::
device:: Setter Arguments:
- Time : OcaFloat32
GetHoldTime : aes70::
device:: Getter Return values:
- Time : OcaFloat32
- minTime : OcaFloat32
- maxTime : OcaFloat32
SetHoldTime : aes70::
device:: Setter Arguments:
- Time : OcaFloat32
GetDynamicGainFloor : aes70::
device:: Getter Return values:
- Limit : OcaFloat32
- minLimit : OcaFloat32
- maxLimit : OcaFloat32
SetDynamicGainFloor : aes70::
device:: Setter Arguments:
- Limit : OcaFloat32
GetDynamicGainCeiling : aes70::
device:: Getter Return values:
- Limit : OcaFloat32
- minLimit : OcaFloat32
- maxLimit : OcaFloat32
SetDynamicGainCeiling : aes70::
device:: Setter Arguments:
- Limit : OcaFloat32
GetKneeParameter : aes70::
device:: Getter Return values:
- Parameter : OcaFloat32
- minParameter : OcaFloat32
- maxParameter : OcaFloat32
SetKneeParameter : aes70::
device:: Setter Arguments:
- Parameter : OcaFloat32
GetSlope : aes70::
device:: Getter Return values:
- Slope : OcaFloat32
- minSlope : OcaFloat32
- maxSlope : OcaFloat32
SetSlope : aes70::
device:: Setter Arguments:
- Slope : OcaFloat32
SetMultiple : aes70::
device:: Method Arguments:
- Mask : OcaBitSet16
- Function : OcaDynamicsFunction
- Threshold : OcaDBr
- ThresholdPresentationUnits : OcaPresentationUnit
- DetectorLaw : OcaLevelDetectionLaw
- AttackTime : OcaFloat32
- ReleaseTime : OcaFloat32
- HoldTime : OcaFloat32
- DynamicGainCeiling : OcaFloat32
- DynamicGainFloor : OcaFloat32
- Slope : OcaFloat32
- KneeParameter : OcaFloat32
Detects the following event handlers for property changes (of type aes70::
- OnTriggeredChanged with property encoder OCP1::
OcaBoolean - OnDynamicGainChanged with property encoder OCP1::
OcaFloat32 - OnFunctionChanged with property encoder OCP1::
OcaUint8 - OnRatioChanged with property encoder OCP1::
OcaFloat32 - OnThresholdChanged with property encoder OCP1::Struct<OCP1::OcaFloat32, OCP1::OcaFloat32>
- OnThresholdPresentationUnitsChanged with property encoder OCP1::
OcaUint8 - OnDetectorLawChanged with property encoder OCP1::
OcaUint8 - OnAttackTimeChanged with property encoder OCP1::
OcaFloat32 - OnReleaseTimeChanged with property encoder OCP1::
OcaFloat32 - OnHoldTimeChanged with property encoder OCP1::
OcaFloat32 - OnDynamicGainCeilingChanged with property encoder OCP1::
OcaFloat32 - OnDynamicGainFloorChanged with property encoder OCP1::
OcaFloat32 - OnKneeParameterChanged with property encoder OCP1::
OcaFloat32 - OnSlopeChanged with property encoder OCP1::
OcaFloat32
From the AES70 standard:
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.
Base classes
-
template<class Class>class OcaActuator
Public static variables
- static const OcaClassVersionNumber ClassVersion
-
static const classid_
tpl<4> ClassId - static const size_t count_events
Public static functions
- static auto get_event_index(OcaEventID id, size_t index) -> AES70_ALWAYS_INLINE ptrdiff_t
Constructors, destructors, conversion operators
-
template<typename ... TN>OcaDynamics(TN && ... args)
Public functions
- auto get_class_version() const -> uint16_t virtual
- auto get_classid() const -> const classid& virtual
-
void init(aes70::
device:: device* d, uint32_t n) virtual -
auto call(const OcaMethodID id,
const uint8_t* src,
const uint8_t* src_end,
uint8_t parameterCount,
const aes70::
response_generator& response) -> bool virtual - auto get_event_index(const OcaEventID OcaEventID) const -> ptrdiff_t virtual
Function documentation
template<classClass>
static AES70_ALWAYS_INLINE ptrdiff_t aes70:: device:: OcaDynamics<Class>:: get_event_index(OcaEventID id,
size_t index)
Internal class for finding the event index of a given EventID. Returns -1 if the given event is not defined.
template<classClass>
template<typename ... TN>
aes70:: device:: OcaDynamics<Class>:: OcaDynamics(TN && ... args)
Constructor which calls the constructor of Class with args forwarded.
template<classClass>
uint16_t aes70:: device:: OcaDynamics<Class>:: get_class_version() const virtual
Returns the AES70 class version of this object.
template<classClass>
const classid& aes70:: device:: OcaDynamics<Class>:: get_classid() const virtual
Returns the AES70 class id of this object.
template<classClass>
void aes70:: device:: OcaDynamics<Class>:: init(aes70:: device:: device* d,
uint32_t n) virtual
Called when this object is added to a device.
template<classClass>
bool aes70:: device:: OcaDynamics<Class>:: call(const OcaMethodID id,
const uint8_t* src,
const uint8_t* src_end,
uint8_t parameterCount,
const aes70:: response_generator& response) virtual
Internal method used to call AES70 methods in this object.
template<classClass>
ptrdiff_t aes70:: device:: OcaDynamics<Class>:: get_event_index(const OcaEventID OcaEventID) const virtual
Returns the index of a given event. The idea is that all events defined on a aes70 class can be enumerated. For events which this object does not implement, the value -1 is returned.
Variable documentation
template<classClass>
static const OcaClassVersionNumber aes70:: device:: OcaDynamics<Class>:: ClassVersion
The ClassVersion of this class according to the AES70 standard.
template<classClass>
static const classid_ tpl<4> aes70:: device:: OcaDynamics<Class>:: ClassId
The ClassID of this class according to the AES70 standard.
template<classClass>
static const size_t aes70:: device:: OcaDynamics<Class>:: count_events
Number of events defined in this class. This depends on which events are implemented by Class.