Blame docs/gst/html/GstPreset.html

Packit f546b1
Packit f546b1
<html>
Packit f546b1
<head>
Packit f546b1
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit f546b1
<title>GstPreset: GStreamer 1.0 Core Reference Manual</title>
Packit f546b1
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit f546b1
<link rel="home" href="index.html" title="GStreamer 1.0 Core Reference Manual">
Packit f546b1
<link rel="up" href="libgstreamer.html" title="GStreamer Core Library">
Packit f546b1
<link rel="prev" href="gstreamer-GstPoll.html" title="GstPoll">
Packit f546b1
<link rel="next" href="GstPromise.html" title="GstPromise">
Packit f546b1
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit f546b1
<link rel="stylesheet" href="style.css" type="text/css">
Packit f546b1
</head>
Packit f546b1
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit f546b1
Packit f546b1
Packit f546b1
Top  | 
Packit f546b1
                  Description  | 
Packit f546b1
                  Object Hierarchy
Packit f546b1
Packit f546b1
Home
Packit f546b1
Up
Packit f546b1
Prev
Packit f546b1
Next
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

GstPreset

Packit f546b1

GstPreset — helper interface for element presets

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Functions

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gchar **
Packit f546b1
Packit f546b1
Packit f546b1
gst_preset_get_preset_names ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gchar **
Packit f546b1
Packit f546b1
Packit f546b1
gst_preset_get_property_names ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gboolean
Packit f546b1
Packit f546b1
Packit f546b1
gst_preset_load_preset ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gboolean
Packit f546b1
Packit f546b1
Packit f546b1
gst_preset_save_preset ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gboolean
Packit f546b1
Packit f546b1
Packit f546b1
gst_preset_rename_preset ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gboolean
Packit f546b1
Packit f546b1
Packit f546b1
gst_preset_delete_preset ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gboolean
Packit f546b1
Packit f546b1
Packit f546b1
gst_preset_set_meta ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gboolean
Packit f546b1
Packit f546b1
Packit f546b1
gst_preset_get_meta ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gboolean
Packit f546b1
Packit f546b1
Packit f546b1
gst_preset_set_app_dir ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
const gchar *
Packit f546b1
Packit f546b1
Packit f546b1
gst_preset_get_app_dir ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gboolean
Packit f546b1
Packit f546b1
Packit f546b1
gst_preset_is_editable ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Types and Values

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
 
Packit f546b1
GstPreset
Packit f546b1
Packit f546b1
Packit f546b1
struct
Packit f546b1
GstPresetInterface
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Object Hierarchy

Packit f546b1
    GInterface
Packit f546b1
    ╰── GstPreset
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Includes

Packit f546b1
#include <gst/gst.h>
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Description

Packit f546b1

This interface offers methods to query and manipulate parameter preset sets.

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

Packit f546b1

The interface comes with a default implementation that serves most plugins.

Packit f546b1
Wrapper plugins will override most methods to implement support for the
Packit f546b1
native preset format of those wrapped plugins.
Packit f546b1
One method that is useful to be overridden is gst_preset_get_property_names().
Packit f546b1
With that one can control which properties are saved and in which order.
Packit f546b1
When implementing support for read-only presets, one should set the vmethods
Packit f546b1
for gst_preset_save_preset() and gst_preset_delete_preset() to NULL.
Packit f546b1
Applications can use gst_preset_is_editable() to check for that.

Packit f546b1

The default implementation supports presets located in a system directory,

Packit f546b1
application specific directory and in the users home directory. When getting
Packit f546b1
a list of presets individual presets are read and overlaid in 1) system,
Packit f546b1
2) application and 3) user order. Whenever an earlier entry is newer, the
Packit f546b1
later entries will be updated. Since 1.8 you can also provide extra paths
Packit f546b1
where to find presets through the GST_PRESET_PATH environment variable.
Packit f546b1
Presets found in those paths will be concidered as "app presets".

Packit f546b1
Packit f546b1
Packit f546b1

Functions

Packit f546b1
Packit f546b1

gst_preset_get_preset_names ()

Packit f546b1
gchar **
Packit f546b1
gst_preset_get_preset_names (GstPreset *preset);
Packit f546b1

Get a copy of preset names as a NULL terminated string array.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

preset

Packit f546b1

a GObject that implements GstPreset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

list with names, use g_strfreev() after usage.

Packit f546b1

[transfer full][array zero-terminated=1][element-type gchar*]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_preset_get_property_names ()

Packit f546b1
gchar **
Packit f546b1
gst_preset_get_property_names (GstPreset *preset);
Packit f546b1

Get a the names of the GObject properties that can be used for presets.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

preset

Packit f546b1

a GObject that implements GstPreset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

an

Packit f546b1
array of property names which should be freed with g_strfreev() after use. 

Packit f546b1

[transfer full][array zero-terminated=1][element-type gchar*]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_preset_load_preset ()

Packit f546b1
gboolean
Packit f546b1
gst_preset_load_preset (GstPreset *preset,
Packit f546b1
                        const gchar *name);
Packit f546b1

Load the given preset.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

preset

Packit f546b1

a GObject that implements GstPreset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

name

Packit f546b1

preset name to load

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

TRUE for success, FALSE if e.g. there is no preset with that name

Packit f546b1

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_preset_save_preset ()

Packit f546b1
gboolean
Packit f546b1
gst_preset_save_preset (GstPreset *preset,
Packit f546b1
                        const gchar *name);
Packit f546b1

Save the current object settings as a preset under the given name. If there

Packit f546b1
is already a preset by this name
Packit f546b1
 it will be overwritten.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

preset

Packit f546b1

a GObject that implements GstPreset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

name

Packit f546b1

preset name to save

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

TRUE for success, FALSE

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_preset_rename_preset ()

Packit f546b1
gboolean
Packit f546b1
gst_preset_rename_preset (GstPreset *preset,
Packit f546b1
                          const gchar *old_name,
Packit f546b1
                          const gchar *new_name);
Packit f546b1

Renames a preset. If there is already a preset by the new_name

Packit f546b1
 it will be
Packit f546b1
overwritten.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

preset

Packit f546b1

a GObject that implements GstPreset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

old_name

Packit f546b1

current preset name

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

new_name

Packit f546b1

new preset name

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

TRUE for success, FALSE if e.g. there is no preset with old_name

Packit f546b1

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_preset_delete_preset ()

Packit f546b1
gboolean
Packit f546b1
gst_preset_delete_preset (GstPreset *preset,
Packit f546b1
                          const gchar *name);
Packit f546b1

Delete the given preset.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

preset

Packit f546b1

a GObject that implements GstPreset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

name

Packit f546b1

preset name to remove

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

TRUE for success, FALSE if e.g. there is no preset with that name

Packit f546b1

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_preset_set_meta ()

Packit f546b1
gboolean
Packit f546b1
gst_preset_set_meta (GstPreset *preset,
Packit f546b1
                     const gchar *name,
Packit f546b1
                     const gchar *tag,
Packit f546b1
                     const gchar *value);
Packit f546b1

Sets a new value

Packit f546b1
 for an existing meta data item or adds a new item. Meta
Packit f546b1
data tag
Packit f546b1
 names can be something like e.g. "comment". Supplying NULL for the
Packit f546b1
value
Packit f546b1
 will unset an existing value.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

preset

Packit f546b1

a GObject that implements GstPreset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

name

Packit f546b1

preset name

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

tag

Packit f546b1

meta data item name

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

value

Packit f546b1

new value.

Packit f546b1
[allow-none]
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

TRUE for success, FALSE if e.g. there is no preset with that name

Packit f546b1

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_preset_get_meta ()

Packit f546b1
gboolean
Packit f546b1
gst_preset_get_meta (GstPreset *preset,
Packit f546b1
                     const gchar *name,
Packit f546b1
                     const gchar *tag,
Packit f546b1
                     gchar **value);
Packit f546b1

Gets the value

Packit f546b1
 for an existing meta data tag
Packit f546b1
. Meta data tag
Packit f546b1
 names can be
