LV2  1.0.13
Data Fields
LV2_Lib_Descriptor Struct Reference

Descriptor for a plugin library. More...

Data Fields

LV2_Lib_Handle handle
 Opaque library data which must be passed as the first parameter to all the methods of this struct.
uint32_t size
 The total size of this struct.
void(* cleanup )(LV2_Lib_Handle handle)
 Destroy this library descriptor and free all related resources.
const LV2_Descriptor *(* get_plugin )(LV2_Lib_Handle handle, uint32_t index)
 Plugin accessor.

Detailed Description

Descriptor for a plugin library.

To access a plugin library, the host creates an LV2_Lib_Descriptor via the lv2_lib_descriptor() function in the shared object.

Field Documentation

LV2_Lib_Handle LV2_Lib_Descriptor::handle

Opaque library data which must be passed as the first parameter to all the methods of this struct.

uint32_t LV2_Lib_Descriptor::size

The total size of this struct.

This allows for this struct to be expanded in the future if necessary. This MUST be set by the library to sizeof(LV2_Lib_Descriptor). The host MUST NOT access any fields of this struct beyond get_plugin() unless this field indicates they are present.

void(* LV2_Lib_Descriptor::cleanup)(LV2_Lib_Handle handle)

Destroy this library descriptor and free all related resources.

const LV2_Descriptor*(* LV2_Lib_Descriptor::get_plugin)(LV2_Lib_Handle handle, uint32_t index)

Plugin accessor.

Plugins are accessed by index using values from 0 upwards. Out of range indices MUST result in this function returning NULL, so the host can enumerate plugins by increasing index until NULL is returned.


The documentation for this struct was generated from the following file: