OcaAgent¶

A online version of the AES70 specification of this class can be found at http://docs.deuso.de.

The class is a subclass of OcaRoot().

This class defines the properties

Name	JavaScript Type	AES70 Type
Label	string	OcaString
Owner	number	OcaONo

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Label and Owner.

class OcaAgent(objectNumber, device)¶

Abstract base class for defining agents.

OcaAgent.OnLabelChanged¶

type: PropertyEvent.<string>

This event is emitted when the property Label changes in the remote object. The property Label is described in the AES70 standard as follows. User-specified label.

OcaAgent.OnOwnerChanged¶

type: PropertyEvent.<number>

This event is emitted when the property Owner changes in the remote object. The property Owner is described in the AES70 standard as follows. Object number of block that contains this agent.

OcaAgent.GetLabel()¶

Gets the value of the Label property. The return value indicates whether the property was successfully retrieved.

Returns: Promise.<string> – A promise which resolves to a single value of type string.

OcaAgent.GetOwner()¶

Gets the value of the Owner property. The return value indicates whether the property was successfully retrieved.

Returns: Promise.<number> – A promise which resolves to a single value of type number.

OcaAgent.GetPath()¶

Returns path from the given object down to root. The return value indicates whether the operation succeeded. Added in version 2. The return values of this method are

NamePath of type string[]
ONoPath of type number[]

Returns: Promise.<Arguments.<Array.<string>, Array.<number>>> –

OcaAgent.SetLabel(Label)¶

Sets the value of the Label property. The return value indicates whether the property was successfully set.

Arguments

Label (string) –

Returns

Promise.<void> –