Packit f546b1
something like e.g. "comment". Returned values need to be released when done.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

preset

Packit f546b1

a GObject that implements GstPreset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

name

Packit f546b1

preset name

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

tag

Packit f546b1

meta data item name

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

value

Packit f546b1

value.

Packit f546b1
[out callee-allocates]
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

TRUE for success, FALSE if e.g. there is no preset with that name

Packit f546b1
or no value for the given tag
Packit f546b1

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_preset_set_app_dir ()

Packit f546b1
gboolean
Packit f546b1
gst_preset_set_app_dir (const gchar *app_dir);
Packit f546b1

Sets an extra directory as an absolute path that should be considered when

Packit f546b1
looking for presets. Any presets in the application dir will shadow the
Packit f546b1
system presets.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

app_dir

Packit f546b1

the application specific preset dir.

Packit f546b1
[type filename]
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

TRUE for success, FALSE if the dir already has been set

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_preset_get_app_dir ()

Packit f546b1
const gchar *
Packit f546b1
gst_preset_get_app_dir (void);
Packit f546b1

Gets the directory for application specific presets if set by the

Packit f546b1
application.

Packit f546b1
Packit f546b1

Returns

Packit f546b1

the directory or NULL, don't free or modify

Packit f546b1
the string. 

Packit f546b1

[nullable][type filename]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_preset_is_editable ()

Packit f546b1
gboolean
Packit f546b1
gst_preset_is_editable (GstPreset *preset);
Packit f546b1

Check if one can add new presets, change existing ones and remove presets.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

preset

Packit f546b1

a GObject that implements GstPreset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

TRUE if presets are editable or FALSE if they are static

Packit f546b1
Packit f546b1

Since: 1.6

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Types and Values

Packit f546b1
Packit f546b1

GstPreset

Packit f546b1
typedef struct _GstPreset GstPreset;
Packit f546b1

Opaque GstPreset data structure.

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

struct GstPresetInterface

Packit f546b1
struct GstPresetInterface {
Packit f546b1
  GTypeInterface parent;
Packit f546b1
Packit f546b1
  /* methods */
Packit f546b1
  gchar**      (*get_preset_names)    (GstPreset *preset);
Packit f546b1
Packit f546b1
  gchar**      (*get_property_names)  (GstPreset *preset);
Packit f546b1
Packit f546b1
  gboolean     (*load_preset)         (GstPreset *preset, const gchar *name);
Packit f546b1
  gboolean     (*save_preset)         (GstPreset *preset, const gchar *name);
Packit f546b1
  gboolean     (*rename_preset)       (GstPreset *preset, const gchar *old_name,
Packit f546b1
                                       const gchar *new_name);
Packit f546b1
  gboolean     (*delete_preset)       (GstPreset *preset, const gchar *name);
Packit f546b1
Packit f546b1
  gboolean     (*set_meta)            (GstPreset *preset, const gchar *name,
Packit f546b1
                                       const gchar *tag, const gchar *value);
Packit f546b1
  gboolean     (*get_meta)            (GstPreset *preset, const gchar *name,
Packit f546b1
                                       const gchar *tag, gchar **value);
Packit f546b1
};
Packit f546b1
Packit f546b1

GstPreset interface.

Packit f546b1
Packit f546b1

Members

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

GTypeInterface parent;

Packit f546b1

parent interface type.

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

get_preset_names ()

Packit f546b1

virtual method to get list of presets

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

get_property_names ()

Packit f546b1

virtual methods to get properties that are persistent

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

load_preset ()

Packit f546b1

virtual methods to load a preset into properties

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

save_preset ()

Packit f546b1

virtual methods to save properties into a preset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

rename_preset ()

Packit f546b1

virtual methods to rename a preset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

delete_preset ()

Packit f546b1

virtual methods to remove a preset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

set_meta ()

Packit f546b1

virtual methods to set textual meta data to a preset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

get_meta ()

Packit f546b1

virtual methods to get textual meta data from a preset

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Generated by GTK-Doc V1.27
Packit f546b1
</body>
Packit f546b1
</html>