dplug.lv2.state

@defgroup state State

An interface for LV2 plugins to save and restore state, see <http://lv2plug.in/ns/ext/state> for details.

@{

Members

Aliases

LV2_State_Flags
alias LV2_State_Flags = int

Flags describing value characteristics.

LV2_State_Retrieve_Function
alias LV2_State_Retrieve_Function = void* function(LV2_State_Handle handle, uint32_t key, size_t* size, uint32_t* type, uint32_t* flags)

A host-provided function to retrieve a property. @param handle Must be the handle passed to LV2_State_Interface.restore(). @param key The key of the property to retrieve (URID). @param size (Output) If non-NULL, set to the size of the restored value. @param type (Output) If non-NULL, set to the type of the restored value. @param flags (Output) If non-NULL, set to the flags for the restored value. @return A pointer to the restored value (object), or NULL if no value has been stored under key.

LV2_State_Status
alias LV2_State_Status = int

A status code for state functions.

LV2_State_Store_Function
alias LV2_State_Store_Function = LV2_State_Status function(LV2_State_Handle handle, uint32_t key, const void* value, size_t size, uint32_t type, uint32_t flags)

A host-provided function to store a property. @param handle Must be the handle passed to LV2_State_Interface.save(). @param key The key to store value under (URID). @param value Pointer to the value to be stored. @param size The size of value in bytes. @param type The type of value (URID). @param flags LV2_State_Flags for value. @return 0 on success, otherwise a non-zero error code.

Structs

LV2_State_Make_Path
struct LV2_State_Make_Path

Feature data for state:makePath (@ref LV2_STATE__makePath).

LV2_State_Map_Path
struct LV2_State_Map_Path

Feature data for state:mapPath (@ref LV2_STATE__mapPath).

_LV2_State_Interface
struct _LV2_State_Interface

LV2 Plugin State Interface.

Meta