1.1.1.2 OcaMute
Class Hierarchy:
OcaRoot → OcaWorker → OcaActuator → OcaMute
-
class OcaMute : OcaActuator
Signal mute.
Properties:
-
static const OcaClassID ClassID = "1.1.1.2"
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.
-
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
4.2.
-
OcaMuteState State = Unmuted
Current state of the mute.
This property has id
4.1.
Properties inherited from OcaWorker:
OcaList<OcaPort> OcaWorker::Ports
OcaTimeInterval OcaWorker::Latency
Properties inherited from OcaRoot:
Methods:
-
OcaStatus GetState(OcaMuteState &state)
Gets the current mute state. The return value indicates whether the state was successfully retrieved.
This method has id
4.1.- Parameters
OcaMuteState state – Output parameter.
-
OcaStatus SetState(OcaMuteState state)
Sets the mute state (i.e. value of the State property). The return value indicates whether the state was successfully set.
This method has id
4.2.- Parameters
OcaMuteState state – Input parameter.
Methods inherited from OcaWorker:
Methods inherited from OcaRoot:
-
static const OcaClassID ClassID = "1.1.1.2"