1.3.8 OcaLibraryManager

Class Hirarchy:

OcaRootOcaManagerOcaLibraryManager

class OcaLibraryManager : OcaManager

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

  • May be instantiated once in any device.

  • If instantiated, object number must be 8.

Properties:

OcaClassID ClassID

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.

This property has id 3.1.

OcaClassVersionNumber ClassVersion

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.

This property has id 3.2.

OcaList<OcaLibraryIdentifier> Libraries

List of identifiers of all libraries in the device.

This property has id 3.1.

OcaLibVolIdentifier CurrentPatch

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.

This property has id 3.2.

Properties inherited from OcaRoot:

Methods:

OcaStatus AddLibrary(OcaLibVolType Type, OcaLibraryIdentifier &Identifier)

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

This method has id 3.1.

Parameters
  • OcaLibVolType Type – Input parameter.

  • OcaLibraryIdentifier Identifier – Output parameter.

OcaStatus DeleteLibrary(OcaONo ID)

Deletes a library from the device.

This method has id 3.2.

Parameters

OcaONo ID – Input parameter.

OcaStatus GetLibraryCount(OcaLibVolType Type, OcaUint16 &Count)

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

This method has id 3.3.

Parameters
  • OcaLibVolType Type – Input parameter.

  • OcaUint16 Count – Output parameter.

OcaStatus GetLibraryList(OcaLibVolType Type, OcaList<OcaLibraryIdentifier> &Libraries)

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

This method has id 3.4.

Parameters
  • OcaLibVolType Type – Input parameter.

  • OcaList<OcaLibraryIdentifier> Libraries – Output parameter.

OcaStatus GetCurrentPatch(OcaLibVolIdentifier &ID)

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

This method has id 3.5.

Parameters

OcaLibVolIdentifier ID – Output parameter.

OcaStatus ApplyPatch(OcaLibVolIdentifier ID)

Apply a patch to the device.

This method has id 3.6.

Parameters

OcaLibVolIdentifier ID – Input parameter.

Methods inherited from OcaRoot: