OcaMute¶
A online version of the AES70 specification of this class can be found at http://docs.deuso.de.
The class is a subclass of OcaActuator()
.
This class defines the properties
Name |
JavaScript Type |
AES70 Type |
---|---|---|
State |
OcaMuteState |
OcaMuteState |
Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency and State.
-
class
OcaMute
(objectNumber, device)¶ Signal mute.
-
OcaMute.
OnStateChanged
¶ type: PropertyEvent.<OcaMuteState>
This event is emitted when the property State changes in the remote object. The property
State
is described in the AES70 standard as follows. Current state of the mute.
-
OcaMute.
GetState
()¶ Gets the current mute state. The return value indicates whether the state was successfully retrieved.
- Returns
Promise.<OcaMuteState> – A promise which resolves to a single value of type
OcaMuteState()
.
-
OcaMute.
SetState
(state)¶ Sets the mute state (i.e. value of the State property). The return value indicates whether the state was successfully set.
- Arguments
state (OcaMuteState) –
- Returns
Promise.<void> –
-