1.1.2.2.1 OcaAudioLevelSensor

Class Hierarchy:

OcaRoot → OcaWorker → OcaSensor → OcaLevelSensor → OcaAudioLevelSensor

class OcaAudioLevelSensor : OcaLevelSensor

Child of OcaLevelSensor that returns an audio meter reading in dB relative to a known reference level, and whose value has been calculated by the selected averaging algorithm.

Properties:

static const OcaClassID ClassID = "1.1.2.2.1"

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

static const OcaClassVersionNumber ClassVersion = 2

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

OcaLevelMeterLaw Law

Enum that defines metering algorithm, including averaging characteristics and, in some cases, reference level. Readonly in some objects.

This property has id 5.1.

Properties inherited from OcaLevelSensor:

• OcaDB OcaLevelSensor::Reading

Properties inherited from OcaSensor:

• OcaSensorReadingState OcaSensor::ReadingState

Properties inherited from OcaWorker:

• OcaBoolean OcaWorker::Enabled

• OcaList<OcaPort> OcaWorker::Ports

• OcaString OcaWorker::Label

• OcaONo OcaWorker::Owner

• OcaTimeInterval OcaWorker::Latency

Properties inherited from OcaRoot:

• OcaONo OcaRoot::ObjectNumber

• OcaBoolean OcaRoot::Lockable

• OcaString OcaRoot::Role

Methods:

OcaStatus GetLaw(OcaLevelMeterLaw &law)

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

This method has id 5.1.

Parameters

OcaLevelMeterLaw law – Output parameter.

OcaStatus SetLaw(OcaLevelMeterLaw law)

Sets the value of the Law property. The return value indicates whether the property was successfully set. Only implemented for objects whose Law property is read/write.

This method has id 5.2.

Parameters

OcaLevelMeterLaw law – Input parameter.

Methods inherited from OcaLevelSensor:

• OcaLevelSensor::GetReading(Reading, minReading, maxReading)

Methods inherited from OcaSensor:

• OcaSensor::GetReadingState(state)

Methods inherited from OcaWorker:

• OcaWorker::GetEnabled(enabled)

• OcaWorker::SetEnabled(enabled)

• OcaWorker::AddPort(Label, Mode, ID)

• OcaWorker::DeletePort(ID)

• OcaWorker::GetPorts(OcaPorts)

• OcaWorker::GetPortName(PortID, Name)

• OcaWorker::SetPortName(PortID, Name)

• OcaWorker::GetLabel(label)

• OcaWorker::SetLabel(label)

• OcaWorker::GetOwner(owner)

• OcaWorker::GetLatency(latency)

• OcaWorker::SetLatency(latency)

• OcaWorker::GetPath(NamePath, ONoPath)

Methods inherited from OcaRoot:

• OcaRoot::GetClassIdentification(ClassIdentification)

• OcaRoot::GetLockable(lockable)

• OcaRoot::LockTotal()

• OcaRoot::Unlock()

• OcaRoot::GetRole(Role)

• OcaRoot::LockReadonly()