Class OcaLibraryManager

ClassID: 1.3.8

extends OcaManager

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


static readonly OcaClassID ClassID = 1.3.8

Level: 1 Index: 1

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the OcaRoot property.

static readonly OcaClassVersionNumber ClassVersion = 2

Level: 1 Index: 2

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

OcaList<OcaLibraryIdentifier> Libraries

Level: 3 Index: 1

List of identifiers of all libraries in the device.

OcaLibVolIdentifier CurrentPatch

Level: 3 Index: 2

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.

Properties inherited from OcaRoot

readonly OcaONo ObjectNumber

readonly OcaBoolean Lockable

readonly OcaString Role


OcaLibraryManager::AddLibrary ( OcaLibVolType Type ) → ( OcaLibraryIdentifier Identifier)

Level: 3 Index: 1

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

OcaLibraryManager::DeleteLibrary ( OcaONo ID )

Level: 3 Index: 2

Deletes a library from the device.

OcaLibraryManager::GetLibraryCount ( OcaLibVolType Type ) → ( OcaUint16 Count)

Level: 3 Index: 3

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

OcaLibraryManager::GetLibraryList ( OcaLibVolType Type ) → ( OcaList<OcaLibraryIdentifier> Libraries)

Level: 3 Index: 4

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

OcaLibraryManager::GetCurrentPatch ( ) → ( OcaLibVolIdentifier ID)

Level: 3 Index: 5

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

OcaLibraryManager::ApplyPatch ( OcaLibVolIdentifier ID )

Level: 3 Index: 6

Apply a patch to the device.

Methods inherited from OcaRoot

OcaRoot::GetClassIdentification ( ) → ( OcaClassIdentification ClassIdentification)

OcaRoot::GetLockable ( ) → ( OcaBoolean lockable)

OcaRoot::LockTotal ( )

OcaRoot::Unlock ( )

OcaRoot::GetRole ( ) → ( OcaString Role)

OcaRoot::LockReadonly ( )