LV2_State_Map_Path Struct Reference

#include <state.h>

Public Attributes
LV2_State_Map_Path_Handle	handle
char *(*	abstract_path )(LV2_State_Map_Path_Handle handle, const char *absolute_path)
char *(*	absolute_path )(LV2_State_Map_Path_Handle handle, const char *abstract_path)

Detailed Description

Feature data for state:mapPath (LV2_STATE__mapPath).

Feature data for state:mapPath (LV2_STATE__mapPath).

Member Data Documentation

absolute_path

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

handle	MUST be the handle member of this struct.
abstract_path	An abstract path (typically 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 must free the returned value with LV2_State_Free_Path.free_path().

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

Parameters

handle	MUST be the handle member of this struct.
abstract_path	An 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().

abstract_path

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

handle	MUST be the handle member of this struct.
absolute_path	The 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 must free the returned value with LV2_State_Free_Path.free_path().

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

Parameters

handle	MUST be the handle member of this struct.
absolute_path	The 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().

handle

LV2_State_Map_Path_Handle LV2_State_Map_Path::handle

Opaque host data.

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/lv2/state.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/format_types/LV2_SDK/lv2/lv2/state/state.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/LadspaEffect/calf/veal/src/calf/lv2_state.h