Worker Datatypes

OcaDB

using OcaDB = OcaFloat32: A ratio expressed in dB. Typically used for gain settings.

OcaDBr

struct OcaDBr

An absolute level expressed in dB above the given absolute reference level.

OcaDB Value: Absolute level in decibels relative to value of Ref property.

OcaDBz Ref: Reference level in dBz. See the definition of OcaDBz for an explanation of the dBz unit.

OcaDBV

using OcaDBV = OcaDB: An absolute analogue level expressed in dB re 1 volt. This datatype may only be used for parameters that reflect analogue signal values, e.g. pre-ADC input signals and post-DAC output signals.

OcaDBu

using OcaDBu = OcaDB: An absolute analogue level expressed in dB re 0.774 volts. This datatype may only be used for parameters that reflect analogue signal values, e.g. pre-ADC input signals and post-DAC output signals.

OcaDBFS

using OcaDBFS = OcaDB: An absolute level value for digital signals, expressed in dB relative to the device maximum internal digital sample value. For example, a digital signal whose peak sample value is 7dB below the maximum digital sample value shall be said to have a peak level of -7 dBFS.

OcaDBz

using OcaDBz = OcaDB: An absolute level expressed in dB relative to the nominal device operating level. The nominal device operating level is a device-specific signal level chosen as a normal or typical signal amplitude for the device.

OcaVoltage

using OcaVoltage = OcaFloat32: Voltage in volts.

OcaCurrent

using OcaCurrent = OcaFloat32: Current in amperes

OcaImpedance

struct OcaImpedance

Complex impedance. Expressed as a magnitude and phase.

OcaFloat32 Magnitude: Impedance magnitude in ohms.

OcaFloat32 Phase: Impedance phase in radians.

OcaMuteState

enum OcaMuteState : uint8_t

Mute states

enumerator Muted = 1

enumerator Unmuted = 2

OcaPolarityState

enum OcaPolarityState : uint8_t

Polarity states

enumerator NonInverted = 1

enumerator Inverted = 2

OcaDelayUnit

enum OcaDelayUnit : uint8_t

Enumeration of types of delay units that are available in OCA.

enumerator Time = 1: Time

enumerator Distance = 2: Distance

enumerator Samples = 3: Samples

enumerator Microseconds = 4: Samples

enumerator Milliseconds = 5: Samples

enumerator Centimeters = 6: Samples

enumerator Inches = 7: Samples

enumerator Feet = 8: Samples

OcaDelayValue

struct OcaDelayValue

Multifield descriptor that defines a delay value element.

OcaFloat32 DelayValue: The delay value.

OcaDelayUnit DelayUnit: The unit of the delay value.

OcaFrequency

using OcaFrequency = OcaFloat32: Strong datatype for frequency in Hertz.

OcaFrequencyResponse

using OcaFrequencyResponse = OcaMap<OcaFrequency, OcaDB>: Strong datatype for frequency response.

OcaTransferFunction

struct OcaTransferFunction

A complex (i.e. magnitude + phase) transfer function.

OcaList<OcaFrequency> Frequency: Frequencies

OcaList<OcaFloat32> Amplitude: Amplitude (not in dB)

OcaList<OcaFloat32> Phase: Phase in radians.

OcaPeriod

using OcaPeriod = OcaUint32: General-purpose period of time in milliseconds. As this type is mostly used for management purposes an integer base type is used and it is expressed in milliseconds.

OcaClassicalFilterShape

enum OcaClassicalFilterShape : uint8_t

Enumeration of classicalr filter types that can be used by OCA objects.

enumerator Butterworth = 1: Butterworth

enumerator Bessel = 2: Bessel

enumerator Chebyshev = 3: Linkwitz-Riley

enumerator LinkwitzRiley = 4: Linkwitz-Riley

OcaFilterPassband

enum OcaFilterPassband : uint8_t

Enumeration of passband types that can be used by OCA objects.

enumerator HiPass = 1: High pass

enumerator LowPass = 2: Low pass

enumerator BandPass = 3: All pass

enumerator BandReject = 4: All pass

enumerator AllPass = 5: All pass

OcaParametricEQShape

enum OcaParametricEQShape : uint8_t

Enumeration of curve shapes used by OcaFilterParametric.

enumerator None = 0: No filter (i.e. flat frequency response)

enumerator PEQ = 1: PEQ

enumerator LowShelv = 2: Low Shelv

enumerator HighShelv = 3: High Shelv

enumerator LowPass = 4: Low Pass

enumerator HighPass = 5: High Pass

enumerator BandPass = 6: Band Pass

enumerator AllPass = 7: All Pass

enumerator Notch = 8: Notch

enumerator ToneControlLowFixed = 9: Notch

enumerator ToneControlLowSliding = 10: Notch

enumerator ToneControlHighFixed = 11: Notch

enumerator ToneControlHighSliding = 12: Notch

OcaDynamicsFunction

