Index

Class OcaAudioLevelSensor

ClassID: 1.1.2.2.1

extends 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 readonly OcaClassID ClassID = 1.1.2.2.1

Level: 1 Index: 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.

static readonly OcaClassVersionNumber ClassVersion = 2

Level: 1 Index: 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.

OcaLevelMeterLaw Law

Level: 5 Index: 1

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

Properties inherited from OcaLevelSensor

OcaDB Reading

Properties inherited from OcaSensor

static OcaSensorReadingState ReadingState

Properties inherited from OcaWorker

OcaBoolean Enabled

OcaList<OcaPort> Ports

OcaString Label

OcaONo Owner

OcaTimeInterval Latency

Properties inherited from OcaRoot

readonly OcaONo ObjectNumber

readonly OcaBoolean Lockable

readonly OcaString Role

Methods

OcaAudioLevelSensor::GetLaw ( ) → ( OcaLevelMeterLaw law)

Level: 5 Index: 1

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

OcaAudioLevelSensor::SetLaw ( OcaLevelMeterLaw law )

Level: 5 Index: 2

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.

Methods inherited from OcaLevelSensor

OcaLevelSensor::GetReading ( ) → ( OcaDB Reading, OcaDB minReading, OcaDB maxReading)

Methods inherited from OcaSensor

OcaSensor::GetReadingState ( ) → ( OcaSensorReadingState state)

Methods inherited from OcaWorker

OcaWorker::GetEnabled ( ) → ( OcaBoolean enabled)

OcaWorker::SetEnabled ( OcaBoolean enabled )

OcaWorker::AddPort ( OcaString Label, OcaPortMode Mode ) → ( OcaPortID ID)

OcaWorker::DeletePort ( OcaPortID ID )

OcaWorker::GetPorts ( ) → ( OcaList<OcaPort> OcaPorts)

OcaWorker::GetPortName ( OcaPortID PortID ) → ( OcaString Name)

OcaWorker::SetPortName ( OcaPortID PortID, OcaString Name )

OcaWorker::GetLabel ( ) → ( OcaString label)

OcaWorker::SetLabel ( OcaString label )

OcaWorker::GetOwner ( ) → ( OcaONo owner)

OcaWorker::GetLatency ( ) → ( OcaTimeInterval latency)

OcaWorker::SetLatency ( OcaTimeInterval latency )

OcaWorker::GetPath ( ) → ( OcaNamePath NamePath, OcaONoPath ONoPath)

Methods inherited from OcaRoot

OcaRoot::GetClassIdentification ( ) → ( OcaClassIdentification ClassIdentification)

OcaRoot::GetLockable ( ) → ( OcaBoolean lockable)

OcaRoot::LockTotal ( )

OcaRoot::Unlock ( )

OcaRoot::GetRole ( ) → ( OcaString Role)

OcaRoot::LockReadonly ( )