OcaRoot

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

The class is a subclass of ObjectBase().

This class defines the properties

Name	JavaScript Type	AES70 Type
ClassID	OcaClassID	OcaClassID
ClassVersion	number	OcaClassVersionNumber
ObjectNumber	number	OcaONo
Lockable	boolean	OcaBoolean
Role	string	OcaString

class OcaRoot(objectNumber, device)

The abstract root class of which all OCA classes derive. It offers basic OCA functionality such as locking an object and generalized data access.

OcaRoot.OnPropertyChanged

type: Event

General event that is emitted when a property changes. In each setter method (of derived classes) this event must be raised with the proper derived event data structure.

OcaRoot.GetClassIdentification()

Gets the class identification, a structure that contains the ClassID and ClassVersion. The return value indicates whether the property was successfully retrieved.

Returns

Promise.<OcaClassIdentification> – A promise which resolves to a single value of type OcaClassIdentification().

OcaRoot.GetLockable()

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

Returns

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

OcaRoot.GetRole()

Returns value of Role property. The return value indicates whether the operation succeeded.

Returns

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

OcaRoot.LockReadonly()

Locks the object so that its properties may only be modified by the lockholder, but others can still retrieve property values. If the device is already locked (by a prior call to Lock() or LockReadonly()) when LockReadonly() is called by the same lockholder, the lock state is set to read-only. If the call is from a session other than the lockholder’s, the call fails. The return value indicates whether the operation succeeded.

Returns

Promise.<void> –

OcaRoot.LockTotal()

Locks the object totally, so that it can only be accessed for reading or writing by the lockholder. If the device is read-only locked (by a prior call to LockReadonly()) when Lock() is called by the same lockholder, the lock state is upgraded to total. If the call is from a session other than the lockholder’s, the call fails. The return value indicates whether the operation succeeded.

Returns

Promise.<void> –

OcaRoot.Unlock()

Unlocks the object so that it can be freely accessed again. This method can only succeed if it is called by the lockholder. The return value indicates whether the operation succeeded.

Returns

Promise.<void> –