LV2  1.0.13
Data Fields
LV2_State_Map_Path Struct Reference

Feature data for state:mapPath (LV2_STATE__mapPath). More...

Data Fields

LV2_State_Map_Path_Handle handle
 Opaque host data. More...
 
char *(* abstract_path )(LV2_State_Map_Path_Handle handle, const char *absolute_path)
 Map an absolute path to an abstract path for use in plugin state. More...
 
char *(* absolute_path )(LV2_State_Map_Path_Handle handle, const char *abstract_path)
 Map an abstract path from plugin state to an absolute path. More...
 

Detailed Description

Feature data for state:mapPath (LV2_STATE__mapPath).

Field Documentation

LV2_State_Map_Path_Handle LV2_State_Map_Path::handle

Opaque host data.

char*(* LV2_State_Map_Path::abstract_path) (LV2_State_Map_Path_Handle handle, const char *absolute_path)

Map an absolute path to an abstract path for use in plugin state.

Parameters
handleMUST be the handle member of this struct.
absolute_pathThe absolute path of a file.
Returns
An abstract path suitable for use in plugin state.

The plugin MUST use this function to map any paths that will be stored in plugin state. The returned value is an abstract path which MAY not be an actual file system path; absolute_path() MUST be used to map it to an actual path in order to use the file.

Plugins MUST NOT make any assumptions about abstract paths except that they can be mapped back to the absolute path of the "same" file (though not necessarily the same original path) using absolute_path().

This function may only be called within the context of LV2_State_Interface methods. The caller is responsible for freeing the returned value with free().

char*(* LV2_State_Map_Path::absolute_path) (LV2_State_Map_Path_Handle handle, const char *abstract_path)

Map an abstract path from plugin state to an absolute path.

Parameters
handleMUST be the handle member of this struct.
abstract_pathAn abstract path (e.g. a path from plugin state).
Returns
An absolute file system path.

The plugin MUST use this function in order to actually open or otherwise use any paths loaded from plugin state.

This function may only be called within the context of LV2_State_Interface methods. The caller is responsible for freeing the returned value with free().


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