OcaPolarity¶
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 |
OcaPolarityState |
OcaPolarityState |
Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency and State.
-
class
OcaPolarity
(objectNumber, device)¶ Signal inverter
-
OcaPolarity.
OnStateChanged
¶ type: PropertyEvent.<OcaPolarityState>
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 inverter - {noninverted, inverted].
-
OcaPolarity.
GetState
()¶ Gets the current inverter state. The return value indicates whether the state was successfully retrieved.
- Returns
Promise.<OcaPolarityState> – A promise which resolves to a single value of type
OcaPolarityState()
.
-
OcaPolarity.
SetState
(state)¶ Sets the inversion state (i.e. value of the State property). The return value indicates whether the state was successfully set.
- Arguments
state (OcaPolarityState) –
- Returns
Promise.<void> –
-