Klasse Preset

Alle implementierten Schnittstellen:
PointerInterface

public class Preset extends Interface
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.
When implementing support for read-only presets, one should set the vmethods
for gst_preset_save_preset() and gst_preset_delete_preset() to %NULL.
Applications can use gst_preset_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".

https://gstreamer.freedesktop.org/documentation/gstreamer/gi-index.html

  • Konstruktordetails

  • Methodendetails

    • getClassHandler

      public static ClassHandler getClassHandler()
    • deletePreset

      public boolean deletePreset(@Nonnull Str name)
      Delete the given preset.
      Parameter:
      name - preset name to remove
      Gibt zurück:
      %TRUE for success, %FALSE if e.g. there is no preset with that @name
    • deletePreset

      public boolean deletePreset(String name)
      Delete the given preset.
      Parameter:
      name - preset name to remove
      Gibt zurück:
      %TRUE for success, %FALSE if e.g. there is no preset with that @name
    • isEditable

      public boolean isEditable()
      Check if one can add new presets, change existing ones and remove presets.
      Gibt zurück:
      %TRUE if presets are editable or %FALSE if they are static
    • loadPreset

      public boolean loadPreset(@Nonnull Str name)
      Load the given preset.
      Parameter:
      name - preset name to load
      Gibt zurück:
      %TRUE for success, %FALSE if e.g. there is no preset with that @name
    • loadPreset

      public boolean loadPreset(String name)
      Load the given preset.
      Parameter:
      name - preset name to load
      Gibt zurück:
      %TRUE for success, %FALSE if e.g. there is no preset with that @name
    • renamePreset

      public boolean renamePreset(@Nonnull Str old_name, @Nonnull Str new_name)
      Renames a preset. If there is already a preset by the @new_name it will be
      overwritten.
      Parameter:
      old_name - current preset name
      new_name - new preset name
      Gibt zurück:
      %TRUE for success, %FALSE if e.g. there is no preset with @old_name
    • renamePreset

      public boolean renamePreset(String old_name, String new_name)
      Renames a preset. If there is already a preset by the @new_name it will be
      overwritten.
      Parameter:
      old_name - current preset name
      new_name - new preset name
      Gibt zurück:
      %TRUE for success, %FALSE if e.g. there is no preset with @old_name
    • savePreset

      public boolean savePreset(@Nonnull Str 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.
      Parameter:
      name - preset name to save
      Gibt zurück:
      %TRUE for success, %FALSE
    • savePreset

      public boolean 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.
      Parameter:
      name - preset name to save
      Gibt zurück:
      %TRUE for success, %FALSE
    • setMeta

      public boolean setMeta(@Nonnull Str name, @Nonnull Str tag, @Nullable Str 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.
      Parameter:
      name - preset name
      tag - meta data item name
      value - new value
      Gibt zurück:
      %TRUE for success, %FALSE if e.g. there is no preset with that @name
    • setMeta

      public boolean 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.
      Parameter:
      name - preset name
      tag - meta data item name
      value - new value
      Gibt zurück:
      %TRUE for success, %FALSE if e.g. there is no preset with that @name
    • getAppDir

      public static Str getAppDir()
      Gets the directory for application specific presets if set by the
      application.
      Gibt zurück:
      the directory or %NULL, don't free or modify the string
    • setAppDir

      public static boolean setAppDir(@Nonnull Str app_dir)
      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.
      Parameter:
      app_dir - the application specific preset dir
      Gibt zurück:
      %TRUE for success, %FALSE if the dir already has been set
    • getTypeID

      public static long getTypeID()
    • getParentTypeID

      public static long getParentTypeID()
    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()
    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()
    • getInstanceSize

      public static int getInstanceSize()