OcaLibrary

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

The class is a subclass of OcaAgent().

This class defines the properties

Name

JavaScript Type

AES70 Type

VolumeType

OcaLibVolType

OcaLibVolType

Access

OcaLibAccess

OcaLibAccess

Volumes

Map<number, OcaLibVol>

OcaMap<OcaLibVolID, OcaLibVol>

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

class OcaLibrary(objectNumber, device)

A library is an agent that holds a collection of datasets. We refer to each dataset as a Volume . There are two kinds of volumes: ParamSet (parameter set). A ParamSet is a collection of operating parameter settings that can be applied to a block. Each ParamSet is associated with a specific block type, but not with a specific instance of that type. A ParamSet may be applied to any block instance of the associated type. A block’s type is the object number of its factory or, for factory-defined blocks, a unique identifier set at time of manufacture. Patch . A Patch is a collection of ParamSet assignments. A ParamSet assigment is the description of a binding of a ParamSet to a block instance. To “apply” a Patch is to apply all of its assignments. To apply an assignment is to set all of its ParamSet’s parameter values into its block. A given library instance can only hold one class of volume. A device that supports libraries can have any number of Patch and ParamSet libraries. If a device implements a Patch library, it must also implement at least one ParamSet library. However, the reverse is not true: a device may implement one or more ParamSet libraries without a Patch library.

OcaLibrary.OnAccessChanged

type: PropertyEvent.<OcaLibAccess>

This event is emitted when the property Access changes in the remote object. The property Access is described in the AES70 standard as follows. Readonly, read-expand, or full.

OcaLibrary.OnOcaLibVolChanged

type: Event

Event that is raised whenever private property Volumes changes. Added in OcaLibrary Version 2.

OcaLibrary.OnVolumeTypeChanged

type: PropertyEvent.<OcaLibVolType>

This event is emitted when the property VolumeType changes in the remote object. The property VolumeType is described in the AES70 standard as follows. Type of library volumes:

OcaLibrary.OnVolumesChanged

type: PropertyEvent.<Map.<number, OcaLibVol>>

This event is emitted when the property Volumes changes in the remote object. The property Volumes is described in the AES70 standard as follows. Map of volumes held in the Library. Changed in version 2 because the definition of OcaLibVolMetaData, which is part of OcaLibVol, has changed, and because it is now a private property whose changes are signaled by the <b>OcaLibVolChanged </b>event.

OcaLibrary.AddVolume(Volume)

Adds a volume to the library and returns its volume ID. The return value indicates whether the volume was successfully added. Changed in version 2 because the definition of OcaLibVolMetaData, which is part of OcaLibVol, has changed.

Arguments
Returns

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

OcaLibrary.DeleteVolume(ID)

Deletes a volume from the library. The return value indicates whether the group was successfully deleted.

Arguments

  • ID (number) –

Returns

Promise.<void> –

OcaLibrary.GetAccess()

Gets allowed access mode for this library. The return value indicates whether the property was successfully retrieved.

Returns

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

OcaLibrary.GetVolume()

Retrieves a library volume. The return value indicates whether the volume was successfully retrieved. Changed in version 2 because the definition of OcaLibVolMetaData, which is part of OcaLibVol, has changed.

Returns

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

OcaLibrary.GetVolumeCount()

Gets the count of volumes in this library. The return value indicates whether the count was successfully retrieved.

Returns

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

OcaLibrary.GetVolumes()

Gets the list of volumes held in this library. The return value indicates whether the list was successfully retrieved. Changed in version 2 because the definition of OcaLibVolMetaData, which is part of OcaLibVol, has changed.

Returns

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

OcaLibrary.ReplaceVolume(ID, Volume)

Replaces a volume in the library at the given volume ID. The return value indicates whether the volume was successfully replaced. Changed in version 2 because the definition of OcaLibVolMetaData, which is part of OcaLibVol, has changed.

Arguments
Returns

Promise.<void> –

OcaLibrary.SetAccess(Access)

Sets allowed access mode for this library. The return value indicates whether the property was successfully set. Not implemented for static, manufacturer-supplied libraries.

Arguments
Returns

Promise.<void> –