enum OcaDynamicsFunction : uint8_t

Enumeration of the types of dynamics functions available from class OcaDynamics.

enumerator None = 0: No dynamic function.

enumerator Compress = 1: Upward compress function (reduce gain when input is above the given threshold).

enumerator Limit = 2: Limit function (compress with a fixed ratio of 10:1 or greater).

enumerator Expand = 3: Downward expand function (decrease gain when input is below the given threshhold).

enumerator Gate = 4: Gate function (expand with fixed ‘infinite’ downward expansion ratio).

OcaPilotToneDetectorSpec

struct OcaPilotToneDetectorSpec

Multifield descriptor for a pilot tone detector element.

OcaDBr Threshold: Tone level threshold in dB.

OcaFrequency Frequency: Frequency of the measured tone (in Hz).

OcaPeriod PollInterval: Poll interval in milliseconds.

OcaWaveformType

enum OcaWaveformType : uint8_t

Enumeration of waveform types that can be used by OCA objects.

enumerator None = 0: No signal.

enumerator DC = 1: Direct current.

enumerator Sine = 2: Sine wave.

enumerator Square = 3: Square wave.

enumerator Impulse = 4: Impulse waveform.

enumerator NoisePink = 5: Pink noise waveform.

enumerator NoiseWhite = 6: White noise waveform.

enumerator PolarityTest = 7: Polarity test waveform (asymmetrical).

OcaSweepType

enum OcaSweepType : uint8_t

Enumeration of waveform types that can be used by OCA objects.

enumerator Linear = 1: Linear sweep.

enumerator Logarithmic = 2: Logarithmic sweep.

enumerator None = 0: No sweep.

OcaUnitOfMeasure

enum OcaUnitOfMeasure : uint8_t

Enumeration of units of measure that can be used in OCA classes. Only SI (base or derived) units are specified, so that internal calculations will not need to convert. If conversion is needed it should only be done in user interfaces. The datatype of a reading expressed in one of these units of measure is FLOAT.

enumerator Ampere = 4: Electric current in Amperes.

enumerator DegreeCelsius = 2: Temperature in degree Celsius.

enumerator Hertz = 1: Frequency in Hertz.

enumerator None = 0: No reading.

enumerator Ohm = 5: Resistance, magnitude of reactance, or magnitude of impedance in Ohms.

enumerator Volt = 3: Voltage in Volts.

OcaPresentationUnit

enum OcaPresentationUnit : uint8_t

Enumeration of presentation units that can be used in OCA classes. Property values of OCA objects are always in SI units (unless explicitly documented otherwise), but the presentation unit can also be stored to indicate in which unit the value was presented in a user interface. This way another controller can also present it in that unit (i.e. doing a conversion on the controller before presenting it) to keep the user presentation uniform. Note that the presentation unit may be equal to the unit of the property (in which case of course no conversion is needed).

enumerator dBu = 0: dB(0.775 VRMS) - voltage relative to 0.775 volts.

enumerator dBV = 1: dB(1 VRMS) - voltage relative to 1 volt.

enumerator V = 2: Voltage in plain volts.

OcaTemperature

using OcaTemperature = OcaFloat32: Strong datatype for temperature in degrees Celsius.

OcaLevelDetectionLaw

enum OcaLevelDetectionLaw : uint8_t

Enumeration of the types of level detector characteristics. Used in dynamics classes and for sensors.

enumerator None = 0: No detection (i.e. never trigger)

enumerator RMS = 1: Detect RMS value.

enumerator Peak = 2: Detect peak value.

OcaSensorReadingState

enum OcaSensorReadingState : uint8_t

Enum that describes whether an OcaSensor’s current reading value can be trusted, and if not, why not.

enumerator Unknown = 0: Cannot determine validity of reading, or this feature is not implemented.

enumerator Valid = 1: Sensor reading is valid.

enumerator Underrange = 2: Sensor is underrange, reading is not valid.

enumerator Overrange = 3: Sensor is overrange, reading is not valid.

enumerator Error = 4: Sensor is in an error state, reading is not valid.

OcaLevelMeterLaw

enum OcaLevelMeterLaw : uint8_t

Enumeration of level meter laws.

enumerator VU = 1: Generic VU-style meter, characteristics defined by device.

enumerator StandardVU = 2: Classic VU meter per ANSI C16.5-1942, British Standard BS 6840, and IEC 60268-17.

enumerator PPM1 = 3: IEC 60268-10 Peak Programme Meter, type I (Germany).

enumerator PPM2 = 4: IEC 60268-10 Peak Programme Meter, type II (BBC).

enumerator LKFS = 5: Loudness meter as defined by ITU BS1770.

enumerator RMS = 6: Simple RMS meter

enumerator Peak = 7: Simple peak meter

enumerator ProprietaryValueBase = 128: Proprietery classes shall add values of this value or greater. Values 0 to 127 are reserved.