OcaStringActuator¶
A online version of the AES70 specification of this class can be found at http://docs.deuso.de.
The class is a subclass of OcaBasicActuator()
.
This class defines the properties
Name |
JavaScript Type |
AES70 Type |
---|---|---|
Setting |
string |
OcaString |
MaxLen |
number |
OcaUint16 |
Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency, Setting and MaxLen.
-
class
OcaStringActuator
(objectNumber, device)¶ String actuator.
-
OcaStringActuator.
OnSettingChanged
¶ type: PropertyEvent.<string>
This event is emitted when the property Setting changes in the remote object. The property
Setting
is described in the AES70 standard as follows. Value.
-
OcaStringActuator.
GetMaxLen
()¶ Gets the maximum string length that this object can handle.
- Returns
Promise.<number> – A promise which resolves to a single value of type
number
.
-
OcaStringActuator.
GetSetting
()¶ Gets the value and max length of the Value property. The return value indicates whether the data was successfully retrieved.
- Returns
Promise.<string> – A promise which resolves to a single value of type
string
.
-
OcaStringActuator.
SetSetting
(Value)¶ Sets the value of the Value property. The return value indicates whether the property was successfully set.
- Arguments
Value (string) –
- Returns
Promise.<void> –
-