OcaIdentificationActuator

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

Active

boolean

OcaBoolean

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency and Active.

class OcaIdentificationActuator(objectNumber, device)

Represents a function that turns on some kind of human-detectable indicator for purposes of device identification during network setup. Physical form of indicator is not defined by OCA, so it could be anything, e.g.

  • LED

  • Foghorn

  • Smoke emitter

  • Little waving robot hand wearing white glove

  • Jack-in-the-box popout

  • et cetera

OcaIdentificationActuator.OnActiveChanged

type: PropertyEvent.<boolean>

This event is emitted when the property Active changes in the remote object. The property Active is described in the AES70 standard as follows. True iff indicator is active.

OcaIdentificationActuator.GetActive()

Gets the current identification indicator activity state. The return value indicates whether the state was successfully retrieved.

Returns

Promise.<boolean> – A promise which resolves to a single value of type boolean.

OcaIdentificationActuator.SetActive(active)

Sets the Active state (i.e. value of the Active property). The return value indicates whether the state was successfully set.

Arguments

  • active (boolean) –

Returns

Promise.<void> –