Document preset-iface vmethods.

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gstpreset.h:
Document preset-iface vmethods.
This commit is contained in:
Stefan Kost 2008-08-11 08:06:20 +00:00
parent b85a3e4afc
commit bdbd0bfac4
3 changed files with 27 additions and 2 deletions

View file

@ -1,3 +1,9 @@
2008-08-11 Stefan Kost <ensonic@users.sf.net>
* docs/gst/gstreamer-sections.txt:
* gst/gstpreset.h:
Document preset-iface vmethods.
2008-08-11 Stefan Kost <ensonic@users.sf.net>
* docs/manual/advanced-interfaces.xml:

View file

@ -1690,6 +1690,7 @@ gst_poll_wait
<FILE>gstpreset</FILE>
<TITLE>GstPreset</TITLE>
GstPreset
GstPresetInterface
gst_preset_get_preset_names
gst_preset_get_property_names
gst_preset_load_preset
@ -1699,7 +1700,6 @@ gst_preset_delete_preset
gst_preset_set_meta
gst_preset_get_meta
<SUBSECTION Standard>
GstPresetInterface
GST_PRESET
GST_IS_PRESET
GST_TYPE_PRESET

View file

@ -32,14 +32,33 @@ G_BEGIN_DECLS
#define GST_IS_PRESET(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PRESET))
#define GST_PRESET_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GST_TYPE_PRESET, GstPresetInterface))
/**
* GstPreset:
*
* Opaque #GstPreset data structure.
*/
typedef struct _GstPreset GstPreset; /* dummy object */
typedef struct _GstPresetInterface GstPresetInterface;
/**
* GstPresetInterface:
* @parent: parent interface type.
* @get_preset_names: virtual method to get list of presets
* @get_property_names: virtual methods to get properties that are persistent
* @load_preset: virtual methods to load a preset into properties
* @save_preset: virtual methods to save properties into a preset
* @rename_preset: virtual methods to rename a preset
* @delete_preset: virtual methods to remove a preset
* @set_meta: virtual methods to set textual meta data to a preset
* @get_meta: virtual methods to get textual meta data from a preset
*
* #GstPresetInterface interface.
*/
struct _GstPresetInterface
{
GTypeInterface parent;
/* methods */
gchar** (*get_preset_names) (GstPreset *preset);
gchar** (*get_property_names) (GstPreset *preset);