PresetIF

This interface offers methods to query and manipulate parameter preset sets. A preset is a bunch of property settings, together with meta data and a name. The name of a preset serves as key for subsequent method calls to manipulate single presets. All instances of one type will share the list of presets. The list is created on demand, if presets are not used, the list is not created.

The interface comes with a default implementation that serves most plugins. Wrapper plugins will override most methods to implement support for the native preset format of those wrapped plugins. One method that is useful to be overridden is gst_preset_get_property_names(). With that one can control which properties are saved and in which order.

The default implementation supports presets located in a system directory, application specific directory and in the users home directory. When getting a list of presets individual presets are read and overlaid in 1) system, 2) application and 3) user order. Whenever an earlier entry is newer, the later entries will be updated.

interface PresetIF {

GstPreset* getPresetTStruct();

void* getStruct();

string[] getPresetNames();

string[] getPropertyNames();

int loadPreset(string name);

int savePreset(string name);

int renamePreset(string oldName, string newName);

int deletePreset(string name);

int setMeta(string name, string tag, string value);

int getMeta(string name, string tag, string value);

static int setAppDir(string appDir);

static string getAppDir();

}

Members

Functions

deletePreset int deletePreset(string name): Delete the given preset.
getMeta int getMeta(string name, string tag, string value): Gets the value for an existing meta data tag. Meta data tag names can be something like e.g. "comment". Returned values need to be released when done.
getPresetNames string[] getPresetNames(): Get a copy of preset names as a NULL terminated string array.
getPresetTStruct GstPreset* getPresetTStruct(): Undocumented in source.
getPropertyNames string[] getPropertyNames(): Get a the names of the GObject properties that can be used for presets.
getStruct void* getStruct(): the main Gtk struct as a void*
loadPreset int loadPreset(string name): Load the given preset.
renamePreset int renamePreset(string oldName, string newName): Renames a preset. If there is already a preset by the new_name it will be overwritten.
savePreset int savePreset(string name): Save the current object settings as a preset under the given name. If there is already a preset by this name it will be overwritten.
setMeta int setMeta(string name, string tag, string value): Sets a new value for an existing meta data item or adds a new item. Meta data tag names can be something like e.g. "comment". Supplying NULL for the value will unset an existing value.

Static functions

getAppDir string getAppDir(): Gets the directory for application specific presets if set by the application.
setAppDir int setAppDir(string appDir): Sets an extra directory as an absolute path that should be considered when looking for presets. Any presets in the application dir will shadow the system presets.

PresetIF

Members

Functions

Static functions

Meta

Source