LV2_State_Interface

LV2 Plugin State Interface.

When the plugin's extension_data is called with argument LV2_STATE__interface, the plugin MUST return an LV2_State_Interface structure, which remains valid for the lifetime of the plugin.

The host can use the contained function pointers to save and restore the state of a plugin instance at any time, provided the threading restrictions of the functions are met.

Stored data is only guaranteed to be compatible between instances of plugins with the same URI (i.e. if a change to a plugin would cause a fatal error when restoring state saved by a previous version of that plugin, the plugin URI MUST change just as it must when ports change incompatibly). Plugin authors should consider this possibility, and always store sensible data with meaningful types to avoid such problems in the future.

Members

Aliases

restoreFun_t
alias restoreFun_t = LV2_State_Status function(LV2_Handle instance, LV2_State_Retrieve_Function retrieve, LV2_State_Handle handle, uint flags, const(LV2_Feature*)* features)

Restore plugin state using a host-provided retrieve callback.

saveFun_t
alias saveFun_t = LV2_State_Status function(LV2_Handle instance, LV2_State_Store_Function store, LV2_State_Handle handle, uint flags, const(LV2_Feature*)* features)

Save plugin state using a host-provided store callback.

Variables

restore
restoreFun_t restore;
Undocumented in source.
save
saveFun_t save;
Undocumented in source.

Meta