Preset

Object Hierarchy:

Description:

[ CCode ( type_cname = "GstPresetInterface" , type_id = "gst_preset_get_type ()" ) ]
public interface Preset : Object

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 get_property_names. With that one can control which properties are saved and in which order. When implementing support for read-only presets, one should set the vmethods for save_preset and delete_preset to null. Applications can use is_editable to check for that.

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. Since 1.8 you can also provide extra paths where to find presets through the GST_PRESET_PATH environment variable. Presets found in those paths will be considered as "app presets".

Namespace: Gst

Package: gstreamer-1.0

Content:

Static methods:

public static unowned string? get_app_dir ()
Gets the directory for application specific presets if set by the application.
public static bool set_app_dir (string app_dir)
Sets an extra directory as an absolute path that should be considered when looking for presets.

Methods:

public abstract bool delete_preset (string name)
Delete the given preset.
public abstract bool get_meta (string name, string tag, out string value)
Gets the value for an existing meta data tag.
public abstract string[] get_preset_names ()
Get a copy of preset names as a null terminated string array.
public abstract string[] get_property_names ()
Get a the names of the GObject properties that can be used for presets.
public bool is_editable ()
Check if one can add new presets, change existing ones and remove presets.
public abstract bool load_preset (string name)
Load the given preset.
public abstract bool rename_preset (string old_name, string new_name)
Renames a preset.
public abstract bool save_preset (string name)
Save the current object settings as a preset under the given name.
public abstract bool set_meta (string name, string tag, string? value)
Sets a new value for an existing meta data item or adds a new item.

Inherited Members:

All known members inherited from class GLib.Object