OcaLibraryManager

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

The class is a subclass of OcaManager().

This class defines the properties

Name

JavaScript Type

AES70 Type

Libraries

OcaLibraryIdentifier[]

OcaList<OcaLibraryIdentifier>

CurrentPatch

OcaLibVolIdentifier

OcaLibVolIdentifier

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Libraries and CurrentPatch.

class OcaLibraryManager(objectNumber, device)

Optional manager for handling device presets – Patch and ParamSet libraries.

  • May be instantiated once in any device.

  • If instantiated, object number must be 8.

OcaLibraryManager.OnCurrentPatchChanged

type: PropertyEvent.<OcaLibVolIdentifier>

This event is emitted when the property CurrentPatch changes in the remote object. The property CurrentPatch is described in the AES70 standard as follows. Library volume identifier of the most-recently applied patch in this device. Changing the value of this property applies the patch represented by the new value.

OcaLibraryManager.OnLibrariesChanged

type: PropertyEvent.<Array.<OcaLibraryIdentifier>>

This event is emitted when the property Libraries changes in the remote object. The property Libraries is described in the AES70 standard as follows. List of identifiers of all libraries in the device.

OcaLibraryManager.AddLibrary(Type)

Adds a library to the device. Return value indicates whether the library was successfully added.

Arguments
Returns

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

OcaLibraryManager.ApplyPatch(ID)

Apply a patch to the device.

Arguments
Returns

Promise.<void> –

OcaLibraryManager.DeleteLibrary(ID)

Deletes a library from the device.

Arguments

  • ID (number) –

Returns

Promise.<void> –

OcaLibraryManager.GetCurrentPatch()

Return the identifier of the most recently applied patch. The return value indicates whether the method succeeded.

Returns

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

OcaLibraryManager.GetLibraryCount(Type)

Returns the number of libraries of the given type that are instantiated in the device..

Arguments
Returns

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

OcaLibraryManager.GetLibraryList(Type)

Returns the list of object numbers of libraries of libraries of the given type that are instantiated in the device.

Arguments
Returns

Promise.<Array.<OcaLibraryIdentifier>> – A promise which resolves to a single value of type OcaLibraryIdentifier[].