docs/gst/gstreamer-sections.txt: More doc hacking.
authorDavid Schleef <ds@schleef.org>
Fri, 26 Mar 2004 03:46:16 +0000 (03:46 +0000)
committerDavid Schleef <ds@schleef.org>
Fri, 26 Mar 2004 03:46:16 +0000 (03:46 +0000)
Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:  More doc hacking.
* docs/gst/tmpl/gstaggregator.sgml:
* docs/gst/tmpl/gstautoplugfactory.sgml:
* docs/gst/tmpl/gstbin.sgml:
* docs/gst/tmpl/gstbuffer.sgml:
* docs/gst/tmpl/gstbufferstore.sgml:
* docs/gst/tmpl/gstfakesink.sgml:
* docs/gst/tmpl/gstfakesrc.sgml:
* docs/gst/tmpl/gstmd5sink.sgml:
* docs/gst/tmpl/gstreamer-unused.sgml:
* docs/gst/tmpl/gstsearchfuncs.sgml:
* docs/gst/tmpl/gstshaper.sgml:
* docs/gst/tmpl/gstspider.sgml:
* docs/gst/tmpl/gsttee.sgml:
* docs/gst/tmpl/gstutils.sgml:
* docs/gst/tmpl/gstvalue.sgml:
* docs/gst/tmpl/gstxml.sgml:
* gst/Makefile.am:  Remove gstthreaddummy.c.  It never worked,
and we don't support it.
* gst/gst.c: (gst_init_get_popt_table), (init_pre), (init_post),
(gst_use_threads), (gst_has_threads): same
* gst/gstthreaddummy.c: same
* gst/autoplug/gstspider.c: Make gst_spider_details static.
* gst/autoplug/gstspider.h: same
* gst/elements/gstaggregator.h: Remove bogus function from header
* gst/elements/gstfakesink.h: same
* gst/elements/gstfakesrc.h: same
* gst/elements/gstmd5sink.h: same
* gst/elements/gstshaper.h: same
* gst/elements/gsttee.h: same
* gst/gstbin.c: doc fixes
* gst/gstbin.h: Remove unused definition.
* gst/gstbuffer.c: doc fixes
* gst/gstcaps.c: (gst_caps_is_always_compatible): doc fixes
* gst/gstfilter.c: doc fixes
* gst/gsttag.c: doc fixes
* gst/gstvalue.c: doc fixes

43 files changed:
ChangeLog
docs/gst/gstreamer-sections.txt
docs/gst/tmpl/gstaggregator.sgml
docs/gst/tmpl/gstautoplugfactory.sgml [deleted file]
docs/gst/tmpl/gstbin.sgml
docs/gst/tmpl/gstbuffer.sgml
docs/gst/tmpl/gstbufferstore.sgml [deleted file]
docs/gst/tmpl/gstfakesink.sgml
docs/gst/tmpl/gstfakesrc.sgml
docs/gst/tmpl/gstmd5sink.sgml
docs/gst/tmpl/gstreamer-unused.sgml [deleted file]
docs/gst/tmpl/gstsearchfuncs.sgml [deleted file]
docs/gst/tmpl/gstshaper.sgml
docs/gst/tmpl/gstspider.sgml
docs/gst/tmpl/gsttee.sgml
docs/gst/tmpl/gstutils.sgml
docs/gst/tmpl/gstvalue.sgml
docs/gst/tmpl/gstxml.sgml
gst/Makefile.am
gst/autoplug/gstspider.c
gst/autoplug/gstspider.h
gst/elements/gstaggregator.h
gst/elements/gstfakesink.h
gst/elements/gstfakesrc.h
gst/elements/gstmd5sink.h
gst/elements/gstshaper.h
gst/elements/gsttee.h
gst/gst.c
gst/gstbin.c
gst/gstbin.h
gst/gstbuffer.c
gst/gstcaps.c
gst/gstfilter.c
gst/gsttag.c
gst/gsttaglist.c
gst/gstthreaddummy.c [deleted file]
gst/gstvalue.c
plugins/elements/gstaggregator.h
plugins/elements/gstfakesink.h
plugins/elements/gstfakesrc.h
plugins/elements/gstmd5sink.h
plugins/elements/gstshaper.h
plugins/elements/gsttee.h

index 794bd14..b267045 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,43 @@
+2004-03-25  David Schleef  <ds@schleef.org>
+
+       * docs/gst/gstreamer-sections.txt:  More doc hacking.
+       * docs/gst/tmpl/gstaggregator.sgml:
+       * docs/gst/tmpl/gstautoplugfactory.sgml:
+       * docs/gst/tmpl/gstbin.sgml:
+       * docs/gst/tmpl/gstbuffer.sgml:
+       * docs/gst/tmpl/gstbufferstore.sgml:
+       * docs/gst/tmpl/gstfakesink.sgml:
+       * docs/gst/tmpl/gstfakesrc.sgml:
+       * docs/gst/tmpl/gstmd5sink.sgml:
+       * docs/gst/tmpl/gstreamer-unused.sgml:
+       * docs/gst/tmpl/gstsearchfuncs.sgml:
+       * docs/gst/tmpl/gstshaper.sgml:
+       * docs/gst/tmpl/gstspider.sgml:
+       * docs/gst/tmpl/gsttee.sgml:
+       * docs/gst/tmpl/gstutils.sgml:
+       * docs/gst/tmpl/gstvalue.sgml:
+       * docs/gst/tmpl/gstxml.sgml:
+       * gst/Makefile.am:  Remove gstthreaddummy.c.  It never worked,
+       and we don't support it.
+       * gst/gst.c: (gst_init_get_popt_table), (init_pre), (init_post),
+       (gst_use_threads), (gst_has_threads): same
+       * gst/gstthreaddummy.c: same
+       * gst/autoplug/gstspider.c: Make gst_spider_details static.
+       * gst/autoplug/gstspider.h: same
+       * gst/elements/gstaggregator.h: Remove bogus function from header
+       * gst/elements/gstfakesink.h: same
+       * gst/elements/gstfakesrc.h: same
+       * gst/elements/gstmd5sink.h: same
+       * gst/elements/gstshaper.h: same
+       * gst/elements/gsttee.h: same
+       * gst/gstbin.c: doc fixes
+       * gst/gstbin.h: Remove unused definition.
+       * gst/gstbuffer.c: doc fixes
+       * gst/gstcaps.c: (gst_caps_is_always_compatible): doc fixes
+       * gst/gstfilter.c: doc fixes
+       * gst/gsttag.c: doc fixes
+       * gst/gstvalue.c: doc fixes
+
 2004-03-25  Ronald Bultje  <rbultje@ronald.bitfreak.net>
 
        * docs/pwg/advanced-types.xml:
index fb1f5d2..184f4a5 100644 (file)
@@ -1,7 +1,6 @@
 <SECTION>
 <FILE>gstbin</FILE>
 GST_BIN_CLASS
-GstBinPrePostIterateFunction
 GstBinFlags
 <TITLE>GstBin</TITLE>
 gst_bin_new
@@ -20,8 +19,6 @@ gst_bin_get_clock
 gst_bin_auto_clock
 gst_bin_sync_children_state
 gst_bin_child_state_change
-gst_bin_set_pre_iterate_function
-gst_bin_set_post_iterate_function
 <SUBSECTION Standard>
 GST_BIN
 GST_IS_BIN
@@ -1192,7 +1189,6 @@ GST_XML_GET_CLASS
 
 <SECTION>
 <FILE>gstspider</FILE>
-gst_spider_details
 GstSpiderConnection
 <TITLE>GstSpider</TITLE>
 gst_spider_identity_plug
@@ -1225,7 +1221,6 @@ GST_IS_SPIDER_IDENTITY_CLASS
 <FILE>gstaggregator</FILE>
 GstAggregatorSchedType
 <TITLE>GstAggregator</TITLE>
-gst_aggregator_factory_init
 <SUBSECTION Standard>
 GST_AGGREGATOR
 GST_IS_AGGREGATOR
@@ -1257,7 +1252,6 @@ GST_BUFFER_STORE_GET_CLASS
 <FILE>gstfakesink</FILE>
 GstFakeSinkStateError
 <TITLE>GstFakeSink</TITLE>
-gst_fakesink_factory_init
 <SUBSECTION Standard>
 GST_FAKESINK
 GST_IS_FAKESINK
@@ -1274,7 +1268,6 @@ GstFakeSrcDataType
 GstFakeSrcSizeType
 GstFakeSrcFillType
 <TITLE>GstFakeSrc</TITLE>
-gst_fakesrc_factory_init
 <SUBSECTION Standard>
 GST_FAKESRC
 GST_IS_FAKESRC
@@ -1349,7 +1342,6 @@ GST_IS_IDENTITY_CLASS
 <SECTION>
 <FILE>gstmd5sink</FILE>
 <TITLE>GstMD5Sink</TITLE>
-gst_md5sink_factory_init
 <SUBSECTION Standard>
 GST_MD5SINK
 GST_IS_MD5SINK
@@ -1376,7 +1368,6 @@ GST_IS_PIPEFILTER_CLASS
 <FILE>gstshaper</FILE>
 GstShaperPolicyType
 <TITLE>GstShaper</TITLE>
-gst_shaper_factory_init
 <SUBSECTION Standard>
 GST_SHAPER
 GST_IS_SHAPER
@@ -1402,7 +1393,6 @@ GST_IS_STATISTICS_CLASS
 <SECTION>
 <FILE>gsttee</FILE>
 <TITLE>GstTee</TITLE>
-gst_tee_factory_init
 <SUBSECTION Standard>
 GST_TEE
 GST_IS_TEE
@@ -1502,32 +1492,6 @@ cothread_current
 </SECTION>
 
 <SECTION>
-<FILE>gettext</FILE>
-gettext
-dgettext
-dcgettext
-ngettext
-dngettext
-dcngettext
-textdomain
-bindtextdomain
-bind_textdomain_codeset
-gettext_noop
-</SECTION>
-
-<SECTION>
-<FILE>gst-i18n-app</FILE>
-_
-N_
-</SECTION>
-
-<SECTION>
-<FILE>gst-i18n-lib</FILE>
-_
-N_
-</SECTION>
-
-<SECTION>
 <FILE>gst</FILE>
 gst_init
 gst_init_check
@@ -1602,6 +1566,131 @@ PPC405_ERR77
 </SECTION>
 
 <SECTION>
+<FILE>gstenumtypes</FILE>
+gst_object_flags_get_type
+GST_TYPE_OBJECT_FLAGS
+gst_bin_flags_get_type
+GST_TYPE_BIN_FLAGS
+gst_buffer_flag_get_type
+GST_TYPE_BUFFER_FLAG
+gst_clock_entry_status_get_type
+GST_TYPE_CLOCK_ENTRY_STATUS
+gst_clock_entry_type_get_type
+GST_TYPE_CLOCK_ENTRY_TYPE
+gst_clock_return_get_type
+GST_TYPE_CLOCK_RETURN
+gst_clock_flags_get_type
+GST_TYPE_CLOCK_FLAGS
+gst_cpu_flags_get_type
+GST_TYPE_CPU_FLAGS
+gst_data_flags_get_type
+GST_TYPE_DATA_FLAGS
+gst_element_flags_get_type
+GST_TYPE_ELEMENT_FLAGS
+gst_core_error_get_type
+GST_TYPE_CORE_ERROR
+gst_library_error_get_type
+GST_TYPE_LIBRARY_ERROR
+gst_resource_error_get_type
+GST_TYPE_RESOURCE_ERROR
+gst_stream_error_get_type
+GST_TYPE_STREAM_ERROR
+gst_event_type_get_type
+GST_TYPE_EVENT_TYPE
+gst_event_flag_get_type
+GST_TYPE_EVENT_FLAG
+gst_seek_type_get_type
+GST_TYPE_SEEK_TYPE
+gst_seek_accuracy_get_type
+GST_TYPE_SEEK_ACCURACY
+gst_format_get_type
+GST_TYPE_FORMAT
+gst_index_certainty_get_type
+GST_TYPE_INDEX_CERTAINTY
+gst_index_entry_type_get_type
+GST_TYPE_INDEX_ENTRY_TYPE
+gst_index_lookup_method_get_type
+GST_TYPE_INDEX_LOOKUP_METHOD
+gst_assoc_flags_get_type
+GST_TYPE_ASSOC_FLAGS
+gst_index_resolver_method_get_type
+GST_TYPE_INDEX_RESOLVER_METHOD
+gst_index_flags_get_type
+GST_TYPE_INDEX_FLAGS
+gst_debug_level_get_type
+GST_TYPE_DEBUG_LEVEL
+gst_debug_color_flags_get_type
+GST_TYPE_DEBUG_COLOR_FLAGS
+gst_pad_link_return_get_type
+GST_TYPE_PAD_LINK_RETURN
+gst_pad_direction_get_type
+GST_TYPE_PAD_DIRECTION
+gst_pad_flags_get_type
+GST_TYPE_PAD_FLAGS
+gst_pad_presence_get_type
+GST_TYPE_PAD_PRESENCE
+gst_pad_template_flags_get_type
+GST_TYPE_PAD_TEMPLATE_FLAGS
+gst_plugin_error_get_type
+GST_TYPE_PLUGIN_ERROR
+gst_query_type_get_type
+GST_TYPE_QUERY_TYPE
+gst_scheduler_flags_get_type
+GST_TYPE_SCHEDULER_FLAGS
+gst_scheduler_state_get_type
+GST_TYPE_SCHEDULER_STATE
+gst_tag_merge_mode_get_type
+GST_TYPE_TAG_MERGE_MODE
+gst_tag_flag_get_type
+GST_TYPE_TAG_FLAG
+gst_thread_state_get_type
+GST_TYPE_THREAD_STATE
+gst_alloc_trace_flags_get_type
+GST_TYPE_ALLOC_TRACE_FLAGS
+gst_type_find_probability_get_type
+GST_TYPE_TYPE_FIND_PROBABILITY
+gst_element_state_get_type
+GST_TYPE_ELEMENT_STATE
+gst_element_state_return_get_type
+GST_TYPE_ELEMENT_STATE_RETURN
+gst_result_get_type
+GST_TYPE_RESULT
+gst_uri_type_get_type
+GST_TYPE_URI_TYPE
+gst_registry_return_get_type
+GST_TYPE_REGISTRY_RETURN
+gst_registry_flags_get_type
+GST_TYPE_REGISTRY_FLAGS
+gst_parse_error_get_type
+GST_TYPE_PARSE_ERROR
+</SECTION>
+
+<SECTION>
+<FILE>gstmarshal</FILE>
+gst_marshal_VOID__VOID
+gst_marshal_VOID__BOOLEAN
+gst_marshal_VOID__INT
+gst_marshal_VOID__STRING
+gst_marshal_VOID__BOXED
+gst_marshal_VOID__POINTER
+gst_marshal_VOID__POINTER_OBJECT
+gst_marshal_VOID__OBJECT
+gst_marshal_VOID__OBJECT_PARAM
+gst_marshal_VOID__OBJECT_POINTER
+gst_marshal_VOID__OBJECT_BOXED
+gst_marshal_VOID__OBJECT_OBJECT_STRING
+gst_marshal_VOID__OBJECT_STRING
+gst_marshal_VOID__INT_INT
+gst_marshal_VOID__INT64
+gst_marshal_VOID__UINT_BOXED
+gst_marshal_VOID__UINT_POINTER
+gst_marshal_BOOLEAN__VOID
+gst_marshal_BOOLEAN__POINTER
+gst_marshal_POINTER__POINTER
+gst_marshal_BOXED__BOXED
+</SECTION>
+
+<SECTION>
 <FILE>gstcpu</FILE>
 GstCPUFlags
 gst_cpu_get_flags
@@ -1612,26 +1701,6 @@ gst_cpu_get_flags
 </SECTION>
 
 <SECTION>
-<FILE>gsterror</FILE>
-GstCoreError
-GstLibraryError
-GstResourceError
-GstStreamError
-GST_TYPE_G_ERROR
-GST_LIBRARY_ERROR
-GST_RESOURCE_ERROR
-GST_CORE_ERROR
-GST_STREAM_ERROR
-GST_ERROR_SYSTEM
-gst_g_error_get_type
-gst_error_get_message
-gst_stream_error_quark
-gst_core_error_quark
-gst_resource_error_quark
-gst_library_error_quark
-</SECTION>
-
-<SECTION>
 <FILE>gstfilter</FILE>
 GstFilterFunc
 gst_filter_run
@@ -2012,128 +2081,49 @@ gst_version
 </SECTION>
 
 <SECTION>
-<FILE>gstenumtypes</FILE>
-gst_object_flags_get_type
-GST_TYPE_OBJECT_FLAGS
-gst_bin_flags_get_type
-GST_TYPE_BIN_FLAGS
-gst_buffer_flag_get_type
-GST_TYPE_BUFFER_FLAG
-gst_clock_entry_status_get_type
-GST_TYPE_CLOCK_ENTRY_STATUS
-gst_clock_entry_type_get_type
-GST_TYPE_CLOCK_ENTRY_TYPE
-gst_clock_return_get_type
-GST_TYPE_CLOCK_RETURN
-gst_clock_flags_get_type
-GST_TYPE_CLOCK_FLAGS
-gst_cpu_flags_get_type
-GST_TYPE_CPU_FLAGS
-gst_data_flags_get_type
-GST_TYPE_DATA_FLAGS
-gst_element_flags_get_type
-GST_TYPE_ELEMENT_FLAGS
-gst_core_error_get_type
-GST_TYPE_CORE_ERROR
-gst_library_error_get_type
-GST_TYPE_LIBRARY_ERROR
-gst_resource_error_get_type
-GST_TYPE_RESOURCE_ERROR
-gst_stream_error_get_type
-GST_TYPE_STREAM_ERROR
-gst_event_type_get_type
-GST_TYPE_EVENT_TYPE
-gst_event_flag_get_type
-GST_TYPE_EVENT_FLAG
-gst_seek_type_get_type
-GST_TYPE_SEEK_TYPE
-gst_seek_accuracy_get_type
-GST_TYPE_SEEK_ACCURACY
-gst_format_get_type
-GST_TYPE_FORMAT
-gst_index_certainty_get_type
-GST_TYPE_INDEX_CERTAINTY
-gst_index_entry_type_get_type
-GST_TYPE_INDEX_ENTRY_TYPE
-gst_index_lookup_method_get_type
-GST_TYPE_INDEX_LOOKUP_METHOD
-gst_assoc_flags_get_type
-GST_TYPE_ASSOC_FLAGS
-gst_index_resolver_method_get_type
-GST_TYPE_INDEX_RESOLVER_METHOD
-gst_index_flags_get_type
-GST_TYPE_INDEX_FLAGS
-gst_debug_level_get_type
-GST_TYPE_DEBUG_LEVEL
-gst_debug_color_flags_get_type
-GST_TYPE_DEBUG_COLOR_FLAGS
-gst_pad_link_return_get_type
-GST_TYPE_PAD_LINK_RETURN
-gst_pad_direction_get_type
-GST_TYPE_PAD_DIRECTION
-gst_pad_flags_get_type
-GST_TYPE_PAD_FLAGS
-gst_pad_presence_get_type
-GST_TYPE_PAD_PRESENCE
-gst_pad_template_flags_get_type
-GST_TYPE_PAD_TEMPLATE_FLAGS
-gst_plugin_error_get_type
-GST_TYPE_PLUGIN_ERROR
-gst_query_type_get_type
-GST_TYPE_QUERY_TYPE
-gst_scheduler_flags_get_type
-GST_TYPE_SCHEDULER_FLAGS
-gst_scheduler_state_get_type
-GST_TYPE_SCHEDULER_STATE
-gst_tag_merge_mode_get_type
-GST_TYPE_TAG_MERGE_MODE
-gst_tag_flag_get_type
-GST_TYPE_TAG_FLAG
-gst_thread_state_get_type
-GST_TYPE_THREAD_STATE
-gst_alloc_trace_flags_get_type
-GST_TYPE_ALLOC_TRACE_FLAGS
-gst_type_find_probability_get_type
-GST_TYPE_TYPE_FIND_PROBABILITY
-gst_element_state_get_type
-GST_TYPE_ELEMENT_STATE
-gst_element_state_return_get_type
-GST_TYPE_ELEMENT_STATE_RETURN
-gst_result_get_type
-GST_TYPE_RESULT
-gst_uri_type_get_type
-GST_TYPE_URI_TYPE
-gst_registry_return_get_type
-GST_TYPE_REGISTRY_RETURN
-gst_registry_flags_get_type
-GST_TYPE_REGISTRY_FLAGS
-gst_parse_error_get_type
-GST_TYPE_PARSE_ERROR
+<FILE>gettext</FILE>
+gettext
+dgettext
+dcgettext
+ngettext
+dngettext
+dcngettext
+textdomain
+bindtextdomain
+bind_textdomain_codeset
+gettext_noop
 </SECTION>
 
 <SECTION>
-<FILE>gstmarshal</FILE>
-gst_marshal_VOID__VOID
-gst_marshal_VOID__BOOLEAN
-gst_marshal_VOID__INT
-gst_marshal_VOID__STRING
-gst_marshal_VOID__BOXED
-gst_marshal_VOID__POINTER
-gst_marshal_VOID__POINTER_OBJECT
-gst_marshal_VOID__OBJECT
-gst_marshal_VOID__OBJECT_PARAM
-gst_marshal_VOID__OBJECT_POINTER
-gst_marshal_VOID__OBJECT_BOXED
-gst_marshal_VOID__OBJECT_OBJECT_STRING
-gst_marshal_VOID__OBJECT_STRING
-gst_marshal_VOID__INT_INT
-gst_marshal_VOID__INT64
-gst_marshal_VOID__UINT_BOXED
-gst_marshal_VOID__UINT_POINTER
-gst_marshal_BOOLEAN__VOID
-gst_marshal_BOOLEAN__POINTER
-gst_marshal_POINTER__POINTER
-gst_marshal_BOXED__BOXED
+<FILE>gsterror</FILE>
+GstCoreError
+GstLibraryError
+GstResourceError
+GstStreamError
+GST_TYPE_G_ERROR
+GST_LIBRARY_ERROR
+GST_RESOURCE_ERROR
+GST_CORE_ERROR
+GST_STREAM_ERROR
+GST_ERROR_SYSTEM
+gst_g_error_get_type
+gst_error_get_message
+gst_stream_error_quark
+gst_core_error_quark
+gst_resource_error_quark
+gst_library_error_quark
+</SECTION>
+
+<SECTION>
+<FILE>gst-i18n-app</FILE>
+_
+N_
+</SECTION>
+
+<SECTION>
+<FILE>gst-i18n-lib</FILE>
+_
+N_
 </SECTION>
 
 <SECTION>
index 51bcc6d..6607bb0 100644 (file)
@@ -24,12 +24,3 @@ methods to request buffers from its pads.
 @AGGREGATOR_LOOP_SELECT: 
 @AGGREGATOR_CHAIN: 
 
-<!-- ##### FUNCTION gst_aggregator_factory_init ##### -->
-<para>
-
-</para>
-
-@factory: 
-@Returns: 
-
-
diff --git a/docs/gst/tmpl/gstautoplugfactory.sgml b/docs/gst/tmpl/gstautoplugfactory.sgml
deleted file mode 100644 (file)
index a93d315..0000000
+++ /dev/null
@@ -1,85 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstAutoplugFactory
-
-<!-- ##### SECTION Short_Description ##### -->
-Create autopluggers from a factory.
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-An autoplugfactory is used to create instances of an autoplugger. It
-can be added to a #GstPlugin as it extends #GstPluginFeature.
-</para>
-<para>
-Use gst_autoplug_factory_new() to create a new autoplugger which can be registered 
-to a plugin with gst_plugin_add_feature().
-</para>
-<para>
-Use gst_autoplug_factory_find() to find the named autoplugfactory.
-or use gst_autoplug_factory_get_list() to get a  list of all available autopluggers.
-</para>
-<para>
-Once an autoplugfactory has been obtained use gst_autoplug_factory_create() to
-instantiate a real autoplugger. Optionally gst_autoplug_factory_make() to create
-a autoplugger from the named factory.
-</para>
-<para>
-Use gst_autoplug_factory_destroy() to remove the factory from the global list.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-#GstAutoplug, #GstPlugin, #GstPluginFeature.
-</para>
-
-<!-- ##### STRUCT GstAutoplugFactory ##### -->
-<para>
-The autoplugfactory object
-</para>
-
-
-<!-- ##### FUNCTION gst_autoplug_factory_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@longdesc: 
-@type: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_autoplug_factory_destroy ##### -->
-<para>
-
-</para>
-
-@factory: 
-
-
-<!-- ##### FUNCTION gst_autoplug_factory_find ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_autoplug_factory_create ##### -->
-<para>
-
-</para>
-
-@factory: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_autoplug_factory_make ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-
index a982c24..93d9e08 100644 (file)
@@ -63,16 +63,6 @@ clock providers in the bin.
 @klass: 
 
 
-<!-- ##### USER_FUNCTION GstBinPrePostIterateFunction ##### -->
-<para>
-The signature of the callback for the post and pre iterate function as set with
-gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function().
-</para>
-
-@bin: The bin that performed the callback
-@user_data: user data
-
-
 <!-- ##### ENUM GstBinFlags ##### -->
 <para>
 Flags for a bin.
@@ -235,26 +225,6 @@ Flags for a bin.
 @child: 
 
 
-<!-- ##### FUNCTION gst_bin_set_pre_iterate_function ##### -->
-<para>
-
-</para>
-
-@bin: 
-@func: 
-@user_data: 
-
-
-<!-- ##### FUNCTION gst_bin_set_post_iterate_function ##### -->
-<para>
-
-</para>
-
-@bin: 
-@func: 
-@user_data: 
-
-
 <!-- ##### SIGNAL GstBin::element-added ##### -->
 <para>
 
index 740af31..ffea9eb 100644 (file)
@@ -37,11 +37,6 @@ to create a buffer with preallocated
 data of a given size.
 </para>
 <para>
-GstBuffers can also be created from a #GstBufferPool with 
-gst_buffer_new_from_pool(). The bufferpool can be obtained from a
-peer element with gst_pad_get_bufferpool().
-</para>
-<para>
 gst_buffer_ref() is used to increase the refcount of a buffer. This must be
 done when you want to keep a handle to the buffer after pushing it to the
 next element.
diff --git a/docs/gst/tmpl/gstbufferstore.sgml b/docs/gst/tmpl/gstbufferstore.sgml
deleted file mode 100644 (file)
index 66832f3..0000000
+++ /dev/null
@@ -1,63 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstBufferStore
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gst_buffer_store_new ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_buffer_store_clear ##### -->
-<para>
-
-</para>
-
-@store: 
-
-
-<!-- ##### FUNCTION gst_buffer_store_add_buffer ##### -->
-<para>
-
-</para>
-
-@store: 
-@buffer: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_buffer_store_get_buffer ##### -->
-<para>
-
-</para>
-
-@store: 
-@offset: 
-@size: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_buffer_store_get_size ##### -->
-<para>
-
-</para>
-
-@store: 
-@offset: 
-@Returns: 
-
-
index aa46096..52e1b75 100644 (file)
@@ -29,12 +29,3 @@ with the buffer. (fakesink)
 @FAKESINK_STATE_ERROR_PAUSED_READY: 
 @FAKESINK_STATE_ERROR_READY_NULL: 
 
-<!-- ##### FUNCTION gst_fakesink_factory_init ##### -->
-<para>
-
-</para>
-
-@factory: 
-@Returns: 
-
-
index 23d8b87..4cef456 100644 (file)
@@ -56,12 +56,3 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
 @FAKESRC_FILLTYPE_PATTERN: 
 @FAKESRC_FILLTYPE_PATTERN_CONT: 
 
-<!-- ##### FUNCTION gst_fakesrc_factory_init ##### -->
-<para>
-
-</para>
-
-@factory: 
-@Returns: 
-
-
index 944ef7a..95b6f52 100644 (file)
@@ -14,12 +14,3 @@ GstMD5Sink
 
 </para>
 
-<!-- ##### FUNCTION gst_md5sink_factory_init ##### -->
-<para>
-
-</para>
-
-@factory: 
-@Returns: 
-
-
diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml
deleted file mode 100644 (file)
index 3778433..0000000
+++ /dev/null
@@ -1,8951 +0,0 @@
-<!-- ##### SECTION ./tmpl/GstBin.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstBin.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstBin.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GstBin.sgml:Title ##### -->
-GstBin
-
-
-<!-- ##### SECTION ./tmpl/GstBuffer.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstBuffer.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstBuffer.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GstBuffer.sgml:Title ##### -->
-GstBuffer
-
-
-<!-- ##### SECTION ./tmpl/GstCaps.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstCaps.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstCaps.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GstCaps.sgml:Title ##### -->
-GstCaps
-
-
-<!-- ##### SECTION ./tmpl/GstClock.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstClock.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstClock.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GstClock.sgml:Title ##### -->
-GstClock
-
-
-<!-- ##### SECTION ./tmpl/GstCompat.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstCompat.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstCompat.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GstCompat.sgml:Title ##### -->
-GstCompat
-
-
-<!-- ##### SECTION ./tmpl/GstData.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstData.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstData.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GstData.sgml:Title ##### -->
-GstData
-
-
-<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstElement.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GstElement.sgml:Title ##### -->
-GstElement
-
-
-<!-- ##### SECTION ./tmpl/GstEvent.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstEvent.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstEvent.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GstEvent.sgml:Title ##### -->
-GstEvent
-
-
-<!-- ##### SECTION ./tmpl/GstIndex.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstIndex.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstIndex.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GstIndex.sgml:Title ##### -->
-GstIndexFactory
-
-
-<!-- ##### SECTION ./tmpl/GstStructure.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstStructure.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstStructure.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GstStructure.sgml:Title ##### -->
-GstStructure
-
-
-<!-- ##### SECTION ./tmpl/GstTag.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstTag.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GstTag.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GstTag.sgml:Title ##### -->
-GstTag
-
-
-<!-- ##### SECTION ./tmpl/audioraw.sgml:Long_Description ##### -->
-<para>
-Information about audio buffers.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/audioraw.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/audioraw.sgml:Short_Description ##### -->
-Information about audio buffers.
-
-
-<!-- ##### SECTION ./tmpl/audioraw.sgml:Title ##### -->
-audioraw
-
-
-<!-- ##### SECTION ./tmpl/gobject2gtk.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gobject2gtk.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gobject2gtk.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gobject2gtk.sgml:Title ##### -->
-GObject
-
-
-<!-- ##### SECTION ./tmpl/gstasyncdisksrc.sgml:Long_Description ##### -->
-<para>
-Reads data from a file. You can seek to a specific location by setting
-the offset.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstasyncdisksrc.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstasyncdisksrc.sgml:Title ##### -->
-GstAsyncDiskSrc
-
-
-<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Title ##### -->
-GstAudioSink
-
-
-<!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:Title ##### -->
-GstAudioSrc
-
-
-<!-- ##### SECTION ./tmpl/gstautoplug.sgml:Long_Description ##### -->
-<para>
-GstAutoplug is an abstract class that is used for constructing and 
-linking elements. Two types of autopluggers exist: renderer ones and non
-renderer ones. The renderer autopluggers will not have any src pads while the
-non renderer ones do.
-</para>
-
-<para>
-You first need to create a suitable autoplugger with gst_autoplug_factory_make() 
-(see #GstAutoplugFactory).
-The name of the autoplugger must be one of the registered autopluggers 
-(see #GstStaticAutoplug and #GstStaticAutoplugRender).
-</para>
-<para>
-If the autoplugger supports the RENDERER API, use gst_autoplug_to_renderers() to
-create a bin that links the src caps to the specified renderer elements. You can 
-then add the bin to a pipeline and run it.
-
-  <programlisting>
-  GstAutoplug *autoplug;
-  GstElement  *element;
-  GstElement  *sink;
-
-  /* create a static autoplugger */
-  autoplug = gst_autoplug_factory_make ("staticrender");
-
-  /* create an osssink */
-  sink = gst_element_factory_make ("osssink", "our_sink");
-
-  /* create an element that can play audio/mp3 through osssink */
-  element = gst_autoplug_to_renderers (autoplug, 
-                                      gst_caps_new (
-                                        "sink_audio_caps",
-                                        "audio/mp3",
-                                        NULL
-                                      ),
-                                      sink,
-                                      NULL);
-
-  /* add the element to a bin and link the sink pad */
-  ...
-  </programlisting>
-</para>
-<para>
-If the autoplugger supports the CAPS API, use gst_autoplug_to_caps() to
-link the src caps to the destination caps. The created bin will have src caps 
-compatible with the provided sink caps.
-
-  <programlisting>
-  GstAutoplug *autoplug;
-  GstElement  *element;
-
-  /* create a static autoplugger */
-  autoplug = gst_autoplug_factory_make ("static");
-
-  /* create an element that converts audio/mp3 to audio/raw */
-  element = gst_autoplug_to_caps (autoplug, 
-                                 gst_caps_new (
-                                   "sink_audio_caps",
-                                   "audio/mp3",
-                                   NULL
-                                 ),
-                                 gst_caps_new (
-                                   "src_audio_caps",
-                                   "audio/raw",
-                                   NULL
-                                 ),
-                                 NULL);
-
-  /* add the element to a bin and link the src/sink pads */
-  ...
-  </programlisting>
-</para>
-
-<para>
-Optionally you can get a notification when a new object is added to the created
-pipeline with a g_signal_connect to the "new_object" signal.
-</para>
-
-<para>
-Use the regular gst_object_destroy() call to destroy the autoplugger.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstautoplug.sgml:See_Also ##### -->
-<para>
-#GstStaticAutoplug, #GstStaticAutoplugRender
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstautoplug.sgml:Short_Description ##### -->
-Automatically create and link elements
-
-
-<!-- ##### SECTION ./tmpl/gstautoplug.sgml:Title ##### -->
-GstAutoplug
-
-
-<!-- ##### SECTION ./tmpl/gstautoplugfactory.sgml:Long_Description ##### -->
-<para>
-An autoplugfactory is used to create instances of an autoplugger. It
-can be added to a #GstPlugin as it extends #GstPluginFeature.
-</para>
-<para>
-Use gst_autoplug_factory_new() to create a new autoplugger which can be registered 
-to a plugin with gst_plugin_add_feature().
-</para>
-<para>
-Use gst_autoplug_factory_find() to find the named autoplugfactory.
-or use gst_autoplug_factory_get_list() to get a  list of all available autopluggers.
-</para>
-<para>
-Once an autoplugfactory has been obtained use gst_autoplug_factory_create() to
-instantiate a real autoplugger. Optionally gst_autoplug_factory_make() to create
-a autoplugger from the named factory.
-</para>
-<para>
-Use gst_autoplug_factory_destroy() to remove the factory from the global list.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstautoplugfactory.sgml:See_Also ##### -->
-<para>
-#GstAutoplug, #GstPlugin, #GstPluginFeature.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstautoplugfactory.sgml:Short_Description ##### -->
-Create autopluggers from a factory.
-
-
-<!-- ##### SECTION ./tmpl/gstautoplugfactory.sgml:Title ##### -->
-GstAutoplugFactory
-
-
-<!-- ##### SECTION ./tmpl/gstbufferpool-default.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstbufferpool-default.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstbufferpool-default.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gstbufferpool-default.sgml:Title ##### -->
-gstbufferpool-default
-
-
-<!-- ##### SECTION ./tmpl/gstcache.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstcache.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstcache.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gstcache.sgml:Title ##### -->
-GstCacheFactory
-
-
-<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Title ##### -->
-GstColorSpace
-
-
-<!-- ##### SECTION ./tmpl/gstdisksink.sgml:Long_Description ##### -->
-<para>
-The disksink write to a file. The filename can be given as an argument.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstdisksink.sgml:See_Also ##### -->
-<para>
-#GstFdSink
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstdisksink.sgml:Short_Description ##### -->
-Write to a file
-
-
-<!-- ##### SECTION ./tmpl/gstdisksink.sgml:Title ##### -->
-GstDiskSink
-
-
-<!-- ##### SECTION ./tmpl/gstdisksrc.sgml:Long_Description ##### -->
-<para>
-Asynchonously read buffers from a file. 
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstdisksrc.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstdisksrc.sgml:Short_Description ##### -->
-Asynchronous read from a file (disksrc)
-
-
-<!-- ##### SECTION ./tmpl/gstdisksrc.sgml:Title ##### -->
-GstDiskSrc
-
-
-<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:Title ##### -->
-GstElementFactory
-
-
-<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:Long_Description ##### -->
-<para>
-GstElementFactory is used to create instances of elements. A GstElementfactory
-can be added to a #GstPlugin as it is also a #GstPluginFeature.
-</para>
-<para>
-Use gst_element_factory_new() to create a new factory which can be added to a plugin 
-with gst_plugin_add_feature().
-</para>
-<para>
-gst_element_factory_add_pad_template() is used to add a padtemplate to the factory.
-This function will enable the application to query for elementfactories that handle
-a specific media type.
-</para>
-<para>
-Use the gst_element_factory_find() and gst_element_factory_create() functions
-to create element instances or use gst_element_factory_make() as a convenient 
-shortcut.
-</para>
-<para>
-The following code example shows you how to create a GstFileSrc element.
-</para>
-
-<para>
-  <programlisting role="C">
-  #include &lt;gst/gst.h&gt;
-
-  GstElement *src;
-  GstElementFactory *srcfactory;
-
-  gst_init(&amp;argc,&amp;argv);
-
-  srcfactory = gst_element_factory_find("filesrc");
-  g_return_if_fail(srcfactory != NULL);
-
-  src = gst_element_factory_create(srcfactory,"src");
-  g_return_if_fail(src != NULL);
-  ...
-  </programlisting>
-</para>
-<para>
-An elementfactory can be assigned a rank with gst_element_factory_set_rank() 
-so that the autopluggers can select a plugin more appropriatly
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:See_Also ##### -->
-<para>
-#GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:Short_Description ##### -->
-Create GstElements from a factory
-
-
-<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:Title ##### -->
-GstElementFactory
-
-
-<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstesdsink.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Title ##### -->
-GstEsdSink
-
-
-<!-- ##### SECTION ./tmpl/gstextratypes.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstextratypes.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstextratypes.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gstextratypes.sgml:Title ##### -->
-GstExtraTypes
-
-
-<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstgetbits.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Title ##### -->
-GstGetbits
-
-
-<!-- ##### SECTION ./tmpl/gsthttpsrc.sgml:Long_Description ##### -->
-<para>
-Reads data from a URL.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gsthttpsrc.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gsthttpsrc.sgml:Short_Description ##### -->
-Reads data from a URL. (httpsrc)
-
-
-<!-- ##### SECTION ./tmpl/gsthttpsrc.sgml:Title ##### -->
-GstHttpSrc
-
-
-<!-- ##### SECTION ./tmpl/gstindexfactory.sgml:Long_Description ##### -->
-<para>
-GstIndexFactory is used to dynamically create GstIndex implementations.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstindexfactory.sgml:See_Also ##### -->
-<para>
-#GstIndex
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstindexfactory.sgml:Short_Description ##### -->
-Create GstIndexes from a factory
-
-
-<!-- ##### SECTION ./tmpl/gstindexfactory.sgml:Title ##### -->
-GstIndexFactory
-
-
-<!-- ##### SECTION ./tmpl/gstlink.sgml:Long_Description ##### -->
-<para>
-A link is a base class for a generic link between
-elements. A link is typically a base class for queues.
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstlink.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstlink.sgml:Short_Description ##### -->
-Generic link between elements.
-
-
-<!-- ##### SECTION ./tmpl/gstlink.sgml:Title ##### -->
-GstLink
-
-
-<!-- ##### SECTION ./tmpl/gstmeta.sgml:Long_Description ##### -->
-<para>
-The point of the metadata is to provide some context for each buffer.  In
-the case of audio data, for instance, it would provide the samplerate, bit
-depth, and channel count.
-</para>
-
-<para>
-The trick is that there may be multiple types of metadata ganged onto a
-single buffer.  This is why they're going to be a GList.  This does mean
-extra overhead in all cases, but I think it's minimal.  The GList type
-uses a chunk allocater so we're not wasting too much memory or time when
-adding to the list.
-</para>
-
-<para>
-The trick is dealing with these structs as they pass through a pipeline,
-since they have potentially different mutability properties.  For
-instance, if you've got a mp3 decoder linked to a tee, which sends the
-buffers off to both the decoder and a spectrum analyzer (and then a
-visualization element).  The preferred setup would be where every time a
-audio/raw metadata comes down the pipe (indicating a potential change in
-audio format), the audiosink and spectrum would just save off pointers.
-</para>
-
-<para>
-So when exactly does this metadata go away (deallocated)?  Well, that
-means metadata has to be refcounted.  But that gets rather hairy.  OK, in
-the simple case you create a metadata struct, it comes with refcount set
-to 1.  You pass it through, it stays one, eventually someone drops the
-last reference on the buffer it's tied to, you free the metadata too.
-Easy.  What if you tee?  You could go through and for every metadata in
-the buffer, increment the refcount by the same as the buffer.  So in the
-above case (tee'd), the audiosink and spectrum would get the buffer with a
-refcount of 2, and it'd have a metadata with refcount 2.  Do they ref it
-each themselves, then unref the buffer?  Or do they remove the metadata?
-Removing the metadata would require a buffer CoW, which would suck, so
-yes, they'd just ref the metadata.
-</para>
-
-<para>
-But....  what if they're all in different threads?  Then we're off into
-the magical world of mutexes.  Everything with a refcount in a threaded
-world must be mutexed, else you can do atomic increment and atomic
-dec and test.  Can this be done from C easily?  Perhaps it needs to be found
-from kernel includes via autoconf?
-</para>
-
-<para>
-The goal in designing the way metadata will be defined and used is to keep
-it as simple as possible.  The basis for accomplishing this is the fact
-that in order to actually use (rather than just pass) the metadata, you
-have to know what the fields are, which means you have to have compiled in
-support for that metadata at build time.  Therefore, if you're using
-metadata, you must have build-time access to the necessary include file
-that defines it.
-</para>
-
-<para>
-So, given that you've got an include file, it would be nice if the whole
-thing could be contained there.  This would limit the need to be linked
-against something, or have load-time requirements as to that has to be
-loaded before you are.
-</para>
-
-<para>
-Given that really all metadata is is a region of memory of a given size
-with a certain signature, this isn't all that hard.  First you lay out the
-struct that defines the metadata.  Then you set up #defines that expand to
-the size of the struct in question, as well as the four-cc code that
-defines the type.
-</para>
-
-<para>
-The work is done by a few #defines, a la the #defines used in all Gtk
-objects.  The first is a NEW() method that allocates the memory for the
-metadata and fills in all the normal fields (type, size, utility
-functions).  Because of the way it's defined (as a #define, no less),
-you'll have to invoke it as META_NEW(meta), since it can't return()
-anything.
-</para>
-
-<para>
-Another #define will check to make sure a meta is indeed that type by
-verifying the type code and size.  Theoretically, meta types can overlap
-with the same fourcc code, as long as they have different sizes.  But I
-probably ought to have a global public registry so people writing things
-don't conflict.  MSFT got that right, at least.
-</para>
-
-<para>
-So, a hairy problem is what to do when there are utility functions
-associated with one of these things.  One option is to not bother with
-them.  This is very likely a possible solution, since metadata is supposed
-to be flat memory of a given size.  Not much to do to either free or copy
-it, is there?
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstmeta.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstmeta.sgml:Short_Description ##### -->
-Provide context for buffers
-
-
-<!-- ##### SECTION ./tmpl/gstmeta.sgml:Title ##### -->
-GstMeta
-
-
-<!-- ##### SECTION ./tmpl/gstmultidisksrc.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstmultidisksrc.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstmultidisksrc.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gstmultidisksrc.sgml:Title ##### -->
-GstMultiDiskSrc
-
-
-<!-- ##### SECTION ./tmpl/gstpadtemplate.sgml:Long_Description ##### -->
-<para>
-Padtemplates describe the possible media types a pad or an elementfactory can
-handle. 
-</para>
-<para>
-Pad and PadTemplates have #GstCaps attached to it to describe the media type they
-are capable of dealing with.  gst_pad_template_get_caps() is used to get the
-caps of a padtemplate. It's not possible to modify the caps of a padtemplate after
-creation. 
-</para>
-<para>
-Padtemplates can be created with gst_pad_template_new() or with the convenient
-GST_PAD_TEMPLATE_FACTORY() macro. A padtemplate can be used to create a pad or 
-to add to an elementfactory.
-</para>
-<para>
-The following code example shows the code to create a pad from a padtemplate.
-<programlisting>
-  GstStaticPadTemplate my_template =
-  GST_STATIC_PAD_TEMPLATE (
-    "sink",            /* the name of the pad */
-    GST_PAD_SINK,      /* the direction of the pad */
-    GST_PAD_ALWAYS,    /* when this pad will be present */
-    GST_STATIC_CAPS (  /* the capabilities of the padtemplate */
-      "audio/x-raw-int, "
-        "channels = (int) [ 1, 6 ]"
-    )
-  )
-
-  void
-  my_method (void) 
-  {
-    GstPad *pad;
-  
-    pad = gst_pad_new_from_template (GST_PAD_TEMPLATE_GET (my_template_factory), "sink");
-    ...
-  }
-</programlisting>
-</para>
-<para>
-The following example shows you how to add the padtemplate to an elementfactory:
-<programlisting>
-  gboolean
-  my_factory_init (GstPlugin *plugin)
-  {
-    GstElementFactory *factory;
-
-    factory = gst_element_factory_new ("my_factory", GST_TYPE_MYFACTORY, &amp;gst_myfactory_details);
-    g_return_val_if_fail (factory != NULL, FALSE);
-
-    gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (my_template_factory));
-
-    gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));
-
-    return TRUE;
-  }
-
-</programlisting>
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstpadtemplate.sgml:See_Also ##### -->
-<para>
-#GstPad, #GstElementFactory
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstpadtemplate.sgml:Short_Description ##### -->
-Describe the media type of a pad.
-
-
-<!-- ##### SECTION ./tmpl/gstpadtemplate.sgml:Title ##### -->
-GstPadTemplate
-
-
-<!-- ##### SECTION ./tmpl/gstschedulerfactory.sgml:Long_Description ##### -->
-<para>
-A schedulerfactory is used to create instances of a scheduler. It
-can be added to a #GstPlugin as it extends #GstPluginFeature.
-</para>
-<para>
-Use gst_scheduler_factory_new() to create a new scheduler which can be registered
-to a plugin with gst_plugin_add_feature().
-</para>
-<para>
-Use gst_scheduler_factory_find() to find the named schedulerfactory.
-or use gst_scheduler_factory_get_list() to get a  list of all available schedulers.
-</para>
-<para>
-Once an schedulerfactory has been obtained use gst_scheduler_factory_create() to
-instantiate a real scheduler. Optionally gst_scheduler_factory_make() to create
-a scheduler from the named factory.
-</para>
-<para>
-Use gst_scheduler_factory_destroy() to remove the factory from the global list.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstschedulerfactory.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstschedulerfactory.sgml:Short_Description ##### -->
-Create schedulers from a factory
-
-
-<!-- ##### SECTION ./tmpl/gstschedulerfactory.sgml:Title ##### -->
-GstSchedulerFactory
-
-
-<!-- ##### SECTION ./tmpl/gstsinesrc.sgml:Long_Description ##### -->
-<para>
-Create a sine wave of a given frequency and volume.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstsinesrc.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstsinesrc.sgml:Short_Description ##### -->
-Create a sine wave of a given frequency and volume. (sinesrc)
-
-
-<!-- ##### SECTION ./tmpl/gstsinesrc.sgml:Title ##### -->
-GstSineSrc
-
-
-<!-- ##### SECTION ./tmpl/gstsink.sgml:Long_Description ##### -->
-<para>
-The sink is the end of the filter graph. A typical sink would be an audio
-or a video card.
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstsink.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstsink.sgml:Short_Description ##### -->
-The end point of a filter graph
-
-
-<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
-GstSink
-
-
-<!-- ##### SECTION ./tmpl/gstsrc.sgml:Long_Description ##### -->
-<para>
-A GstSrc is the start of a filter graph. It typically is a file or an
-audio source. It provides data for the next element in the graph.
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstsrc.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstsrc.sgml:Short_Description ##### -->
-The start point of a filter graph
-
-
-<!-- ##### SECTION ./tmpl/gstsrc.sgml:Title ##### -->
-GstSrc
-
-
-<!-- ##### SECTION ./tmpl/gststaticautoplug.sgml:Long_Description ##### -->
-<para>
-This autoplugger will create a non threaded element before running the
-pipeline.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gststaticautoplug.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gststaticautoplug.sgml:Short_Description ##### -->
-A static autoplugger.
-
-
-<!-- ##### SECTION ./tmpl/gststaticautoplug.sgml:Title ##### -->
-GstStaticAutoplug
-
-
-<!-- ##### SECTION ./tmpl/gststaticautoplugrender.sgml:Long_Description ##### -->
-<para>
-this autoplugger will create a threaded element that can be used
-in media players.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gststaticautoplugrender.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gststaticautoplugrender.sgml:Short_Description ##### -->
-An autoplugger made for media playback
-
-
-<!-- ##### SECTION ./tmpl/gststaticautoplugrender.sgml:Title ##### -->
-GstStaticAutoplugRender
-
-
-<!-- ##### SECTION ./tmpl/gsttimecache.sgml:Long_Description ##### -->
-<para>
-This class is used by plugins to manage time vs byte offsets. It is mainly
-used for efficient seeking.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gsttimecache.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gsttimecache.sgml:Short_Description ##### -->
-Cache time and byteoffsets.
-
-
-<!-- ##### SECTION ./tmpl/gsttimecache.sgml:Title ##### -->
-GstTimeCache
-
-
-<!-- ##### SECTION ./tmpl/gsttypefindfactory.sgml:Long_Description ##### -->
-<para>
-These functions allow querying informations about registered typefind 
-functions. How to create and register these functions is described in
-the section <link linkend="gstreamer-Writing-typefind-functions">
-"Writing typefind functions"</link>.
-</para>
-<example>
-<title>how to write a simple typefinder</title>
-<programlisting>
-/* FIXME: compile this? ;) */
-typedef struct {
-  guint8 *data;
-  guint size;
-  guint probability;
-  GstCaps *data;
-} MyTypeFind;
-static void
-my_peek (gpointer data, gint64 offset, guint size)
-{
-  MyTypeFind *find = (MyTypeFind *) data;
-  if (offset &gt;= 0 &amp;&amp; offset + size &lt;= find->size) {
-    return find->data + offset;
-  }
-  return NULL;
-}
-static void
-my_suggest (gpointer data, guint probability, GstCaps *caps)
-{
-  MyTypeFind *find = (MyTypeFind *) data;
-  if (probability &gt; find->probability) {
-    find->probability = probability;
-    gst_caps_replace (&amp;find->caps, caps);
-  }
-}
-static GstCaps *
-find_type (guint8 *data, guint size)
-{
-  GList *walk, *type_list;
-  MyTypeFind find = {data, size, 0, NULL};
-  GstTypeFind gst_find = {my_peek, my_suggest, &amp;find, };
-  
-  walk = type_list = gst_type_find_factory_get_list ();
-  while (walk) {
-    GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (walk->data);
-    walk = g_list_next (walk)
-    gst_type_find_factory_call_function (factory, &amp;gst_find);
-  }
-  g_list_free (type_list);
-  return find.caps;
-};
-</programlisting>
-</example>
-<para>
-The above example shows how to write a very simple typefinder that identifies
-the given data. You can get quite a bit more complicated than that though.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gsttypefindfactory.sgml:See_Also ##### -->
-<para>
-<link linkend="gstreamer-Writing-typefind-functions">Writing typefind functions</link>
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gsttypefindfactory.sgml:Short_Description ##### -->
-information about registered typefind functions
-
-
-<!-- ##### SECTION ./tmpl/gsttypefindfactory.sgml:Title ##### -->
-GstTypeFindFactory
-
-
-<!-- ##### SECTION ./tmpl/plugin.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/plugin.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/plugin.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/plugin.sgml:Title ##### -->
-plugin
-
-
-<!-- ##### SECTION ./tmpl/spectrum.sgml:Long_Description ##### -->
-<para>
-Frequencies of a spectrum analysis.
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/spectrum.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/spectrum.sgml:Short_Description ##### -->
-Frequencies of a spectrum analysis.
-
-
-<!-- ##### SECTION ./tmpl/spectrum.sgml:Title ##### -->
-spectrum
-
-
-<!-- ##### SECTION ./tmpl/videoraw.sgml:Long_Description ##### -->
-<para>
-Information about video buffers.
-</para>
-
-
-<!-- ##### SECTION ./tmpl/videoraw.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/videoraw.sgml:Short_Description ##### -->
-Information about video buffers.
-
-
-<!-- ##### SECTION ./tmpl/videoraw.sgml:Title ##### -->
-videoraw
-
-
-<!-- ##### MACRO BLINK ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO COTHREAD_MAXTHREADS ##### -->
-<para>
-The maximum number of cothreads we are going to support.
-</para>
-
-
-<!-- ##### MACRO COTHREAD_STACKSIZE ##### -->
-<para>
-The default stack size of a cothread.
-</para>
-
-
-<!-- ##### MACRO CURRENT_STACK_FRAME ##### -->
-<para>
-Get the current stack frame.
-</para>
-
-
-<!-- ##### MACRO DEBUG ##### -->
-<para>
-Use this macro to show debugging info. This is only usefull when developing new
-plugin elements.
-If you #define DEBUG_ENABLED before including gst/gst.h, this macro will produce
-g_print messages.
-</para>
-
-@format: the format specification as in g_print
-@args...: arguments
-
-<!-- ##### MACRO DEBUG_ENTER ##### -->
-<para>
-
-</para>
-
-@format: 
-@args...: 
-
-<!-- ##### MACRO DEBUG_ENTER_STRING ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO DEBUG_LEAVE ##### -->
-<para>
-
-</para>
-
-@format: 
-@args...: 
-
-<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO DEBUG_NOPREFIX ##### -->
-<para>
-
-</para>
-
-@format: 
-@args...: 
-
-<!-- ##### MACRO DEBUG_SET_STRING ##### -->
-<para>
-
-</para>
-
-@format: 
-@args...: 
-
-<!-- ##### MACRO ERROR ##### -->
-<para>
-
-</para>
-
-@element: 
-@format: 
-@args...: 
-
-<!-- ##### MACRO ERROR_OBJECT ##### -->
-<para>
-
-</para>
-
-@element: 
-@object: 
-@format: 
-@args...: 
-
-<!-- ##### MACRO FLINK ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO FUNCTION ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GBaseInitFunc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GCallback ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GClassInitFunc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GEnumValue ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GInstanceInitFunc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GObject ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GParamFlags ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GParamSpec ##### -->
-<para>
-
-</para>
-
-@name: 
-@value_type: 
-@flags: 
-
-<!-- ##### MACRO GST_ASYNCDISKSRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_ASYNCDISKSRC_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_ATOMIC_INT_ADD ##### -->
-<para>
-Atomically add a value to a #GstAtomicInt
-</para>
-
-@ref: a reference to a #GstAtomicInt
-@count: The value to add
-
-<!-- ##### MACRO GST_ATOMIC_INT_DEC_AND_TEST ##### -->
-<para>
-Decrement the value of a #GstAtomicInt atomically and test
-for zero.
-</para>
-
-@ref: a reference to a #GstAtomicInt
-@zero: a gpointer to a gboolean to hold the value of the test
-
-<!-- ##### MACRO GST_ATOMIC_INT_FREE ##### -->
-<para>
-Free the memory allocated by #GST_ATOMIC_INT_INIT
-</para>
-
-@ref: A reference to a #GstAtomicInt
-
-<!-- ##### MACRO GST_ATOMIC_INT_INC ##### -->
-<para>
-Increment the value of a #GstAtomicInt atomically
-</para>
-
-@ref: a reference to a #GstAtomicInt
-
-<!-- ##### MACRO GST_ATOMIC_INT_INIT ##### -->
-<para>
-Initialize an atomic int
-</para>
-
-@ref: a reference to a #GstAtomicInt
-@val: The initial value for the integer
-
-<!-- ##### MACRO GST_ATOMIC_INT_READ ##### -->
-<para>
-Get the value of a #GstAtomicInt atomically into a variable
-</para>
-
-@ref: a reference to a #GstAtomicInt
-@res: a pointer to a gint to hold the value
-
-<!-- ##### MACRO GST_ATOMIC_INT_SET ##### -->
-<para>
-Set the value of a #GstAtomicInt atomically
-</para>
-
-@ref: a reference to a #GstAtomicInt
-@val: The value for the integer
-
-<!-- ##### MACRO GST_ATOMIC_INT_VALUE ##### -->
-<para>
-Get the value of a #GstAtomicInt atomically
-</para>
-
-@ref: a reference to a #GstAtomicInt
-
-<!-- ##### MACRO GST_ATOMIC_LOCK ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_ATOMIC_SWAP ##### -->
-<para>
-Atomically swap the value of the #GstAtomicSwap with a new value
-</para>
-
-@swap: a reference to a #GstAtomicSwap
-@val: the new value
-
-<!-- ##### MACRO GST_ATOMIC_SWAP_GET ##### -->
-<para>
-Atomically swap the value of the #GstAtomicSwap with a new value and
-get the old value.
-</para>
-
-@swap: a reference to a #GstAtomicSwap
-@val: the new value
-@res: the old value
-
-<!-- ##### MACRO GST_ATOMIC_SWAP_INIT ##### -->
-<para>
-Initialize an atomic swap structure
-</para>
-
-@swap: a reference to a #GstAtomicSwap
-@val: the initial value
-
-<!-- ##### MACRO GST_ATOMIC_SWAP_VALUE ##### -->
-<para>
-Get the value of a #GstAtomicSwap
-</para>
-
-@swap: a reference to a #GstAtomicSwap
-
-<!-- ##### MACRO GST_AUDIOSINK ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_AUDIOSRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_AUDIOSRC_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_AUTOPLUG_FACTORY ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_AUTOPLUG_FACTORY_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_BIN ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_BIN_CAST ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_BIN_CLASS_CAST ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_BUFFER ##### -->
-<para>
-Casts an object to a GstBuffer.
-</para>
-
-@buf: an object to cast.
-@Returns: the #GstBuffer to which the given object points.
-
-<!-- ##### MACRO GST_BUFFER_BUFFERPOOL ##### -->
-<para>
-Gets the bufferpool for this buffer.
-</para>
-
-@buf: a #GstBuffer to get the bufferpool of.
-@Returns: the #GstBufferPool of this buffer.
-
-<!-- ##### MACRO GST_BUFFER_LOCK ##### -->
-<para>
-Obtains a lock on the object, making serialization possible.
-</para>
-
-@buf: a #GstBuffer to lock
-
-<!-- ##### MACRO GST_BUFFER_MAXAGE ##### -->
-<para>
-Gets the maximum age of a buffer.
-</para>
-
-@buf: a #GstBuffer to get maximum age of
-
-<!-- ##### MACRO GST_BUFFER_PARENT ##### -->
-<para>
-Gets the parent of this buffer. The parent is set on sub-buffers.
-</para>
-
-@buf: a #GstBuffer to get parent of
-
-<!-- ##### MACRO GST_BUFFER_POOL_LOCK ##### -->
-<para>
-Unlock the given bufferpool.
-</para>
-
-@pool: the bufferpool to unlock.
-
-<!-- ##### MACRO GST_BUFFER_POOL_PRIVATE ##### -->
-<para>
-Gets the bufferpool private data.
-</para>
-
-@buf: a #GstBuffer to get bufferpool's private data of.
-
-<!-- ##### MACRO GST_BUFFER_POOL_UNLOCK ##### -->
-<para>
-Lock the given bufferpool.
-</para>
-
-@pool: The pool to lock.
-
-<!-- ##### MACRO GST_BUFFER_TRYLOCK ##### -->
-<para>
-Tries to obtain a lock on the buffer.
-If it can't get immediately, will return FALSE.
-</para>
-
-@buf: a #GstBuffer to try to lock
-
-<!-- ##### MACRO GST_BUFFER_TYPE ##### -->
-<para>
-Retrieves the type id of the data in the buffer.
-</para>
-
-@buf: GstBuffer
-
-<!-- ##### MACRO GST_BUFFER_UNLOCK ##### -->
-<para>
-Releases a lock on the buffer.
-
-</para>
-
-@buf: a #GstBuffer to unlock
-
-<!-- ##### MACRO GST_CACHE_ASSOC_FLAGS ##### -->
-<para>
-
-</para>
-
-@entry: 
-
-<!-- ##### MACRO GST_CACHE_ASSOC_FORMAT ##### -->
-<para>
-
-</para>
-
-@entry: 
-@i: 
-
-<!-- ##### MACRO GST_CACHE_ASSOC_VALUE ##### -->
-<para>
-
-</para>
-
-@entry: 
-@i: 
-
-<!-- ##### MACRO GST_CACHE_FACTORY ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_CACHE_FACTORY_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_CACHE_FORMAT_FORMAT ##### -->
-<para>
-
-</para>
-
-@entry: 
-
-<!-- ##### MACRO GST_CACHE_FORMAT_KEY ##### -->
-<para>
-
-</para>
-
-@entry: 
-
-<!-- ##### MACRO GST_CACHE_ID_DESCRIPTION ##### -->
-<para>
-
-</para>
-
-@entry: 
-
-<!-- ##### MACRO GST_CACHE_NASSOCS ##### -->
-<para>
-
-</para>
-
-@entry: 
-
-<!-- ##### MACRO GST_CAPS ##### -->
-<para>
-
-</para>
-
-@caps: 
-
-<!-- ##### MACRO GST_CAPS_LOCK ##### -->
-<para>
-Lock the caps structure
-</para>
-
-@caps: The caps structure to lock
-
-<!-- ##### MACRO GST_CAPS_TRYLOCK ##### -->
-<para>
-Try to lock the caps structure
-</para>
-
-@caps: The caps structure to try to lock
-
-<!-- ##### MACRO GST_CAPS_UNLOCK ##### -->
-<para>
-Unlock the caps structure
-</para>
-
-@caps: The caps structure to unlock
-
-<!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
-<para>
-A flag indicating that MMX instructions are supported.
-</para>
-
-
-<!-- ##### MACRO GST_CPU_FLAG_SSE ##### -->
-<para>
-A flag indicating that SSE instructions are supported.
-</para>
-
-
-<!-- ##### MACRO GST_DATA_FLAG_IS_SET ##### -->
-<para>
-Check if a given flag is set on the data
-</para>
-
-@data: The data to check
-@flag: The flag to check for
-
-<!-- ##### MACRO GST_DATA_FLAG_SET ##### -->
-<para>
-Set the flag on the data
-</para>
-
-@data: The data to set the flag on
-@flag: The flag to set
-
-<!-- ##### MACRO GST_DATA_IS_READONLY ##### -->
-<para>
-Query if the GstData is READONLY
-</para>
-
-@data: The data to query
-
-<!-- ##### MACRO GST_DATA_REFCOUNT_READ ##### -->
-<para>
-Read the current refcount value into the specified value
-</para>
-
-@data: The GstData to get the refcount value of
-@value: A pointer to a gint to hold the refcount value
-
-<!-- ##### MACRO GST_DEBUG_CHAR_MODE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_DEBUG_ENABLED ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_DEBUG_ENABLE_CATEGORIES ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_DEBUG_ENTER_STRING ##### -->
-<para>
-Combine #GST_DEBUG_ENTER and #GST_DEBUG_SET_STRING.
-</para>
-
-
-<!-- ##### MACRO GST_DEBUG_LEAVE_STRING ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_DEBUG_NOPREFIX ##### -->
-<para>
-
-</para>
-
-@cat: 
-@format: 
-@args...: 
-
-<!-- ##### MACRO GST_DEBUG_PREFIX ##### -->
-<para>
-
-</para>
-
-@cat: 
-@format: 
-@args...: 
-
-<!-- ##### MACRO GST_DEBUG_SET_STRING ##### -->
-<para>
-Set the debug string for the current function, typically containing the arguments
-to the current function, i.e. "('element')"
-</para>
-
-@format: printf-style format string
-@args...: printf arguments
-
-<!-- ##### MACRO GST_DISABLE_AUTOPLUG ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_DISABLE_TYPEFIND ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_DISKSRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_DISKSRC_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_ELEMENT ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_ELEMENT_CAST ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_ELEMENT_CLASS_CAST ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_ELEMENT_IS_COTHREAD_STOPPING ##### -->
-<para>
-Queries whether the cothread holding this element needs to be stopped.
-</para>
-
-@obj: The element to query
-
-<!-- ##### MACRO GST_ELEMENT_IS_EOS ##### -->
-<para>
-Query wether this element is in the End Of Stream state.
-</para>
-
-@obj: a #GstElement to query
-
-<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
-<para>
-Query whether this object has multiple input pads.
-
-</para>
-
-@obj: Element to query for multiple input pads.
-
-<!-- ##### MACRO GST_ELEMENT_RANK_MARGINAL ##### -->
-<para>
-The element is only marginally usefull for autoplugging
-</para>
-
-
-<!-- ##### MACRO GST_ELEMENT_RANK_NONE ##### -->
-<para>
-The plugin may not be used in autoplugging
-</para>
-
-
-<!-- ##### MACRO GST_ELEMENT_RANK_PRIMARY ##### -->
-<para>
-The plugin is well suited for autoplugging
-</para>
-
-
-<!-- ##### MACRO GST_ELEMENT_RANK_SECONDARY ##### -->
-<para>
-The plugin is suited for autoplugging but only as a second
-candidate.
-</para>
-
-
-<!-- ##### MACRO GST_ESDSINK ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_ESDSINK_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_EVENT_DISCONT_FLUSH ##### -->
-<para>
-Set or get the flush flag of the discont event.
-</para>
-
-@event: The event to operate on
-
-<!-- ##### MACRO GST_EVENT_SEEK_FLUSH ##### -->
-<para>
-Qeury wether the seek event also needs a flush.
-</para>
-
-@event: The event to query.
-
-<!-- ##### MACRO GST_FAKESINK ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_FAKESINK_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_FAKESRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_FAKESRC_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_FDSINK ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_FDSINK_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_FDSRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_FDSRC_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_FILTER ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_FILTER_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_FILTER_FLAG_LAST ##### -->
-<para>
-subclass use this to start their flag enumeration
-</para>
-
-
-<!-- ##### MACRO GST_GHOST_PAD_CAST ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_GHOST_PAD_CLASS_CAST ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_HTTPSRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_IDENTITY ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IDENTITY_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_IS_ASYNCDISKSRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_AUDIOSINK ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_AUDIOSINK_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_AUDIOSRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_AUDIOSRC_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_AUTOPLUG_FACTORY ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_AUTOPLUG_FACTORY_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_BIN ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_BIN_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_BUFFER ##### -->
-<para>
-Checks if the pointer is a GstBuffer.
-</para>
-
-@buf: a pointer to query.
-
-<!-- ##### MACRO GST_IS_CACHE_FACTORY ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_CACHE_FACTORY_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_DISKSRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_DISKSRC_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_ELEMENT ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_ELEMENT_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_ESDSINK ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_ESDSINK_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_FAKESINK ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_FAKESINK_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_FAKESRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_FAKESRC_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_FDSINK ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_FDSINK_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_FDSRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_FDSRC_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_FILTER ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_FILTER_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_HTTPSRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_HTTPSRC_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_IDENTITY ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_LINK ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_LINK_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_OBJECT ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_OBJECT_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_PAD ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_PAD_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_PIPELINE ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_PIPELINE_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_QUEUE ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_SINESRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_SINESRC_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_SINK ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_SINK_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_SRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_SRC_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_TEE ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_TEE_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_THREAD ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_IS_THREAD_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_LINK ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_LINK_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_META ##### -->
-<para>
-
-</para>
-
-@meta: 
-
-<!-- ##### MACRO GST_META_FLAGS ##### -->
-<para>
-Retrieve the flags of the given meta information.
-</para>
-
-@meta: the meta information
-
-<!-- ##### MACRO GST_META_FLAG_IS_SET ##### -->
-<para>
-Check if a given flag is set.
-</para>
-
-@meta: the meta data to test
-@flag: the flag to test
-
-<!-- ##### MACRO GST_META_FLAG_SET ##### -->
-<para>
-Set a flag in the meta data.
-</para>
-
-@meta: the meta data
-@flag: the flag to set
-
-<!-- ##### MACRO GST_META_FLAG_UNSET ##### -->
-<para>
-Clear a flag in the meta data.
-</para>
-
-@meta: the meta data
-@flag: the flag to clear
-
-<!-- ##### MACRO GST_OBJECT ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_OBJECT_CAST ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_OBJECT_CLASS_CAST ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_OBJECT_FLAG_LAST ##### -->
-<para>
-subclasses can use this value to start the enumeration of their flags
-</para>
-
-
-<!-- ##### MACRO GST_PAD ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_PAD_CAST ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_PAD_CLASS_CAST ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_PAD_FACTORY_ALWAYS ##### -->
-<para>
-Indicate that this pad will always be available.
-Use this in the factory definition.
-</para>
-
-
-<!-- ##### MACRO GST_PAD_FACTORY_CAPS ##### -->
-<para>
-Starts the declaration of a the capabilities for this padtemplate.
-</para>
-
-@a...: a capability factory
-
-<!-- ##### MACRO GST_PAD_FACTORY_REQUEST ##### -->
-<para>
-Indicates that this pad will be available on request. Use 
-this in the factory definition. 
-</para>
-
-
-<!-- ##### MACRO GST_PAD_FACTORY_SINK ##### -->
-<para>
-Indicates a sinkpad for the padfactory.
-</para>
-
-
-<!-- ##### MACRO GST_PAD_FACTORY_SOMETIMES ##### -->
-<para>
-Indicate that this pad will become available depending
-on the media type. Use this in the factory definition.
-</para>
-
-
-<!-- ##### MACRO GST_PAD_FACTORY_SRC ##### -->
-<para>
-Indicates a srcpad for the padfactory.
-</para>
-
-
-<!-- ##### MACRO GST_PAD_IS_CONNECTED ##### -->
-<para>
-
-</para>
-
-@a: 
-
-<!-- ##### MACRO GST_PAD_LINKED ##### -->
-<para>
-Is this pad linked.
-</para>
-
-@pad: the pad to check
-
-<!-- ##### MACRO GST_PAD_TEMPLATE_FIXED ##### -->
-<para>
-Get the flag indicating the properties are fixed from the template.
-</para>
-
-@templ: the template to query
-
-<!-- ##### MACRO GST_PIPELINE ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_PIPELINE_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_PLUGIN_DESC ##### -->
-<para>
-A handy macro to define a plugin description. This macro handles with all the issues
-involved with the different linking methods for this plugin.
-</para>
-
-@major: The major version of GStreamer this plugin was compiled against.
-@minor: The minor version of GStreamer this plugin was compiled against.
-@name: The name of the plugin.
-@init: The init function of this plugin.
-
-<!-- ##### MACRO GST_PLUGIN_DESC_DYNAMIC ##### -->
-<para>
-The macro used to define dynamically loaded plugins.
-</para>
-
-@major: The major version of GStreamer this plugin was compiled against.
-@minor: The minor version of GStreamer this plugin was compiled against.
-@name: The name of the plugin.
-@init: The init function of this plugin.
-
-<!-- ##### MACRO GST_PLUGIN_DESC_STATIC ##### -->
-<para>
-A macro used to define a statically linked plugin.
-</para>
-
-@major: The major version of GStreamer this plugin was compiled against.
-@minor: The minor version of GStreamer this plugin was compiled against.
-@name: The name of the plugin.
-@init: The init function of this plugin.
-
-<!-- ##### MACRO GST_QUEUE ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_QUEUE_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_REAL_PAD_CAST ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_REAL_PAD_CLASS_CAST ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_RPAD_EOSFUNC ##### -->
-<para>
-Get the EOS function of the real pad.
-</para>
-
-@pad: the real pad to query.
-
-<!-- ##### MACRO GST_RPAD_GETREGIONFUNC ##### -->
-<para>
-Get the getregion function of the real pad.
-</para>
-
-@pad: the real pad to query.
-
-<!-- ##### MACRO GST_RPAD_LEN ##### -->
-<para>
-Get the length of the region that is being pulled.
-</para>
-
-@pad: the real pad to query.
-
-<!-- ##### MACRO GST_RPAD_NEGOTIATEFUNC ##### -->
-<para>
-Get the negotiate function from the real pad.
-</para>
-
-@pad: the real pad to query.
-
-<!-- ##### MACRO GST_RPAD_NEWCAPSFUNC ##### -->
-<para>
-Get the newcaps function from the real pad.
-</para>
-
-@pad: the real pad to query.
-
-<!-- ##### MACRO GST_RPAD_OFFSET ##### -->
-<para>
-Get the offset of the region that is being pulled.
-</para>
-
-@pad: the real pad to query.
-
-<!-- ##### MACRO GST_RPAD_PULLFUNC ##### -->
-<para>
-Get the pullfunction of the real pad.
-</para>
-
-@pad: the real pad to query.
-
-<!-- ##### MACRO GST_RPAD_PULLREGIONFUNC ##### -->
-<para>
-Get the pullregion function of the real pad.
-</para>
-
-@pad: the real pad to query.
-
-<!-- ##### MACRO GST_RPAD_PUSHFUNC ##### -->
-<para>
-Get the pushfunction of the real pad.
-</para>
-
-@pad: the real pad to query.
-
-<!-- ##### MACRO GST_RPAD_QOSFUNC ##### -->
-<para>
-Get the QoS function of the real pad.
-</para>
-
-@pad: the real pad to query.
-
-<!-- ##### MACRO GST_RPAD_REGIONTYPE ##### -->
-<para>
-Get the type of the region that is being pulled.
-</para>
-
-@pad: the real pad to query.
-
-<!-- ##### MACRO GST_SCHEDULE_ADD_ELEMENT ##### -->
-<para>
-Fast macro to add an element to the scheduler.
-</para>
-
-@sched: The scheduler to add the element to.
-@element: The element to add to the scheduler.
-
-<!-- ##### MACRO GST_SCHEDULE_DISABLE_ELEMENT ##### -->
-<para>
-Fast macro to disable the element.
-</para>
-
-@sched: The scheduler.
-@element: The element to disable.
-
-<!-- ##### MACRO GST_SCHEDULE_ENABLE_ELEMENT ##### -->
-<para>
-Fast macro to enable the element in the scheduler.
-</para>
-
-@sched: The scheduler.
-@element: The element to activate.
-
-<!-- ##### MACRO GST_SCHEDULE_ITERATE ##### -->
-<para>
-Fast macro to perform one iteration of the scheduler.
-</para>
-
-@sched: The scheduler to iterate.
-
-<!-- ##### MACRO GST_SCHEDULE_LOCK_ELEMENT ##### -->
-<para>
-Fast macro to lock a given element.
-</para>
-
-@sched: The scheduler.
-@element: The element to lock.
-
-<!-- ##### MACRO GST_SCHEDULE_PAD_LINK ##### -->
-<para>
-Fast macro to link two pads.
-</para>
-
-@sched: The scheduler.
-@srcpad: The source pad.
-@sinkpad: The sink pad.
-
-<!-- ##### MACRO GST_SCHEDULE_PAD_UNLINK ##### -->
-<para>
-Fast macro to unlink two pads.
-</para>
-
-@sched: The scheduler.
-@srcpad: The source pad.
-@sinkpad: The sink pad.
-
-<!-- ##### MACRO GST_SCHEDULE_REMOVE_ELEMENT ##### -->
-<para>
-Fast macro to remove an element from the scheduler.
-</para>
-
-@sched: The scheduler to remove the element from.
-@element: The element to remove from the scheduler.
-
-<!-- ##### MACRO GST_SCHEDULE_SAFETY ##### -->
-<para>
-Handy macro to check for a non NULL scheduler. The next block of statements
-will only be axecuted if the scheduler is not NULL.
-</para>
-
-@sched: the scheduler to query.
-
-<!-- ##### MACRO GST_SCHEDULE_UNLOCK_ELEMENT ##### -->
-<para>
-Fast macro to unlock a given element.
-</para>
-
-@sched: The scheduler.
-@element: The element to unlock.
-
-<!-- ##### MACRO GST_SCHED_PARENT ##### -->
-<para>
-Get the parent #GstElement of this scheduler.
-
-</para>
-
-@sched: the scheduler to query.
-
-<!-- ##### MACRO GST_SINESRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_SINESRC_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_SINK ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_SINK_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_SINK_FLAG_LAST ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_SRC ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_SRC_ASYNC ##### -->
-<para>
-This macro checks to see if the GST_SRC_ASYNC flag is set.
-</para>
-
-@obj: GstSrc to check for flag in.
-
-<!-- ##### MACRO GST_SRC_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_SRC_FLAGS ##### -->
-<para>
-This macro returns the entire set of flags for the object.
-</para>
-
-@obj: GstSrc to return flags for.
-
-<!-- ##### MACRO GST_SRC_IS_ASYNC ##### -->
-<para>
-Query a GstSrc for the ASYNC flag
-</para>
-
-@obj: The GstSrc to query
-
-<!-- ##### MACRO GST_SRC_SET_FLAGS ##### -->
-<para>
-This macro sets the given flags.
-</para>
-
-@src: 
-@flag: Flag to set, can by any number of bits in guint32.
-@obj: GstSrc to set flag in.
-
-<!-- ##### MACRO GST_SRC_UNSET_FLAGS ##### -->
-<para>
-This macro usets the given flags.
-</para>
-
-@src: 
-@flag: Flag to set, must be a single bit in guint32.
-@obj: GstSrc to unset flag in.
-
-<!-- ##### MACRO GST_STATE_IS_SET ##### -->
-<para>
-This macro checks to see if the given state is set.
-</para>
-
-@obj: Element to check for state.
-@flag: State to check for, must be a single bit in guint32.
-
-<!-- ##### MACRO GST_STATE_PLAYING_TO_READY ##### -->
-<para>
-The Element is going from the PLAYING state to the READY state.
-</para>
-
-
-<!-- ##### MACRO GST_STATE_READY_TO_PLAYING ##### -->
-<para>
-The Element is going from the READY state to the PLAYING state.
-</para>
-
-
-<!-- ##### MACRO GST_STATE_SET ##### -->
-<para>
-This macro sets the given state on the element.
-</para>
-
-@obj: Element to set state of.
-@flag: State to set, can be any number of bits in guint32.
-
-<!-- ##### MACRO GST_STATE_UNSET ##### -->
-<para>
-This macro unsets the given state on the element.
-</para>
-
-@obj: Element to unset state of.
-@flag: State to unset, can be any number of bits in guint32.
-
-<!-- ##### MACRO GST_TEE ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_TEE_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_THREAD ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO GST_THREAD_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO GST_TYPE_ASYNCDISKSRC ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_AUDIOSINK ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_AUDIOSRC ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_AUTOPLUG_FACTORY ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_AUTOPLUG_FLAGS ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_BIN ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_BUFFER_POOL ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_CACHE_CERTAINTY ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_CACHE_ENTRY_TYPE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_CACHE_FACTORY ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_CACHE_LOOKUP_METHOD ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_DISKSRC ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_ELEMENT ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_ESDSINK ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_FAKESINK ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_FAKESRC ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_FDSINK ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_FDSRC ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_FILENAME ##### -->
-<para>
-A type that can be used to indicate a filename.
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_FILTER ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_HTTPSRC ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_IDENTITY ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_LINK ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_OBJECT ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_PAD ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_PAD_QUERY_TYPE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_PARANOID ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_PIPELINE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_QUEUE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_SINESRC ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_SINK ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_SRC ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_TEE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GST_TYPE_THREAD ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GType ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GTypeFlags ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GTypeInfo ##### -->
-<para>
-
-</para>
-
-@class_size: 
-@base_init: 
-@base_finalize: 
-@class_init: 
-@class_finalize: 
-@class_data: 
-@instance_size: 
-@n_preallocs: 
-@instance_init: 
-@value_table: 
-
-<!-- ##### MACRO GValue ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_BEGIN_DECLS ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_CALLBACK ##### -->
-<para>
-
-</para>
-
-@f: 
-
-<!-- ##### MACRO G_E ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_END_DECLS ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_IS_PARAM_SPEC_ENUM ##### -->
-<para>
-
-</para>
-
-@pspec: 
-
-<!-- ##### MACRO G_LN10 ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_LN2 ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_MAXUINT ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_MAXULONG ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_OBJECT ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO G_OBJECT_CLASS_TYPE ##### -->
-<para>
-
-</para>
-
-@gclass: 
-
-<!-- ##### MACRO G_OBJECT_TYPE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_OBJECT_WARN_INVALID_PROPERTY_ID ##### -->
-<para>
-
-</para>
-
-@a: 
-@b: 
-@c: 
-
-<!-- ##### MACRO G_PARAM_READABLE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_PARAM_READWRITE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_PARAM_WRITABLE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_PI ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_PI_2 ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_PI_4 ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_SIGNAL_NO_HOOKS ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_SIGNAL_NO_RECURSE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_SIGNAL_RUN_CLEANUP ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_SIGNAL_RUN_FIRST ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_SIGNAL_RUN_LAST ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_SQRT2 ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_BOOLEAN ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_BOXED ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_CHAR ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_CHECK_CLASS_CAST ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_CHECK_CLASS_TYPE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_CAST ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_TYPE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_DOUBLE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_ENUM ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_FLAGS ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_FLAG_ABSTRACT ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_FLOAT ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_FROM_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-<!-- ##### MACRO G_TYPE_INSTANCE_GET_CLASS ##### -->
-<para>
-
-</para>
-
-@o: 
-@t: 
-@c: 
-
-<!-- ##### MACRO G_TYPE_INT ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_LONG ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_NONE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_PARAM ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_POINTER ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_STRING ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_UCHAR ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_UINT ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_ULONG ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_VALUE_HOLDS_BOOLEAN ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO G_VALUE_HOLDS_CHAR ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO G_VALUE_HOLDS_DOUBLE ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO G_VALUE_HOLDS_FLOAT ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO G_VALUE_HOLDS_INT ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO G_VALUE_HOLDS_LONG ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO G_VALUE_HOLDS_POINTER ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO G_VALUE_HOLDS_STRING ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO G_VALUE_HOLDS_UCHAR ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO G_VALUE_HOLDS_UINT ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO G_VALUE_HOLDS_ULONG ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO G_VALUE_TYPE ##### -->
-<para>
-
-</para>
-
-@v: 
-
-<!-- ##### ARG GstAggregator:last-message ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstAggregator:num-pads ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstAggregator:sched ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstAggregator:silent ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstAsyncDiskSrc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstAsyncDiskSrc:bytesperread ##### -->
-<para>
-Specify how many bytes to read at a time.
-</para>
-
-
-<!-- ##### ARG GstAsyncDiskSrc:length ##### -->
-<para>
-Get the size of the current file.
-</para>
-
-
-<!-- ##### ARG GstAsyncDiskSrc:location ##### -->
-<para>
-Specify the location of the file to read.
-</para>
-
-
-<!-- ##### ARG GstAsyncDiskSrc:offset ##### -->
-<para>
-Specify the current offset in the file.
-</para>
-
-
-<!-- ##### ARG GstAsyncDiskSrc:size ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstAsyncDiskSrcClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ENUM GstAsyncDiskSrcFlags ##### -->
-<para>
-<informaltable pgwide=1 frame="none" role="enum">
-<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
-<tbody>
-<row>
-<entry>GST_ASYNCDISKSRC_OPEN</entry>
-<entry>the asyncdisksrc is open for reading</entry>
-</row>
-
-</tbody></tgroup></informaltable>
-
-</para>
-
-@GST_ASYNCDISKSRC_OPEN: 
-@GST_ASYNCDISKSRC_FLAG_LAST: 
-
-<!-- ##### STRUCT GstAtomicSwap ##### -->
-<para>
-The structure to handle values that can be swapped atomically
-</para>
-
-@lock: 
-
-<!-- ##### STRUCT GstAudioSink ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GstAudioSink::handoff ##### -->
-<para>
-The buffer is sent to the sound card.
-</para>
-
-@gstaudiosink: the object which received the signal.
-@arg1: the audiosink.
-
-<!-- ##### ARG GstAudioSink:channels ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstAudioSink:format ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstAudioSink:frequency ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstAudioSink:mute ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstAudioSinkClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstAudioSrc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstAudioSrc:bytes-per-read ##### -->
-<para>
-The number of bytes per read.
-</para>
-
-
-<!-- ##### ARG GstAudioSrc:channels ##### -->
-<para>
-The number of channels (mono, stereo, ...)
-</para>
-
-
-<!-- ##### ARG GstAudioSrc:curoffset ##### -->
-<para>
-Get the current number of bytes read.
-</para>
-
-
-<!-- ##### ARG GstAudioSrc:format ##### -->
-<para>
-The audio format as defined in soundcard.h
-</para>
-
-
-<!-- ##### ARG GstAudioSrc:frequency ##### -->
-<para>
-The frequency.
-</para>
-
-
-<!-- ##### STRUCT GstAudioSrcClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstAutoplug ##### -->
-<para>
-The autoplug object
-</para>
-
-
-<!-- ##### SIGNAL GstAutoplug::new-object ##### -->
-<para>
-
-</para>
-
-@gstautoplug: the object which received the signal.
-@arg1: 
-
-<!-- ##### STRUCT GstAutoplugFactory ##### -->
-<para>
-The autoplugfactory object
-</para>
-
-
-<!-- ##### ENUM GstAutoplugFlags ##### -->
-<para>
-The type of the autoplugger.
-</para>
-
-@GST_AUTOPLUG_TO_CAPS: 
-@GST_AUTOPLUG_TO_RENDERER: 
-@GST_AUTOPLUG_FLAG_LAST: 
-
-<!-- ##### SIGNAL GstBin::object-added ##### -->
-<para>
-is signaled whenever a new <classname>GstElement</classname> is added to the <classname>GstBin</classname>
-
-</para>
-
-@gstbin: the object which received the signal.
-@arg1: the element that was added
-
-<!-- ##### USER_FUNCTION GstBufferCopyFunc ##### -->
-<para>
-This supplied function is used to copy the buffer contents.
-</para>
-
-@srcbuf: a #GstBuffer to copy from
-@Returns: a newly allocated #GstBuffer copy of srcbuf
-
-<!-- ##### USER_FUNCTION GstBufferFreeFunc ##### -->
-<para>
-This supplied function is called when the buffer data has to be freed.
-</para>
-
-@buf: a #GstBuffer to clear the buffer data of
-
-<!-- ##### USER_FUNCTION GstBufferPoolCreateFunction ##### -->
-<para>
-The function called when a buffer has to be created for this pool.
-</para>
-
-@pool: the pool from which to create the buffer
-@user_data: any user data
-@Returns: a new buffer from the pool
-
-<!-- ##### USER_FUNCTION GstBufferPoolDestroyFunction ##### -->
-<para>
-This function will be called when the given buffer has to be returned to
-the pool.
-</para>
-
-@pool: the pool to return the buffer to
-@buffer: the buffer to return
-@user_data: any user data
-
-<!-- ##### USER_FUNCTION GstBufferPoolDestroyHook ##### -->
-<para>
-Will be called when the bufferpool is destroyed so that the owner of the pool
-can perform necessary cleanup.
-</para>
-
-@pool: The pool that is being destroyed
-@user_data: user data as set on th bufferpool
-
-<!-- ##### STRUCT GstCacheAssociation ##### -->
-<para>
-
-</para>
-
-@format: 
-@value: 
-
-<!-- ##### ENUM GstCacheCertainty ##### -->
-<para>
-
-</para>
-
-@GST_CACHE_UNKNOWN: 
-@GST_CACHE_CERTAIN: 
-@GST_CACHE_FUZZY: 
-
-<!-- ##### STRUCT GstCacheEntry ##### -->
-<para>
-
-</para>
-
-@type: 
-@id: 
-
-<!-- ##### ENUM GstCacheEntryType ##### -->
-<para>
-
-</para>
-
-@GST_CACHE_ENTRY_ID: 
-@GST_CACHE_ENTRY_ASSOCIATION: 
-@GST_CACHE_ENTRY_OBJECT: 
-@GST_CACHE_ENTRY_FORMAT: 
-
-<!-- ##### USER_FUNCTION GstCacheFilter ##### -->
-<para>
-
-</para>
-
-@cache: 
-@entry: 
-@Returns: 
-
-<!-- ##### STRUCT GstCacheGroup ##### -->
-<para>
-
-</para>
-
-@groupnum: 
-@entries: 
-@certainty: 
-@peergroup: 
-
-<!-- ##### ENUM GstCacheLookupMethod ##### -->
-<para>
-
-</para>
-
-@GST_CACHE_LOOKUP_EXACT: 
-@GST_CACHE_LOOKUP_BEFORE: 
-@GST_CACHE_LOOKUP_AFTER: 
-
-<!-- ##### USER_FUNCTION GstCacheResolver ##### -->
-<para>
-
-</para>
-
-@cache: 
-@writer: 
-@writer_id: 
-@writer_string: 
-@user_data: 
-@Returns: 
-
-<!-- ##### ENUM GstCapsDefinition ##### -->
-<para>
-
-</para>
-
-@GST_CAPS_ALWAYS: 
-@GST_CAPS_MAYBE: 
-
-<!-- ##### TYPEDEF GstCapsFactory ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### TYPEDEF GstCapsFactory[] ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstClock ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GstDiskSink::handoff ##### -->
-<para>
-Is emited after the buffer has been written to the disk.
-</para>
-
-@gstdisksink: the object which received the signal.
-
-<!-- ##### ARG GstDiskSink:closed ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstDiskSink:location ##### -->
-<para>
-The filename to write to.
-</para>
-
-
-<!-- ##### ARG GstDiskSink:maxfilesize ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ENUM GstDiskSinkFlags ##### -->
-<para>
-
-</para>
-
-@GST_DISKSINK_OPEN: 
-@GST_DISKSINK_FLAG_LAST: 
-
-<!-- ##### STRUCT GstDiskSrc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstDiskSrc:bytesperread ##### -->
-<para>
-Specify how many bytes to read at a time.
-</para>
-
-
-<!-- ##### ARG GstDiskSrc:filesize ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstDiskSrc:location ##### -->
-<para>
-Specify the location of the file to read.
-</para>
-
-
-<!-- ##### ARG GstDiskSrc:offset ##### -->
-<para>
-Get/set the current offset in the file.
-</para>
-
-
-<!-- ##### ARG GstDiskSrc:size ##### -->
-<para>
-Get the size of the file.
-</para>
-
-
-<!-- ##### STRUCT GstDiskSrcClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ENUM GstDiskSrcFlags ##### -->
-<para>
-<informaltable pgwide=1 frame="none" role="enum">
-<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
-<tbody>
-<row>
-<entry>GST_DISKSRC_OPEN</entry>
-<entry>the disksrc is open for reading</entry>
-</row>
-
-</tbody></tgroup></informaltable>
-
-</para>
-
-@GST_DISKSRC_OPEN: 
-@GST_DISKSRC_FLAG_LAST: 
-
-<!-- ##### SIGNAL GstElement::deep-notify ##### -->
-<para>
-
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: 
-@arg2: 
-
-<!-- ##### SIGNAL GstElement::event ##### -->
-<para>
-
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: 
-
-<!-- ##### SIGNAL GstElement::ghost-pad-removed ##### -->
-<para>
-
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: The ghost pad that was removed.
-
-<!-- ##### SIGNAL GstElement::new-ghost-pad ##### -->
-<para>
-
-Is trigered whenever a new ghost pad is added to an element
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: the new ghost pad that was added
-
-<!-- ##### STRUCT GstElementFactory ##### -->
-<para>
-This factory is used when registering the element, and contains the name
-of the element, the GtkType value for it, as well as a pointer to the
-GstElementDetails struct for the element.
-</para>
-
-
-<!-- ##### USER_FUNCTION GstElementGetClockFunction ##### -->
-<para>
-The function to get the clock from a clock providing element
-</para>
-
-@element: The element to get the clock of
-@Returns: The clock provided by the element
-
-<!-- ##### USER_FUNCTION GstElementSetClockFunction ##### -->
-<para>
-The function to set the clock on a clock receiving element.
-</para>
-
-@element: The element to set the clock on
-@clock: The clock to set on the element
-
-<!-- ##### STRUCT GstEsdSink ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstEsdSinkClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstFakeSink ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GstFakeSink::handoff ##### -->
-<para>
-This signal is emmitted when a buffer is handled.
-</para>
-
-@gstfakesink: the object which received the signal.
-@arg1: The buffer that is received.
-
-<!-- ##### ARG GstFakeSink:dump ##### -->
-<para>
-Dump the contents of the buffer
-</para>
-
-
-<!-- ##### ARG GstFakeSink:last-message ##### -->
-<para>
-The last message this plugin emmited.
-</para>
-
-
-<!-- ##### ARG GstFakeSink:num-sinks ##### -->
-<para>
-The number of sink pads.
-</para>
-
-
-<!-- ##### ARG GstFakeSink:num-sources ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSink:silent ##### -->
-<para>
-Indicates the plugin should not emit messages.
-</para>
-
-
-<!-- ##### ARG GstFakeSink:sync ##### -->
-<para>
-Sync on the clock
-</para>
-
-
-<!-- ##### STRUCT GstFakeSinkClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstFakeSrc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GstFakeSrc::handoff ##### -->
-<para>
-
-</para>
-
-@gstfakesrc: the object which received the signal.
-@arg1: 
-
-<!-- ##### ARG GstFakeSrc:data ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:dump ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:eos ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:filltype ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:last-message ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:loop-based ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:num-buffers ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:num-sources ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:output ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:parentsize ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:patern ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:pattern ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:silent ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:sizemax ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:sizemin ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFakeSrc:sizetype ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstFakeSrcClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstFdSink ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFdSink:fd ##### -->
-<para>
-The filedescriptor to write to.
-</para>
-
-
-<!-- ##### STRUCT GstFdSinkClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstFdSrc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFdSrc:bytesperread ##### -->
-<para>
-The number of bytes per read.
-</para>
-
-
-<!-- ##### ARG GstFdSrc:location ##### -->
-<para>
-The filedescriptor to read from. Pass the argument as a char* (???)
-</para>
-
-
-<!-- ##### ARG GstFdSrc:offset ##### -->
-<para>
-Get the current offset in the file.
-</para>
-
-
-<!-- ##### STRUCT GstFdSrcClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFileSrc:blocksize ##### -->
-<para>
-The size of the buffers to pass to the peer element.
-</para>
-
-
-<!-- ##### ARG GstFileSrc:fd ##### -->
-<para>
-The file descriptor.
-</para>
-
-
-<!-- ##### ARG GstFileSrc:filesize ##### -->
-<para>
-The filesize.
-</para>
-
-
-<!-- ##### ARG GstFileSrc:location ##### -->
-<para>
-The filename 
-</para>
-
-
-<!-- ##### ARG GstFileSrc:mmapsize ##### -->
-<para>
-The size of the mmapped area.
-</para>
-
-
-<!-- ##### ARG GstFileSrc:offset ##### -->
-<para>
-The offset in the file that is currently being read.
-</para>
-
-
-<!-- ##### ARG GstFileSrc:touch ##### -->
-<para>
-Indicates the mmapped area should be touched to bring it into memory.
-</para>
-
-
-<!-- ##### STRUCT GstFilter ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstFilterClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstGhostPad ##### -->
-<para>
-The Ghostpad object
-</para>
-
-
-<!-- ##### ARG GstGhostPad:real-pad ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstHttpSrc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstHttpSrc:bytesperread ##### -->
-<para>
-Specify how many bytes to read at a time.
-
-</para>
-
-
-<!-- ##### ARG GstHttpSrc:location ##### -->
-<para>
-Specify the location of the file. The location must be a fully qualified URL.
-</para>
-
-
-<!-- ##### STRUCT GstHttpSrcClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstIdentity ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GstIdentity::handoff ##### -->
-<para>
-
-</para>
-
-@gstidentity: the object which received the signal.
-@arg1: 
-
-<!-- ##### ARG GstIdentity:control ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstIdentity:drop-probability ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstIdentity:dump ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstIdentity:duplicate ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstIdentity:error-after ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstIdentity:last-message ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstIdentity:loop-based ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstIdentity:silent ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstIdentity:sleep-time ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstIdentityClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstIndex ##### -->
-<para>
-The GstIndex object
-</para>
-
-
-<!-- ##### STRUCT GstIndexFactory ##### -->
-<para>
-The GstIndexFactory object
-</para>
-
-
-<!-- ##### STRUCT GstLink ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstLinkClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstMD5Sink:md5 ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstMemChunkElement ##### -->
-<para>
-An entry in the memchunk area
-</para>
-
-@link: 
-@area: 
-
-<!-- ##### STRUCT GstMeta ##### -->
-<para>
-
-</para>
-
-@lock: for locking purposes
-@flags: the flags of the meta data
-@data: the meta data
-@size: the size of the meta data
-
-<!-- ##### ENUM GstMetaFlags ##### -->
-<para>
-Flags indicating properties about the meta data.
-</para>
-
-@GST_META_FREEABLE: the meta data can be freed
-
-<!-- ##### ENUM GstMultiDiskSrcFlags ##### -->
-<para>
-
-</para>
-
-@GST_MULTIDISKSRC_OPEN: 
-@GST_MULTIDISKSRC_FLAG_LAST: 
-
-<!-- ##### ARG GstPad:active ##### -->
-<para>
-Indicates this pad is active
-</para>
-
-
-<!-- ##### USER_FUNCTION GstPadDispatcherFunc ##### -->
-<para>
-The signature of the dispatcher callback.
-</para>
-
-@pad: The pad that is being dispatched
-@data: user data
-@Returns: TRUE if no further pads need to be processed
-
-<!-- ##### USER_FUNCTION GstPadEOSFunction ##### -->
-<para>
-The function that will be called in an EOS case.
-</para>
-
-@pad: the pad that needs to be set to EOS state
-@Returns: TRUE if EOS was successful, FALSE otherwise
-
-<!-- ##### TYPEDEF GstPadFactoryEntry ##### -->
-<para>
-Defines an entry for a padfactory.
-</para>
-
-
-<!-- ##### TYPEDEF GstPadFactory[] ##### -->
-<para>
-The padfactory.
-</para>
-
-
-<!-- ##### USER_FUNCTION GstPadGetRegionFunction ##### -->
-<para>
-The function that will be called when pulling a region buffer.
-You can specify which buffer to get using an offset/length pair or
-a start/stop timecode pair.
-</para>
-
-@pad: the pad to get a buffer from
-@type: the type of region to get (time or offset based)
-@offset: the offset of the region to get
-@len: the length of the region to get
-@Returns: a #GstBuffer
-
-<!-- ##### USER_FUNCTION GstPadNegotiateFunction ##### -->
-<para>
-The function that will be called when negotiating.
-</para>
-
-@pad: The pad that is being negotiated
-@caps: The current caps that are being negotiated
-@data: A generic gpointer that can be used to store user_data
-@Returns: The result of the negotiation process
-
-<!-- ##### ENUM GstPadNegotiateReturn ##### -->
-<para>
-The possible results from padnegotiation.
-</para>
-
-@GST_PAD_NEGOTIATE_FAIL: The pads could not agree about the media type.
-@GST_PAD_NEGOTIATE_AGREE: The pads agreed about the media type.
-@GST_PAD_NEGOTIATE_TRY: The pad did not agree and suggests another media type.
-
-<!-- ##### USER_FUNCTION GstPadNewCapsFunction ##### -->
-<para>
-The function that will be called when the caps of the pad has
-changed.
-</para>
-
-@pad: The pad that has its caps changed
-@caps: the new caps of the pad
-
-<!-- ##### USER_FUNCTION GstPadPullFunction ##### -->
-<para>
-The function that will be called when pulling buffers.
-</para>
-
-@pad: the pad to pull
-@Returns: a GstBuffer
-
-<!-- ##### USER_FUNCTION GstPadPullRegionFunction ##### -->
-<para>
-The function that will be called when pulling a region buffer.
-You can specify which buffer to get using an offset/length pair or
-a start/stop timecode pair.
-</para>
-
-@pad: the pad to get a buffer from
-@type: the type of region to get (time or offset based)
-@offset: the offset of the region to get
-@len: the length of the region to get
-@Returns: a #GstBuffer
-
-<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
-<para>
-
-The function that will be called when pushing a buffers.
-</para>
-
-@pad: the pad to push
-@buf: a GstBuffer to push
-
-<!-- ##### USER_FUNCTION GstPadQoSFunction ##### -->
-<para>
-The function that will be called when a QoS message is sent.
-</para>
-
-@pad: the pad that sent the QoS message
-@qos_message: the message
-
-<!-- ##### ENUM GstPadQueryType ##### -->
-<para>
-The different supported query types.
-</para>
-
-@GST_PAD_QUERY_NONE: 
-@GST_PAD_QUERY_TOTAL: Query the total stream time.
-@GST_PAD_QUERY_POSITION: Query the current stream position.
-@GST_PAD_QUERY_LATENCY: Query the latency on the pad.
-@GST_PAD_QUERY_JITTER: Query the average jitter beteen optimal processing 
-                       and current processing.
-@GST_PAD_QUERY_START: Query for the configured start time for segmented seek
-@GST_PAD_QUERY_SEGMENT_END: Query the end position of the currently 
-                            executing segment.
-@GST_PAD_QUERY_RATE: Query at which rate this pad will process data.
-
-<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
-<para>
-This signal is fired when an element creates a pad from this 
-template.
-</para>
-
-@gstpadtemplate: the object which received the signal.
-@arg1: The pad that was created.
-
-<!-- ##### ENUM GstParseErrors ##### -->
-<para>
-
-</para>
-
-@GST_PARSE_ERROR_SYNTAX: 
-@GST_PARSE_ERROR_CREATING_ELEMENT: 
-@GST_PARSE_ERROR_NOSUCH_ELEMENT: 
-@GST_PARSE_ERROR_INTERNAL: 
-@GST_PARSE_ERROR_LINK: 
-
-<!-- ##### ARG GstPipefilter:command ##### -->
-<para>
-Sets the command to be executed.
-</para>
-
-
-<!-- ##### STRUCT GstPipeline ##### -->
-<para>
-The pipeline object
-</para>
-
-
-<!-- ##### STRUCT GstPipelineClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstPluginElement ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstQueue ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstQueue:block ##### -->
-<para>
-Specify wether the queue blocks or not. 
-</para>
-
-
-<!-- ##### ARG GstQueue:leaky ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstQueue:level ##### -->
-<para>
-Get the number of buffers in the queue.
-</para>
-
-
-<!-- ##### ARG GstQueue:max-level ##### -->
-<para>
-Specify the maximum number of buffers in the queue before the queue
-blocks.
-</para>
-
-
-<!-- ##### ARG GstQueue:may-deadlock ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstQueue:timeout ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstQueueClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstRealPad ##### -->
-<para>
-The realpad object
-</para>
-
-
-<!-- ##### ENUM GstRegionType ##### -->
-<para>
-the region types for #gst_pad_pullregion.
-</para>
-
-@GST_REGION_VOID: 
-@GST_REGION_OFFSET_LEN: an offet/length pair
-@GST_REGION_TIME_LEN: a time start/length pair
-
-<!-- ##### STRUCT GstRegistry ##### -->
-<para>
-The registry object
-</para>
-
-
-<!-- ##### STRUCT GstRegistryRead ##### -->
-<para>
-
-</para>
-
-@global_reg: 
-@local_reg: 
-
-<!-- ##### STRUCT GstRegistryWrite ##### -->
-<para>
-
-</para>
-
-@dir: 
-@file: 
-@tmp_file: 
-
-<!-- ##### STRUCT GstScheduleChain ##### -->
-<para>
-
-</para>
-
-@sched: 
-@disabled: 
-@elements: 
-@num_elements: 
-@entry: 
-@cothreaded_elements: 
-@schedule: 
-
-<!-- ##### STRUCT GstSineSrc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstSineSrc:buffersize ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstSineSrc:channels ##### -->
-<para>
-The number of channels.
-</para>
-
-
-<!-- ##### ARG GstSineSrc:format ##### -->
-<para>
-The format ad defined in soundcard.h
-</para>
-
-
-<!-- ##### ARG GstSineSrc:freq ##### -->
-<para>
-The frequency.
-</para>
-
-
-<!-- ##### ARG GstSineSrc:frequency ##### -->
-<para>
-The fequency.
-</para>
-
-
-<!-- ##### ARG GstSineSrc:samplerate ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstSineSrc:tablesize ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstSineSrc:volume ##### -->
-<para>
-The volume as a double 0.0 is silent, 1.0 is loudest.
-</para>
-
-
-<!-- ##### STRUCT GstSineSrcClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstSink ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstSinkClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### TYPEDEF GstSpiderLink ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstSrc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GstSrc::eos ##### -->
-<para>
-An eos signal is triggered whenever the GstSrc has reached the end of 
-the stream.
-
-</para>
-
-@gstsrc: the object which received the signal.
-@arg1: the object which received the signal
-
-<!-- ##### STRUCT GstSrcClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ENUM GstSrcFlags ##### -->
-<para>
-Flags for the GstSrc element
-</para>
-
-@GST_SRC_ASYNC: Indicates that this src is asynchronous
-@GST_SRC_FLAG_LAST: subclasses can use this to number their flags
-
-<!-- ##### SIGNAL GstStatistics::update ##### -->
-<para>
-
-</para>
-
-@gststatistics: the object which received the signal.
-
-<!-- ##### ARG GstStatistics:buffer-update-freq ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstStatistics:buffers ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstStatistics:bytes ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstStatistics:bytes-update-freq ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstStatistics:event-update-freq ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstStatistics:events ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstStatistics:silent ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstStatistics:update ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstStatistics:update-on-eos ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstSystemClock ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstTee ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstTee:last-message ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstTee:num-pads ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstTee:silent ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstTeeClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstThread ##### -->
-<para>
-The GstThread object
-</para>
-
-
-<!-- ##### ARG GstThread:create-thread ##### -->
-<para>
-TRUE if the thread should be created.
-
-</para>
-
-
-<!-- ##### STRUCT GstThreadClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ENUM GstTimeCacheCertainty ##### -->
-<para>
-
-</para>
-
-@GST_TIME_CACHE_UNKNOWN: 
-@GST_TIME_CACHE_CERTAIN: 
-@GST_TIME_CACHE_FUZZY_LOCATION: 
-@GST_TIME_CACHE_FUZZY_TIMESTAMP: 
-@GST_TIME_CACHE_FUZZY: 
-
-<!-- ##### STRUCT GstTimeCacheEntry ##### -->
-<para>
-
-</para>
-
-@location: 
-@timestamp: 
-
-<!-- ##### STRUCT GstTimeCacheGroup ##### -->
-<para>
-
-</para>
-
-@groupnum: 
-@entries: 
-@certainty: 
-@peergroup: 
-@mintimestamp: 
-@maxtimestamp: 
-@minlocation: 
-@maxlocation: 
-
-<!-- ##### SIGNAL GstTypeFind::have-type ##### -->
-<para>
-The signal to indicate the mime type was detected.
-</para>
-
-@gsttypefind: the object which received the signal.
-@arg1: The mime type that was detected
-
-<!-- ##### ARG GstTypeFind:caps ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstTypeFind:type ##### -->
-<para>
-Query the element for the current mime type
-</para>
-
-
-<!-- ##### STRUCT GstTypeFindFactory ##### -->
-<para>
-Object that stores information about a typefind function
-</para>
-
-
-<!-- ##### STRUCT GstTypeFindFactoryClass ##### -->
-<para>
-Class belonging to #GstTypeFindFactory.
-</para>
-
-@parent: 
-
-<!-- ##### STRUCT GstXML ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GstXml::object-loaded ##### -->
-<para>
-
-</para>
-
-@gstxml: the object which received the signal.
-@arg1: 
-@arg2: 
-
-<!-- ##### MACRO INFO ##### -->
-<para>
-
-</para>
-
-@cat: 
-@format: 
-@args...: 
-
-<!-- ##### MACRO INFO_ELEMENT ##### -->
-<para>
-
-</para>
-
-@cat: 
-@element: 
-@format: 
-@args...: 
-
-<!-- ##### STRUCT MetaAudioRaw ##### -->
-<para>
-
-</para>
-
-@meta: 
-@format: 
-@channels: 
-@frequency: 
-@bps: 
-
-<!-- ##### STRUCT MetaAudioSpectrum ##### -->
-<para>
-
-</para>
-
-@meta: 
-@bands: 
-@channels: 
-@interleaved: 
-@lowfreq: 
-@highfreq: 
-@steps: 
-
-<!-- ##### STRUCT MetaDGA ##### -->
-<para>
-
-</para>
-
-@base: 
-@swidth: 
-@sheight: 
-@bytes_per_line: 
-
-<!-- ##### STRUCT MetaOverlay ##### -->
-<para>
-
-</para>
-
-@wx: 
-@wy: 
-@overlay_element: 
-@clip_count: 
-@overlay_clip: 
-@width: 
-@height: 
-@did_overlay: 
-@fully_obscured: 
-
-<!-- ##### STRUCT MetaVideoRaw ##### -->
-<para>
-
-</para>
-
-@meta: 
-@format: 
-@visual: 
-@width: 
-@height: 
-@overlay_info: 
-@dga_info: 
-
-<!-- ##### STRUCT OverlayClip ##### -->
-<para>
-
-</para>
-
-@x1: 
-@x2: 
-@y1: 
-@y2: 
-
-<!-- ##### MACRO STACK_SIZE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO TRACE_ENABLE ##### -->
-<para>
-must be defined to activate the tracing functionality.
-</para>
-
-
-<!-- ##### MACRO VALUE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO YYSTYPE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION cothread_get_data ##### -->
-<para>
-
-</para>
-
-@thread: 
-@key: 
-@Returns: 
-
-<!-- ##### FUNCTION cothread_getcurrent ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION cothread_init ##### -->
-<para>
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION cothread_set_data ##### -->
-<para>
-
-</para>
-
-@thread: 
-@key: 
-@data: 
-
-<!-- ##### TYPEDEF element_t ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION g2g_object_class_find_property ##### -->
-<para>
-
-</para>
-
-@oclass: 
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_object_class_install_property ##### -->
-<para>
-
-</para>
-
-@oclass: 
-@property_id: 
-@pspec: 
-
-<!-- ##### FUNCTION g2g_object_class_list_properties ##### -->
-<para>
-
-</para>
-
-@oclass: 
-@n_properties: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_object_new ##### -->
-<para>
-
-</para>
-
-@type: 
-@blah_varargs_stuff: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_object_run_dispose ##### -->
-<para>
-
-</para>
-
-@object: 
-
-<!-- ##### FUNCTION g2g_param_spec_boolean ##### -->
-<para>
-
-</para>
-
-@name: 
-@nick: 
-@blurb: 
-@def: 
-@flags: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_param_spec_double ##### -->
-<para>
-
-</para>
-
-@name: 
-@nick: 
-@blurb: 
-@min: 
-@max: 
-@def: 
-@flags: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_param_spec_enum ##### -->
-<para>
-
-</para>
-
-@name: 
-@nick: 
-@blurb: 
-@e: 
-@def: 
-@flags: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_param_spec_float ##### -->
-<para>
-
-</para>
-
-@name: 
-@nick: 
-@blurb: 
-@min: 
-@max: 
-@def: 
-@flags: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_param_spec_int ##### -->
-<para>
-
-</para>
-
-@name: 
-@nick: 
-@blurb: 
-@min: 
-@max: 
-@def: 
-@flags: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_param_spec_long ##### -->
-<para>
-
-</para>
-
-@name: 
-@nick: 
-@blurb: 
-@min: 
-@max: 
-@def: 
-@flags: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_param_spec_pointer ##### -->
-<para>
-
-</para>
-
-@name: 
-@nick: 
-@blurb: 
-@flags: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_param_spec_string ##### -->
-<para>
-
-</para>
-
-@name: 
-@nick: 
-@blurb: 
-@def: 
-@flags: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_param_spec_uint ##### -->
-<para>
-
-</para>
-
-@name: 
-@nick: 
-@blurb: 
-@min: 
-@max: 
-@def: 
-@flags: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_param_spec_ulong ##### -->
-<para>
-
-</para>
-
-@name: 
-@nick: 
-@blurb: 
-@min: 
-@max: 
-@def: 
-@flags: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_signal_new ##### -->
-<para>
-
-</para>
-
-@signal_name: 
-@object_type: 
-@signal_flags: 
-@function_offset: 
-@accumulator: 
-@Returns: 
-
-<!-- ##### FUNCTION g2g_type_register_static ##### -->
-<para>
-
-</para>
-
-@parent_type: 
-@type_name: 
-@info: 
-@flags: 
-@Returns: 
-
-<!-- ##### MACRO g_cclosure_marshal_STRING__OBJECT_POINTER ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__BOOLEAN ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__BOXED ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__CHAR ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__DOUBLE ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__ENUM ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__FLAGS ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__FLOAT ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__INT ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__LONG ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__PARAM ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__POINTER ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__STRING ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__UCHAR ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__UINT ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__UINT_POINTER ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__ULONG ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_cclosure_marshal_VOID__VOID ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_enum_register_static ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION g_list_delete_link ##### -->
-<para>
-
-</para>
-
-@list: 
-@llink: 
-@Returns: 
-
-<!-- ##### MACRO g_object_class_find_property ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_object_class_install_property ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_object_class_list_properties ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_object_get_property ##### -->
-<para>
-
-</para>
-
-@obj: 
-@argname: 
-@pspec: 
-
-<!-- ##### FUNCTION g_object_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### MACRO g_object_new ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_object_ref ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO g_object_run_dispose ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_object_set ##### -->
-<para>
-
-</para>
-
-@o: 
-@args...: 
-
-<!-- ##### MACRO g_object_unref ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-<!-- ##### MACRO g_param_spec_boolean ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_param_spec_double ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_param_spec_enum ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_param_spec_float ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_param_spec_int ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_param_spec_long ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_param_spec_pointer ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_param_spec_string ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_param_spec_uint ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_param_spec_ulong ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_signal_handler_block ##### -->
-<para>
-
-</para>
-
-@o: 
-@id: 
-
-<!-- ##### MACRO g_signal_handler_unblock ##### -->
-<para>
-
-</para>
-
-@o: 
-@id: 
-
-<!-- ##### MACRO g_signal_handlers_destroy ##### -->
-<para>
-
-</para>
-
-@x: 
-
-<!-- ##### FUNCTION g_signal_list_ids ##### -->
-<para>
-
-</para>
-
-@type: 
-@n_ids: 
-@Returns: 
-
-<!-- ##### MACRO g_signal_lookup ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_signal_new ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION g_slist_delete_link ##### -->
-<para>
-
-</para>
-
-@list: 
-@llink: 
-@Returns: 
-
-<!-- ##### MACRO g_string_printf ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_string_printfa ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_type_class_peek_parent ##### -->
-<para>
-
-</para>
-
-@c: 
-
-<!-- ##### MACRO g_type_class_ref ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_type_class_unref ##### -->
-<para>
-
-</para>
-
-@c: 
-
-<!-- ##### MACRO g_type_from_name ##### -->
-<para>
-
-</para>
-
-@t: 
-
-<!-- ##### MACRO g_type_init ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_type_is_a ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_type_name ##### -->
-<para>
-
-</para>
-
-@t: 
-
-<!-- ##### MACRO g_type_parent ##### -->
-<para>
-
-</para>
-
-@t: 
-
-<!-- ##### MACRO g_type_register_static ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO g_value_copy ##### -->
-<para>
-
-</para>
-
-@src_val: 
-@dest_val: 
-
-<!-- ##### MACRO g_value_get_boolean ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO g_value_get_char ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO g_value_get_double ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO g_value_get_enum ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO g_value_get_float ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO g_value_get_int ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO g_value_get_long ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO g_value_get_pointer ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO g_value_get_string ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO g_value_get_uchar ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO g_value_get_uint ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO g_value_get_ulong ##### -->
-<para>
-
-</para>
-
-@value: 
-
-<!-- ##### MACRO g_value_init ##### -->
-<para>
-
-</para>
-
-@value: 
-@t: 
-
-<!-- ##### MACRO g_value_set_boolean ##### -->
-<para>
-
-</para>
-
-@value: 
-@data: 
-
-<!-- ##### MACRO g_value_set_char ##### -->
-<para>
-
-</para>
-
-@value: 
-@data: 
-
-<!-- ##### MACRO g_value_set_double ##### -->
-<para>
-
-</para>
-
-@value: 
-@data: 
-
-<!-- ##### MACRO g_value_set_enum ##### -->
-<para>
-
-</para>
-
-@value: 
-@data: 
-
-<!-- ##### MACRO g_value_set_float ##### -->
-<para>
-
-</para>
-
-@value: 
-@data: 
-
-<!-- ##### MACRO g_value_set_int ##### -->
-<para>
-
-</para>
-
-@value: 
-@data: 
-
-<!-- ##### MACRO g_value_set_long ##### -->
-<para>
-
-</para>
-
-@value: 
-@data: 
-
-<!-- ##### MACRO g_value_set_pointer ##### -->
-<para>
-
-</para>
-
-@value: 
-@data: 
-
-<!-- ##### MACRO g_value_set_string ##### -->
-<para>
-
-</para>
-
-@value: 
-@data: 
-
-<!-- ##### MACRO g_value_set_uchar ##### -->
-<para>
-
-</para>
-
-@value: 
-@data: 
-
-<!-- ##### MACRO g_value_set_uint ##### -->
-<para>
-
-</para>
-
-@value: 
-@data: 
-
-<!-- ##### MACRO g_value_set_ulong ##### -->
-<para>
-
-</para>
-
-@value: 
-@data: 
-
-<!-- ##### MACRO g_value_unset ##### -->
-<para>
-
-</para>
-
-@val: 
-
-<!-- ##### VARIABLE gst_aggregator_details ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_audiosink_chain ##### -->
-<para>
-
-</para>
-
-@pad: 
-@buf: 
-
-<!-- ##### FUNCTION gst_audiosink_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_audiosink_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_audiosink_set_channels ##### -->
-<para>
-
-</para>
-
-@audiosink: 
-@channels: 
-
-<!-- ##### FUNCTION gst_audiosink_set_format ##### -->
-<para>
-
-</para>
-
-@audiosink: 
-@format: 
-
-<!-- ##### FUNCTION gst_audiosink_set_frequency ##### -->
-<para>
-
-</para>
-
-@audiosink: 
-@frequency: 
-
-<!-- ##### FUNCTION gst_audiosink_sync_parms ##### -->
-<para>
-
-</para>
-
-@audiosink: 
-
-<!-- ##### FUNCTION gst_audiosrc_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_audiosrc_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_audiosrc_push ##### -->
-<para>
-
-</para>
-
-@src: 
-
-<!-- ##### FUNCTION gst_autoplug_can_link_sink ##### -->
-<para>
-
-</para>
-
-@fac: 
-@sink: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_autoplug_can_link_src ##### -->
-<para>
-
-</para>
-
-@fac: 
-@src: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_autoplug_caps_list ##### -->
-<para>
-
-</para>
-
-@autoplug: 
-@srcpad: 
-@sinkpad: 
-@Varargs: 
-@Returns: 
-@srccaps: 
-@sinkcaps: 
-
-<!-- ##### FUNCTION gst_autoplug_factory_create ##### -->
-<para>
-
-</para>
-
-@factory: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_autoplug_factory_destroy ##### -->
-<para>
-
-</para>
-
-@factory: 
-
-<!-- ##### FUNCTION gst_autoplug_factory_find ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_autoplug_factory_get_list ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_autoplug_factory_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_autoplug_factory_load_thyself ##### -->
-<para>
-
-</para>
-
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_autoplug_factory_make ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_autoplug_factory_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@longdesc: 
-@type: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_autoplug_factory_save_thyself ##### -->
-<para>
-
-</para>
-
-@factory: 
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_autoplug_flags_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_autoplug_signal_new_object ##### -->
-<para>
-
-</para>
-
-@autoplug: 
-@object: 
-
-<!-- ##### FUNCTION gst_autoplug_to_caps ##### -->
-<para>
-
-</para>
-
-@autoplug: 
-@srccaps: 
-@sinkcaps: 
-@Varargs: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_autoplug_to_renderers ##### -->
-<para>
-
-</para>
-
-@autoplug: 
-@srccaps: 
-@target: 
-@Varargs: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_bin_add_managed_element ##### -->
-<para>
-
-</para>
-
-@bin: 
-@element: 
-
-<!-- ##### FUNCTION gst_bin_child_error ##### -->
-<para>
-
-</para>
-
-@bin: 
-@child: 
-
-<!-- ##### FUNCTION gst_bin_create_plan ##### -->
-<para>
-
-</para>
-
-@bin: 
-
-<!-- ##### MACRO gst_bin_destroy ##### -->
-<para>
-Free the memory allocated by this bin
-</para>
-
-@bin: the bin to free
-
-<!-- ##### VARIABLE gst_bin_details ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_bin_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_bin_remove_managed_element ##### -->
-<para>
-
-</para>
-
-@bin: 
-@element: 
-
-<!-- ##### FUNCTION gst_bin_schedule ##### -->
-<para>
-
-</para>
-
-@bin: 
-
-<!-- ##### FUNCTION gst_bin_schedule_func ##### -->
-<para>
-
-</para>
-
-@bin: 
-
-<!-- ##### FUNCTION gst_bin_set_element_manager ##### -->
-<para>
-
-</para>
-
-@element: 
-@manager: 
-
-<!-- ##### FUNCTION gst_bin_set_state_type ##### -->
-<para>
-
-</para>
-
-@bin: 
-@state: 
-@type: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_buffer_add_meta ##### -->
-<para>
-
-</para>
-
-@buffer: 
-@meta: 
-
-<!-- ##### FUNCTION gst_buffer_append ##### -->
-<para>
-
-</para>
-
-@buffer: 
-@append: 
-@Returns: 
-@buf: 
-@buf2: 
-
-<!-- ##### FUNCTION gst_buffer_destroy ##### -->
-<para>
-
-</para>
-
-@buffer: 
-
-<!-- ##### MACRO gst_buffer_free ##### -->
-<para>
-Frees the given buffer, regardless of the refcount. 
-It is dangerous to use this function, you should use gst_buffer_unref() instead.
-</para>
-
-@buf: a #GstBuffer to free.
-
-<!-- ##### FUNCTION gst_buffer_get_first_meta ##### -->
-<para>
-
-</para>
-
-@buffer: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_buffer_get_metas ##### -->
-<para>
-
-</para>
-
-@buffer: 
-@Returns: 
-
-<!-- ##### MACRO gst_buffer_needs_copy_on_write ##### -->
-<para>
-Queries if a copy needs to be ade of the buffer in order to safely write
-to its data.
-</para>
-
-@buf: The buffer to query.
-
-<!-- ##### FUNCTION gst_buffer_pool_destroy ##### -->
-<para>
-
-</para>
-
-@pool: 
-
-<!-- ##### FUNCTION gst_buffer_pool_destroy_buffer ##### -->
-<para>
-
-</para>
-
-@pool: 
-@buffer: 
-
-<!-- ##### MACRO gst_buffer_pool_needs_copy_on_write ##### -->
-<para>
-Checks if a copy needs to be made of the bufferpool before it can
-safely be modified.
-</para>
-
-@pool: The pool to query
-
-<!-- ##### FUNCTION gst_buffer_pool_new_buffer ##### -->
-<para>
-
-</para>
-
-@pool: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_buffer_pool_set_buffer_copy_function ##### -->
-<para>
-
-</para>
-
-@pool: 
-@copy: 
-
-<!-- ##### FUNCTION gst_buffer_pool_set_buffer_free_function ##### -->
-<para>
-
-</para>
-
-@pool: 
-@destroy: 
-
-<!-- ##### FUNCTION gst_buffer_pool_set_buffer_new_function ##### -->
-<para>
-
-</para>
-
-@pool: 
-@create: 
-
-<!-- ##### FUNCTION gst_buffer_pool_set_create_function ##### -->
-<para>
-
-</para>
-
-@pool: 
-@create: 
-@user_data: 
-
-<!-- ##### FUNCTION gst_buffer_pool_set_destroy_function ##### -->
-<para>
-
-</para>
-
-@pool: 
-@destroy: 
-@user_data: 
-
-<!-- ##### FUNCTION gst_buffer_pool_set_destroy_hook ##### -->
-<para>
-
-</para>
-
-@pool: 
-@destroy: 
-
-<!-- ##### FUNCTION gst_buffer_print_stats ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_buffer_remove_meta ##### -->
-<para>
-
-</para>
-
-@buffer: 
-@meta: 
-
-<!-- ##### FUNCTION gst_cache_add_association ##### -->
-<para>
-
-</para>
-
-@cache: 
-@id: 
-@flags: 
-@format: 
-@value: 
-@Varargs: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_add_format ##### -->
-<para>
-
-</para>
-
-@cache: 
-@id: 
-@format: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_add_id ##### -->
-<para>
-
-</para>
-
-@cache: 
-@id: 
-@description: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_add_object ##### -->
-<para>
-
-</para>
-
-@cache: 
-@id: 
-@key: 
-@type: 
-@object: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_certainty_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_entry_assoc_map ##### -->
-<para>
-
-</para>
-
-@entry: 
-@format: 
-@value: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_entry_free ##### -->
-<para>
-
-</para>
-
-@entry: 
-
-<!-- ##### FUNCTION gst_cache_entry_type_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_factory_create ##### -->
-<para>
-
-</para>
-
-@factory: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_factory_destroy ##### -->
-<para>
-
-</para>
-
-@factory: 
-
-<!-- ##### FUNCTION gst_cache_factory_find ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_factory_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_factory_make ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_factory_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@longdesc: 
-@type: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_get_assoc_entry ##### -->
-<para>
-
-</para>
-
-@cache: 
-@id: 
-@method: 
-@format: 
-@value: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_get_assoc_entry_full ##### -->
-<para>
-
-</para>
-
-@cache: 
-@id: 
-@method: 
-@format: 
-@value: 
-@func: 
-@user_data: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_get_certainty ##### -->
-<para>
-
-</para>
-
-@cache: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_get_group ##### -->
-<para>
-
-</para>
-
-@cache: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_get_writer_id ##### -->
-<para>
-
-</para>
-
-@cache: 
-@writer: 
-@id: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_lookup_method_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_new ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_new_group ##### -->
-<para>
-
-</para>
-
-@cache: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_set_certainty ##### -->
-<para>
-
-</para>
-
-@cache: 
-@certainty: 
-
-<!-- ##### FUNCTION gst_cache_set_filter ##### -->
-<para>
-
-</para>
-
-@cache: 
-@filter: 
-@user_data: 
-
-<!-- ##### FUNCTION gst_cache_set_group ##### -->
-<para>
-
-</para>
-
-@cache: 
-@groupnum: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_cache_set_resolver ##### -->
-<para>
-
-</para>
-
-@cache: 
-@resolver: 
-@user_data: 
-
-<!-- ##### FUNCTION gst_caps_debug ##### -->
-<para>
-
-</para>
-
-@caps: 
-@string: 
-@label: 
-
-<!-- ##### FUNCTION gst_caps_destroy ##### -->
-<para>
-
-</para>
-
-@caps: 
-
-<!-- ##### FUNCTION gst_caps_get_type_id ##### -->
-<para>
-
-</para>
-
-@caps: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_caps_list_check_compatibility ##### -->
-<para>
-
-</para>
-
-@fromcaps: 
-@tocaps: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_caps_new_with_props ##### -->
-<para>
-
-</para>
-
-@name: 
-@mime: 
-@props: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_caps_register ##### -->
-<para>
-
-</para>
-
-@factory: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_caps_register_count ##### -->
-<para>
-
-</para>
-
-@factory: 
-@counter: 
-@Returns: 
-@count: 
-
-<!-- ##### FUNCTION gst_caps_set_type_id ##### -->
-<para>
-
-</para>
-
-@caps: 
-@type_id: 
-
-<!-- ##### FUNCTION gst_clock_activate ##### -->
-<para>
-
-</para>
-
-@clock: 
-@active: 
-
-<!-- ##### FUNCTION gst_clock_async_supported ##### -->
-<para>
-
-</para>
-
-@clock: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_clock_cancel_wait_async ##### -->
-<para>
-
-</para>
-
-@clock: 
-@id: 
-
-<!-- ##### FUNCTION gst_clock_get_system ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_clock_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_clock_notify_async ##### -->
-<para>
-
-</para>
-
-@clock: 
-@interval: 
-@func: 
-@user_data: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_clock_remove_notify_async ##### -->
-<para>
-
-</para>
-
-@clock: 
-@id: 
-
-<!-- ##### FUNCTION gst_clock_unlock_id ##### -->
-<para>
-
-</para>
-
-@clock: 
-@id: 
-
-<!-- ##### FUNCTION gst_clock_wait ##### -->
-<para>
-
-</para>
-
-@clock: 
-@time: 
-@jitter: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_clock_wait_async ##### -->
-<para>
-
-</para>
-
-@clock: 
-@time: 
-@func: 
-@user_data: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_clock_wait_id ##### -->
-<para>
-
-</para>
-
-@clock: 
-@id: 
-@jitter: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_data_default_copy ##### -->
-<para>
-
-</para>
-
-@data: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_data_default_free ##### -->
-<para>
-
-</para>
-
-@data: 
-
-<!-- ##### FUNCTION gst_data_free ##### -->
-<para>
-
-</para>
-
-@data: 
-
-<!-- ##### FUNCTION gst_data_needs_copy_on_write ##### -->
-<para>
-
-</para>
-
-@data: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_debug_logv ##### -->
-<para>
-
-</para>
-
-@category: 
-@level: 
-@file: 
-@function: 
-@line: 
-@object: 
-@format: 
-@args: 
-
-<!-- ##### FUNCTION gst_disksrc_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_change_state ##### -->
-<para>
-
-</para>
-
-@element: 
-@state: 
-@Returns: 
-
-<!-- ##### MACRO gst_element_destroy ##### -->
-<para>
-Destroys the element (without taking the refcount into account).
-An application programmer should use #gst_object_unref instead to dispose
-of an element he doesn't need anymore.
-</para>
-
-@element: a #GstElement to destroy
-
-<!-- ##### MACRO gst_element_error ##### -->
-<para>
-
-</para>
-
-@el: 
-@domain: 
-@code: 
-@message: 
-@debug: 
-@element: 
-@error: 
-@Varargs: 
-
-<!-- ##### FUNCTION gst_element_factory_add_pad_template ##### -->
-<para>
-
-</para>
-
-@elementfactory: 
-@templ: 
-
-<!-- ##### FUNCTION gst_element_factory_add_sink ##### -->
-<para>
-
-</para>
-
-@elementfactory: 
-@id: 
-
-<!-- ##### FUNCTION gst_element_factory_add_src ##### -->
-<para>
-
-</para>
-
-@elementfactory: 
-@id: 
-
-<!-- ##### FUNCTION gst_element_factory_can_sink_caps_list ##### -->
-<para>
-
-</para>
-
-@factory: 
-@caps: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_factory_can_src_caps_list ##### -->
-<para>
-
-</para>
-
-@factory: 
-@caps: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_factory_destroy ##### -->
-<para>
-
-</para>
-
-@elementfactory: 
-
-<!-- ##### FUNCTION gst_element_factory_load_thyself ##### -->
-<para>
-
-</para>
-
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_factory_make_or_warn ##### -->
-<para>
-
-</para>
-
-@factoryname: 
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_factory_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@type: 
-@details: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_factory_register ##### -->
-<para>
-
-</para>
-
-@elementfactory: 
-
-<!-- ##### FUNCTION gst_element_factory_save_thyself ##### -->
-<para>
-
-</para>
-
-@factory: 
-@parent: 
-@Returns: 
-
-<!-- ##### MACRO gst_element_factory_set_rank ##### -->
-<para>
-
-</para>
-
-@factory: 
-@rank: 
-
-<!-- ##### FUNCTION gst_element_get_cache ##### -->
-<para>
-
-</para>
-
-@element: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_get_compatible_request_pad ##### -->
-<para>
-
-</para>
-
-@element: 
-@templ: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_get_compatible_static_pad ##### -->
-<para>
-
-</para>
-
-@element: 
-@templ: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_get_pad_template_by_name ##### -->
-<para>
-
-</para>
-
-@element: 
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_info ##### -->
-<para>
-
-</para>
-
-@element: 
-@info: 
-@Varargs: 
-
-<!-- ##### FUNCTION gst_element_install_std_props ##### -->
-<para>
-
-</para>
-
-@klass: 
-@first_name: 
-@Varargs: 
-
-<!-- ##### FUNCTION gst_element_is_cachable ##### -->
-<para>
-
-</para>
-
-@element: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_link_elements ##### -->
-<para>
-
-</para>
-
-@src: 
-@dest: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_link_elements_filtered ##### -->
-<para>
-
-</para>
-
-@src: 
-@dest: 
-@filtercaps: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_link_elements_many ##### -->
-<para>
-
-</para>
-
-@element_1: 
-@element_2: 
-@Varargs: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_load_thyself ##### -->
-<para>
-
-</para>
-
-@self: 
-@parent: 
-@Returns: 
-@elements: 
-
-<!-- ##### FUNCTION gst_element_loopfunc_wrapper ##### -->
-<para>
-</para>
-
-@argc: 
-@argv: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_new ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_request_compatible_pad ##### -->
-<para>
-
-</para>
-
-@element: 
-@templ: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_request_pad ##### -->
-<para>
-
-</para>
-
-@element: 
-@templ: 
-@Returns: 
-@temp: 
-
-<!-- ##### FUNCTION gst_element_request_pad_by_name ##### -->
-<para>
-
-</para>
-
-@element: 
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_restore_thyself ##### -->
-<para>
-
-</para>
-
-@self: 
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_save_thyself ##### -->
-<para>
-
-</para>
-
-@element: 
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_element_set_cache ##### -->
-<para>
-
-</para>
-
-@element: 
-@cache: 
-
-<!-- ##### FUNCTION gst_element_signal_eos ##### -->
-<para>
-
-</para>
-
-@element: 
-
-<!-- ##### FUNCTION gst_element_unlink_elements ##### -->
-<para>
-
-</para>
-
-@src: 
-@dest: 
-
-<!-- ##### FUNCTION gst_esdsink_chain ##### -->
-<para>
-
-</para>
-
-@pad: 
-@buf: 
-
-<!-- ##### FUNCTION gst_esdsink_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_esdsink_set_channels ##### -->
-<para>
-
-</para>
-
-@esdsink: 
-@channels: 
-
-<!-- ##### FUNCTION gst_esdsink_set_format ##### -->
-<para>
-
-</para>
-
-@esdsink: 
-@format: 
-
-<!-- ##### FUNCTION gst_esdsink_set_frequency ##### -->
-<para>
-
-</para>
-
-@esdsink: 
-@frequency: 
-
-<!-- ##### FUNCTION gst_esdsink_sync_parms ##### -->
-<para>
-
-</para>
-
-@esdsink: 
-
-<!-- ##### FUNCTION gst_event_free ##### -->
-<para>
-
-</para>
-
-@event: 
-
-<!-- ##### FUNCTION gst_event_new_info ##### -->
-<para>
-
-</para>
-
-@firstname: 
-@Varargs: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_event_print_stats ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_extra_get_filename_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_fakesink_chain ##### -->
-<para>
-
-</para>
-
-@pad: 
-@buf: 
-
-<!-- ##### FUNCTION gst_fakesink_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_fakesink_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_fakesrc_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_fakesrc_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_fakesrc_push ##### -->
-<para>
-
-</para>
-
-@src: 
-
-<!-- ##### FUNCTION gst_fdsink_chain ##### -->
-<para>
-
-</para>
-
-@pad: 
-@buf: 
-
-<!-- ##### FUNCTION gst_fdsink_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_fdsink_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_fdsink_new_with_fd ##### -->
-<para>
-
-</para>
-
-@name: 
-@fd: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_filter_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_filter_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_httpsrc_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_identity_chain ##### -->
-<para>
-
-</para>
-
-@pad: 
-@buf: 
-
-<!-- ##### FUNCTION gst_identity_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_identity_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_link_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_link_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_link_push ##### -->
-<para>
-
-</para>
-
-@link: 
-
-<!-- ##### MACRO gst_meta_new ##### -->
-<para>
-Create new meta data.
-</para>
-
-@type: the type of the meta data to create
-
-<!-- ##### FUNCTION gst_meta_new_size ##### -->
-<para>
-
-</para>
-
-@size: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_meta_ref ##### -->
-<para>
-
-</para>
-
-@meta: 
-
-<!-- ##### FUNCTION gst_meta_unref ##### -->
-<para>
-
-</para>
-
-@meta: 
-
-<!-- ##### FUNCTION gst_object_destroy ##### -->
-<para>
-
-</para>
-
-@object: the object
-
-<!-- ##### FUNCTION gst_object_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_object_new ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_add_ghost_parent ##### -->
-<para>
-
-</para>
-
-@pad: 
-@parent: 
-
-<!-- ##### MACRO gst_pad_destroy ##### -->
-<para>
-Destroy the pad.
-</para>
-
-@pad: the pad to destroy
-
-<!-- ##### MACRO gst_pad_eos ##### -->
-<para>
-Call the EOS function of the pad
-</para>
-
-@pad: the pad to call the eos function of.
-
-<!-- ##### FUNCTION gst_pad_eos_func ##### -->
-<para>
-
-</para>
-
-@pad: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_event ##### -->
-<para>
-
-</para>
-
-@pad: 
-@event: 
-@timestamp: 
-@data: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_get_caps_by_name ##### -->
-<para>
-
-</para>
-
-@pad: 
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_get_caps_list ##### -->
-<para>
-
-</para>
-
-@pad: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_get_directory ##### -->
-<para>
-
-</para>
-
-@pad: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_get_ghost_parents ##### -->
-<para>
-
-</para>
-
-@pad: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_get_type_id ##### -->
-<para>
-
-</para>
-
-@pad: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_handle_qos ##### -->
-<para>
-
-</para>
-
-@pad: 
-@qos_message: 
-
-<!-- ##### FUNCTION gst_pad_handles_event ##### -->
-<para>
-
-</para>
-
-@pad: 
-@mask: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_handles_format ##### -->
-<para>
-
-</para>
-
-@pad: 
-@format: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_negotiate_proxy ##### -->
-<para>
-
-</para>
-
-@srcpad: 
-@destpad: 
-@caps: 
-@Returns: 
-@counter: 
-@count: 
-
-<!-- ##### FUNCTION gst_pad_probe_destroy ##### -->
-<para>
-
-</para>
-
-@probe: 
-
-<!-- ##### FUNCTION gst_pad_probe_new ##### -->
-<para>
-
-</para>
-
-@single_shot: 
-@callback: 
-@user_data: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_probe_perform ##### -->
-<para>
-
-</para>
-
-@probe: 
-@data: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_pull_region ##### -->
-<para>
-
-</para>
-
-@pad: 
-@offset: 
-@size: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_pullregion ##### -->
-<para>
-
-</para>
-
-@pad: 
-@type: 
-@offset: 
-@len: 
-@Returns: 
-@size: 
-
-<!-- ##### FUNCTION gst_pad_query_type_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
-<para>
-
-</para>
-
-@pad: 
-@parent: 
-
-<!-- ##### FUNCTION gst_pad_save_thyself ##### -->
-<para>
-
-</para>
-
-@pad: 
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_set_caps ##### -->
-<para>
-
-</para>
-
-@pad: 
-@caps: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_set_caps_list ##### -->
-<para>
-
-</para>
-
-@pad: 
-@caps: 
-
-<!-- ##### FUNCTION gst_pad_set_eos ##### -->
-<para>
-
-</para>
-
-@pad: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_set_eos_function ##### -->
-<para>
-
-</para>
-
-@pad: 
-@eos: 
-
-<!-- ##### FUNCTION gst_pad_set_getregion_function ##### -->
-<para>
-
-</para>
-
-@pad: 
-@getregion: 
-
-<!-- ##### FUNCTION gst_pad_set_negotiate_function ##### -->
-<para>
-
-</para>
-
-@pad: 
-@nego: 
-
-<!-- ##### FUNCTION gst_pad_set_newcaps_function ##### -->
-<para>
-
-</para>
-
-@pad: 
-@newcaps: 
-
-<!-- ##### FUNCTION gst_pad_set_pull_function ##### -->
-<para>
-
-</para>
-
-@pad: 
-@pull: 
-
-<!-- ##### FUNCTION gst_pad_set_qos_function ##### -->
-<para>
-
-</para>
-
-@pad: 
-@qos: 
-
-<!-- ##### FUNCTION gst_pad_set_type_id ##### -->
-<para>
-
-</para>
-
-@pad: 
-@id: 
-
-<!-- ##### FUNCTION gst_pad_template_create ##### -->
-<para>
-
-</para>
-
-@name_template: 
-@direction: 
-@presence: 
-@caps: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_template_load_thyself ##### -->
-<para>
-
-</para>
-
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_template_save_thyself ##### -->
-<para>
-
-</para>
-
-@templ: 
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_pad_try_link ##### -->
-<para>
-
-</para>
-
-@srcpad: 
-@sinkpad: 
-@Returns: 
-
-<!-- ##### MACRO gst_pipeline_destroy ##### -->
-<para>
-Destroys the pipeline.
-</para>
-
-@pipeline: #GstPipeline to destroy
-
-<!-- ##### VARIABLE gst_pipeline_details ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_pipeline_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_pipeline_iterate ##### -->
-<para>
-
-</para>
-
-@pipeline: 
-
-<!-- ##### FUNCTION gst_plugin_add_autoplugger ##### -->
-<para>
-
-</para>
-
-@plugin: 
-@factory: 
-
-<!-- ##### FUNCTION gst_plugin_add_factory ##### -->
-<para>
-
-</para>
-
-@plugin: 
-@factory: 
-
-<!-- ##### FUNCTION gst_plugin_add_path ##### -->
-<para>
-
-</para>
-
-@path: 
-
-<!-- ##### FUNCTION gst_plugin_add_type ##### -->
-<para>
-
-</para>
-
-@plugin: 
-@factory: 
-
-<!-- ##### FUNCTION gst_plugin_feature_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_find ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_get_autoplug_list ##### -->
-<para>
-
-</para>
-
-@plugin: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_get_factory_list ##### -->
-<para>
-
-</para>
-
-@plugin: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_get_list ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_get_longname ##### -->
-<para>
-
-</para>
-
-@plugin: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_get_type_list ##### -->
-<para>
-
-</para>
-
-@plugin: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_init ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_plugin_load_absolute ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_load_all ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_plugin_load_autoplug_factory ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_load_element_factory ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_load_plugin ##### -->
-<para>
-
-</para>
-
-@plugin: 
-@error: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_load_thyself ##### -->
-<para>
-
-</para>
-
-@parent: 
-
-<!-- ##### FUNCTION gst_plugin_load_type_factory ##### -->
-<para>
-
-</para>
-
-@mime: 
-
-<!-- ##### FUNCTION gst_plugin_new ##### -->
-<para>
-
-</para>
-
-@filename: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_save_thyself ##### -->
-<para>
-
-</para>
-
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_plugin_set_longname ##### -->
-<para>
-
-</para>
-
-@plugin: 
-@longname: 
-
-<!-- ##### FUNCTION gst_plugin_set_name ##### -->
-<para>
-
-</para>
-
-@plugin: 
-@name: 
-
-<!-- ##### FUNCTION gst_plugin_unload_all ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_props_destroy ##### -->
-<para>
-
-</para>
-
-@props: 
-
-<!-- ##### FUNCTION gst_props_get_boolean ##### -->
-<para>
-
-</para>
-
-@props: 
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_props_get_float ##### -->
-<para>
-
-</para>
-
-@props: 
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_props_get_fourcc_int ##### -->
-<para>
-
-</para>
-
-@props: 
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_props_get_int ##### -->
-<para>
-
-</para>
-
-@props: 
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_props_get_string ##### -->
-<para>
-
-</para>
-
-@props: 
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_props_register ##### -->
-<para>
-
-</para>
-
-@factory: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_props_register_count ##### -->
-<para>
-
-</para>
-
-@factory: 
-@counter: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_props_type_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_queue_chain ##### -->
-<para>
-
-</para>
-
-@pad: 
-@buf: 
-
-<!-- ##### VARIABLE gst_queue_details ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_queue_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_queue_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_queue_push ##### -->
-<para>
-
-</para>
-
-@link: 
-
-<!-- ##### FUNCTION gst_registry_option_set ##### -->
-<para>
-
-</para>
-
-@registry: 
-
-<!-- ##### FUNCTION gst_registry_read_get ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_registry_write_get ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_schedule_add_element ##### -->
-<para>
-
-</para>
-
-@sched: 
-@element: 
-
-<!-- ##### FUNCTION gst_schedule_disable_element ##### -->
-<para>
-
-</para>
-
-@sched: 
-@element: 
-
-<!-- ##### FUNCTION gst_schedule_enable_element ##### -->
-<para>
-
-</para>
-
-@sched: 
-@element: 
-
-<!-- ##### FUNCTION gst_schedule_iterate ##### -->
-<para>
-
-</para>
-
-@sched: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_schedule_new ##### -->
-<para>
-
-</para>
-
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_schedule_pad_link ##### -->
-<para>
-
-</para>
-
-@sched: 
-@srcpad: 
-@sinkpad: 
-
-<!-- ##### FUNCTION gst_schedule_pad_select ##### -->
-<para>
-
-</para>
-
-@sched: 
-@padlist: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_schedule_pad_unlink ##### -->
-<para>
-
-</para>
-
-@sched: 
-@srcpad: 
-@sinkpad: 
-
-<!-- ##### FUNCTION gst_schedule_remove_element ##### -->
-<para>
-
-</para>
-
-@sched: 
-@element: 
-
-<!-- ##### FUNCTION gst_schedule_show ##### -->
-<para>
-
-</para>
-
-@sched: 
-
-<!-- ##### MACRO gst_scheduler_destroy ##### -->
-<para>
-Destroy the scheduler
-</para>
-
-@sched: The scheduler to destroy.
-
-<!-- ##### FUNCTION gst_scheduler_disable_element ##### -->
-<para>
-
-</para>
-
-@sched: 
-@element: 
-
-<!-- ##### FUNCTION gst_scheduler_enable_element ##### -->
-<para>
-
-</para>
-
-@sched: 
-@element: 
-
-<!-- ##### FUNCTION gst_scheduler_factory_get_list ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_scheduler_get_preferred_stack ##### -->
-<para>
-
-</para>
-
-@sched: 
-@stack: 
-@size: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_sinesrc_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_sinesrc_push ##### -->
-<para>
-
-</para>
-
-@src: 
-
-<!-- ##### FUNCTION gst_sink_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_sink_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_src_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_src_push ##### -->
-<para>
-
-</para>
-
-@src: 
-
-<!-- ##### FUNCTION gst_src_push_region ##### -->
-<para>
-
-</para>
-
-@src: 
-@offset: 
-@size: 
-
-<!-- ##### FUNCTION gst_src_signal_eos ##### -->
-<para>
-
-</para>
-
-@src: 
-
-<!-- ##### FUNCTION gst_tag_setter_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_tee_chain ##### -->
-<para>
-
-</para>
-
-@pad: 
-@buf: 
-
-<!-- ##### VARIABLE gst_tee_details ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_tee_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_tee_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_tee_new_pad ##### -->
-<para>
-
-</para>
-
-@tee: 
-@Returns: 
-
-<!-- ##### VARIABLE gst_thread_details ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_thread_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_thread_iterate ##### -->
-<para>
-
-</para>
-
-@thread: 
-
-<!-- ##### FUNCTION gst_thread_main_loop ##### -->
-<para>
-
-</para>
-
-@arg: 
-
-<!-- ##### FUNCTION gst_time_cache_add_entry ##### -->
-<para>
-
-</para>
-
-@tc: 
-@location: 
-@timestamp: 
-
-<!-- ##### FUNCTION gst_time_cache_find_location ##### -->
-<para>
-
-</para>
-
-@tc: 
-@location: 
-@timestamp: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_time_cache_find_timestamp ##### -->
-<para>
-
-</para>
-
-@tc: 
-@timestamp: 
-@location: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_time_cache_get_certainty ##### -->
-<para>
-
-</para>
-
-@tc: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_time_cache_get_group ##### -->
-<para>
-
-</para>
-
-@tc: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_time_cache_new ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_time_cache_new_group ##### -->
-<para>
-
-</para>
-
-@tc: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_time_cache_set_certainty ##### -->
-<para>
-
-</para>
-
-@tc: 
-@certainty: 
-
-<!-- ##### FUNCTION gst_time_cache_set_group ##### -->
-<para>
-
-</para>
-
-@tc: 
-@groupnum: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_type_add_sink ##### -->
-<para>
-
-</para>
-
-@id: 
-@sink: 
-
-<!-- ##### FUNCTION gst_type_add_src ##### -->
-<para>
-
-</para>
-
-@id: 
-@src: 
-
-<!-- ##### FUNCTION gst_type_dump ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_type_factory_get_list ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION gst_type_factory_load_thyself ##### -->
-<para>
-
-</para>
-
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_type_factory_save_thyself ##### -->
-<para>
-
-</para>
-
-@factory: 
-@parent: 
-@Returns: 
-
-<!-- ##### VARIABLE gst_type_find_details ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_type_find_factory_register ##### -->
-<para>
-
-</para>
-
-@plugin: 
-@name: 
-@rank: 
-@func: 
-@extensions: 
-@possible_caps: 
-@data: 
-
-<!-- ##### FUNCTION gst_type_get_sink_to_src ##### -->
-<para>
-
-</para>
-
-@sinkid: 
-@srcid: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_type_get_sinks ##### -->
-<para>
-
-</para>
-
-@id: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_type_get_srcs ##### -->
-<para>
-
-</para>
-
-@id: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_type_initialize ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_type_load_thyself ##### -->
-<para>
-
-</para>
-
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_type_save_thyself ##### -->
-<para>
-
-</para>
-
-@type: 
-@parent: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_uri_handler_create ##### -->
-<para>
-
-</para>
-
-@handler: 
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_uri_handler_destroy ##### -->
-<para>
-
-</para>
-
-@handler: 
-
-<!-- ##### FUNCTION gst_uri_handler_find ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_uri_handler_find_by_uri ##### -->
-<para>
-
-</para>
-
-@uri: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_uri_handler_make_by_uri ##### -->
-<para>
-
-</para>
-
-@uri: 
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_uri_handler_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@uri: 
-@longdesc: 
-@element: 
-@property: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_util_get_bool_arg ##### -->
-<para>
-
-</para>
-
-@object: 
-@argname: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_util_get_double_arg ##### -->
-<para>
-
-</para>
-
-@object: 
-@argname: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_util_get_float_arg ##### -->
-<para>
-
-</para>
-
-@object: 
-@argname: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_util_get_int64_arg ##### -->
-<para>
-
-</para>
-
-@object: 
-@argname: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_util_get_int_arg ##### -->
-<para>
-
-</para>
-
-@object: 
-@argname: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_util_get_long_arg ##### -->
-<para>
-
-</para>
-
-@object: 
-@argname: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_util_get_pointer_arg ##### -->
-<para>
-
-</para>
-
-@object: 
-@argname: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_util_get_string_arg ##### -->
-<para>
-
-</para>
-
-@object: 
-@argname: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_util_get_widget_arg ##### -->
-<para>
-
-</para>
-
-@object: 
-@argname: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_util_has_arg ##### -->
-<para>
-
-</para>
-
-@object: 
-@argname: 
-@arg_type: 
-@Returns: 
-
-<!-- ##### FUNCTION gst_xml_new_from_memory ##### -->
-<para>
-
-</para>
-
-@buffer: 
-@size: 
-@root: 
-@Returns: 
-
-<!-- ##### FUNCTION plugin_initialize ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION plugin_load ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION plugin_load_absolute ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-<!-- ##### FUNCTION plugin_load_all ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### TYPEDEF property_t ##### -->
-<para>
-
-</para>
-
-
diff --git a/docs/gst/tmpl/gstsearchfuncs.sgml b/docs/gst/tmpl/gstsearchfuncs.sgml
deleted file mode 100644 (file)
index c940b6f..0000000
+++ /dev/null
@@ -1,166 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-gstsearchfuncs
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### MACRO GST_AUTOPLUG_MAX_COST ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### STRUCT GstAutoplugNode ##### -->
-<para>
-
-</para>
-
-@prev: 
-@fac: 
-@templ: 
-@cost: 
-@endpoint: 
-
-<!-- ##### FUNCTION gst_autoplug_caps_intersect ##### -->
-<para>
-
-</para>
-
-@src: 
-@sink: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_autoplug_can_connect_src ##### -->
-<para>
-
-</para>
-
-@fac: 
-@src: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_autoplug_can_connect_sink ##### -->
-<para>
-
-</para>
-
-@fac: 
-@sink: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_autoplug_can_match ##### -->
-<para>
-
-</para>
-
-@src: 
-@dest: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_autoplug_factory_has_direction ##### -->
-<para>
-
-</para>
-
-@fac: 
-@dir: 
-@Returns: 
-
-
-<!-- ##### MACRO gst_autoplug_factory_has_sink ##### -->
-<para>
-
-</para>
-
-@fac: 
-
-
-<!-- ##### MACRO gst_autoplug_factory_has_src ##### -->
-<para>
-
-</para>
-
-@fac: 
-
-
-<!-- ##### MACRO gst_autoplug_get_cost ##### -->
-<para>
-
-</para>
-
-@fac: 
-
-
-<!-- ##### FUNCTION gst_autoplug_factories_sinks ##### -->
-<para>
-
-</para>
-
-@factories: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_autoplug_factories_srcs ##### -->
-<para>
-
-</para>
-
-@factories: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_autoplug_factories_filters ##### -->
-<para>
-
-</para>
-
-@factories: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_autoplug_factories_filters_with_sink_caps ##### -->
-<para>
-
-</para>
-
-@factories: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_autoplug_factories_at_most_templates ##### -->
-<para>
-
-</para>
-
-@factories: 
-@dir: 
-@maxtemplates: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_autoplug_sp ##### -->
-<para>
-
-</para>
-
-@src_caps: 
-@sink_caps: 
-@factories: 
-@Returns: 
-
-
index a4e521f..0b74950 100644 (file)
@@ -22,12 +22,3 @@ GstShaper
 @SHAPER_POLICY_TIMESTAMPS: 
 @SHAPER_POLICY_BUFFERSIZE: 
 
-<!-- ##### FUNCTION gst_shaper_factory_init ##### -->
-<para>
-
-</para>
-
-@factory: 
-@Returns: 
-
-
index 1eb9c6c..6cd1339 100644 (file)
@@ -14,12 +14,6 @@ GstSpider
 
 </para>
 
-<!-- ##### VARIABLE gst_spider_details ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### TYPEDEF GstSpiderConnection ##### -->
 <para>
 
index f76a917..ad5d8ac 100644 (file)
@@ -14,12 +14,3 @@ A tee can be used to split out the filter graph.
 
 </para>
 
-<!-- ##### FUNCTION gst_tee_factory_init ##### -->
-<para>
-
-</para>
-
-@factory: 
-@Returns: 
-
-
index b7030d2..d19f282 100644 (file)
@@ -89,6 +89,28 @@ Some convenience functions
 @\
     parent_type_macro:
 @\
+    parent_type_macro:
+@\
+    parent_type_macro:
+@\
+    parent_type_macro:
+@\
+    parent_type_macro:
+@\
+    parent_type_macro:
+@\
+    parent_type_macro:
+@\
+    parent_type_macro:
+@\
+    parent_type_macro:
+@\
+    parent_type_macro:
+@\
+    parent_type_macro:
+@\
+    parent_type_macro:
+@\
     parent_type_macro: 
 @additional_initializations: 
 
index 5bad0e5..5a0a1de 100644 (file)
@@ -2,7 +2,7 @@
 GstValue
 
 <!-- ##### SECTION Short_Description ##### -->
-
+GValue implementations specific to GStreamer
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 65734d6..06f83d7 100644 (file)
@@ -115,6 +115,10 @@ GstXML
 
 </para>
 
+@: 
+@: 
+@:
+
 @gstxml: the object which received the signal.
 @arg1: 
 @arg2: 
@@ -124,7 +128,7 @@ GstXML
 
 </para>
 
-@
-@: 
-@: 
+@gstxml: the object which received the signal.
+@arg1
+@arg2
 
index 433ebe3..2db38a4 100644 (file)
@@ -113,7 +113,6 @@ libgstreamer_@GST_MAJORMINOR@_la_SOURCES = \
        gsttag.c                \
        gsttaginterface.c       \
        gstthread.c             \
-       gstthreaddummy.c        \
        $(GST_TRACE_SRC)        \
        gsttrashstack.c         \
        gsttypefind.c           \
index dab96bf..9cc6a72 100644 (file)
 #include "gstspideridentity.h"
 #include "gstsearchfuncs.h"
 
+static GstElementDetails gst_spider_details = GST_ELEMENT_DETAILS ("Spider",
+    "Generic",
+    "Automatically link sinks and sources",
+    "Benjamin Otte <in7y118@public.uni-hamburg.de>");
+
 GST_DEBUG_CATEGORY (gst_spider_debug);
 #define GST_CAT_DEFAULT gst_spider_debug
 
@@ -729,11 +734,6 @@ gst_spider_plug_from_srcpad (GstSpiderConnection * conn, GstPad * srcpad)
   return result;
 }
 
-GstElementDetails gst_spider_details = GST_ELEMENT_DETAILS ("Spider",
-    "Generic",
-    "Automatically link sinks and sources",
-    "Benjamin Otte <in7y118@public.uni-hamburg.de>");
-
 static gboolean
 plugin_init (GstPlugin * plugin)
 {
index 0958ddc..89ff7ac 100644 (file)
@@ -28,7 +28,6 @@
 
 G_BEGIN_DECLS
        
-extern GstElementDetails gst_spider_details;
 GST_DEBUG_CATEGORY_EXTERN(gst_spider_debug);
 
 /*
index 7e6105b..24af881 100644 (file)
@@ -69,8 +69,6 @@ struct _GstAggregatorClass {
 
 GType  gst_aggregator_get_type (void);
 
-gboolean       gst_aggregator_factory_init     (GstElementFactory *factory);
-
 G_END_DECLS
 
 #endif /* __GST_AGGREGATOR_H__ */
index a8e7cd0..e2ebe01 100644 (file)
@@ -75,8 +75,6 @@ struct _GstFakeSinkClass {
 
 GType gst_fakesink_get_type(void);
 
-gboolean gst_fakesink_factory_init (GstElementFactory *factory);
-
 G_END_DECLS
 
 #endif /* __GST_FAKESINK_H__ */
index e7880b2..3a4dc5f 100644 (file)
@@ -115,8 +115,6 @@ struct _GstFakeSrcClass {
 
 GType gst_fakesrc_get_type(void);
 
-gboolean gst_fakesrc_factory_init (GstElementFactory *factory);
-
 G_END_DECLS
 
 #endif /* __GST_FAKESRC_H__ */
index fc847b2..d2b8109 100644 (file)
@@ -69,8 +69,6 @@ struct _GstMD5SinkClass {
 
 GType                          gst_md5sink_get_type            (void);
 
-gboolean                       gst_md5sink_factory_init        (GstElementFactory *factory);
-
 G_END_DECLS
 
 #endif /* __GST_MD5SINK_H__ */
index 2cbaf53..1fe84e5 100644 (file)
@@ -66,8 +66,6 @@ struct _GstShaperClass {
 };
 
 GType          gst_shaper_get_type     (void);
-gboolean       gst_shaper_factory_init (GstElementFactory *factory);
-
 
 G_END_DECLS
 
index b58a6c0..f28b09d 100644 (file)
@@ -58,8 +58,6 @@ struct _GstTeeClass {
 
 GType  gst_tee_get_type        (void);
 
-gboolean       gst_tee_factory_init    (GstElementFactory *factory);
-
 G_END_DECLS
 
 #endif /* __GST_TEE_H__ */
index f1c84be..8871de0 100644 (file)
--- a/gst/gst.c
+++ b/gst/gst.c
@@ -48,8 +48,6 @@ static GstRegistry *_user_registry;
 static gboolean _gst_registry_fixed = FALSE;
 #endif
 
-static gboolean _gst_use_threads = TRUE;
-
 static gboolean _gst_enable_cpu_opt = TRUE;
 
 static gboolean gst_initialized = FALSE;
@@ -61,8 +59,6 @@ extern gint _gst_trace_on;
 /* set to TRUE when segfaults need to be left as is */
 gboolean _gst_disable_segtrap = FALSE;
 
-extern GThreadFunctions gst_thread_dummy_functions;
-
 
 static void load_plugin_func (gpointer data, gpointer user_data);
 static void init_popt_callback (poptContext context,
@@ -164,7 +160,7 @@ gst_init_get_popt_table (void)
     {"gst-plugin-load", NUL, POPT_ARG_STRING | POPT_ARGFLAG_STRIP, NULL,
           ARG_PLUGIN_LOAD,
           N_("Comma-separated list of plugins to preload in addition to the "
-              "list stored in env variable GST_PLUGIN_PATH"),
+              "list stored in envronment variable GST_PLUGIN_PATH"),
         N_("PLUGINS")},
     {"gst-disable-segtrap", NUL, POPT_ARG_NONE | POPT_ARGFLAG_STRIP, NULL,
           ARG_SEGTRAP_DISABLE,
@@ -232,6 +228,11 @@ gst_init_check (int *argc, char **argv[])
  * This function will terminate your program if it was unable to initialize
  * GStreamer for some reason.  If you want your program to fall back,
  * use gst_init_check() instead.
+ *
+ * WARNING: This function does not work in the same way as corresponding
+ * functions in other glib-style libraries, such as gtk_init().  In
+ * particular, unknown command line options cause this function to
+ * abort program execution.
  */
 void
 gst_init (int *argc, char **argv[])
@@ -449,12 +450,8 @@ init_pre (void)
 
   if (g_thread_supported ()) {
     /* somebody already initialized threading */
-    _gst_use_threads = TRUE;
   } else {
-    if (_gst_use_threads)
-      g_thread_init (NULL);
-    else
-      g_thread_init (&gst_thread_dummy_functions);
+    g_thread_init (NULL);
   }
   /* we need threading to be enabled right here */
   _gst_debug_init ();
@@ -566,8 +563,7 @@ init_post (void)
   llf = G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_ERROR | G_LOG_FLAG_FATAL;
   g_log_set_handler (g_log_domain_gstreamer, llf, debug_log_handler, NULL);
 
-  GST_INFO ("Initializing GStreamer Core Library version %s %s",
-      VERSION, _gst_use_threads ? "" : "(no threads)");
+  GST_INFO ("Initializing GStreamer Core Library version %s", VERSION);
 
   _gst_format_initialize ();
   _gst_query_type_initialize ();
@@ -806,27 +802,19 @@ init_popt_callback (poptContext context, enum poptCallbackReason reason,
  * gst_use_threads:
  * @use_threads: a #gboolean indicating whether threads should be used
  *
- * Instructs the core to turn on/off threading. When threading
- * is turned off, all thread operations such as mutexes and conditionals
- * are turned into NOPs. use this if you want absolute minimal overhead
- * and you don't use any threads in the pipeline.
- * <note><para>
- * This function may only be called before threads are initialized. This
- * usually happens when calling gst_init.
- * </para></note>
+ * This function is deprecated and should not be used in new code.
+ * GStreamer requires threads to be enabled at all times.
  */
 void
 gst_use_threads (gboolean use_threads)
 {
-  g_return_if_fail (!gst_initialized);
-  g_return_if_fail (g_thread_supported ());
-
-  _gst_use_threads = use_threads;
 }
 
 /**
  * gst_has_threads:
  *
+ * This function is deprecated and should not be used in new code.
+ *
  * Queries if GStreamer has threads enabled.
  *
  * Returns: %TRUE if threads are enabled.
@@ -834,7 +822,7 @@ gst_use_threads (gboolean use_threads)
 gboolean
 gst_has_threads (void)
 {
-  return _gst_use_threads;
+  return TRUE;
 }
 
 
@@ -844,6 +832,9 @@ static GSList *mainloops = NULL;
  * gst_main:
  *
  * Enters the main GStreamer processing loop.
+ *
+ * This function duplicates functionality in glib, and will be removed
+ * during the 0.9 development series.
  */
 void
 gst_main (void)
@@ -860,6 +851,9 @@ gst_main (void)
  * gst_main_quit:
  *
  * Exits the main GStreamer processing loop.
+ *
+ * This function duplicates functionality in glib, and will be removed
+ * during the 0.9 development series.
  */
 void
 gst_main_quit (void)
index f7bd00e..c17dc57 100644 (file)
@@ -89,6 +89,11 @@ static void gst_bin_init (GstBin * bin);
 static GstElementClass *parent_class = NULL;
 static guint gst_bin_signals[LAST_SIGNAL] = { 0 };
 
+/**
+ * gst_bin_get_type:
+ *
+ * Returns: the type of #GstBin
+ */
 GType
 gst_bin_get_type (void)
 {
@@ -409,9 +414,10 @@ gst_bin_unset_element_sched (GstElement * element, GstScheduler * sched)
  * gst_bin_add_many:
  * @bin: the bin to add the elements to
  * @element_1: the first element to add to the bin
- * @...: NULL-terminated list of elements to add to the bin
+ * @...: additional elements to add to the bin
  * 
- * Add a list of elements to a bin. Uses #gst_bin_add.
+ * Adds a NULL-terminated list of elements to a bin.  This function is
+ * equivalent to calling #gst_bin_add() for each member of the list.
  */
 void
 gst_bin_add_many (GstBin * bin, GstElement * element_1, ...)
@@ -481,8 +487,8 @@ gst_bin_add_func (GstBin * bin, GstElement * element)
  * @bin: #GstBin to add element to
  * @element: #GstElement to add to bin
  *
- * Add the given element to the bin.  Set the elements parent, and thus
- * add a reference.
+ * Adds the given element to the bin.  Sets the element's parent, and thus
+ * adds a reference.
  */
 void
 gst_bin_add (GstBin * bin, GstElement * element)
@@ -558,10 +564,11 @@ gst_bin_remove_func (GstBin * bin, GstElement * element)
  * @bin: #GstBin to remove element from
  * @element: #GstElement to remove
  *
- * Remove the element from its associated bin, unparenting as well.
- * The element will also be unreferenced so there's no need to call
- * gst_object_unref on it.
- * If you want the element to still exist after removing, you need to call
+ * Remove the element from its associated bin, unparenting it as well.
+ * Unparenting the element means that the element will be dereferenced,
+ * so if the bin holds the only reference to the element, the element
+ * will be freed in the process of removing it from the bin.  If you
+ * want the element to still exist after removing, you need to call
  * #gst_object_ref before removing it from the bin.
  */
 void
@@ -591,7 +598,8 @@ gst_bin_remove (GstBin * bin, GstElement * element)
  * @element_1: the first element to remove from the bin
  * @...: NULL-terminated list of elements to remove from the bin
  * 
- * Remove a list of elements from a bin. Uses #gst_bin_remove.
+ * Remove a list of elements from a bin. This function is equivalent
+ * to calling #gst_bin_remove with each member of the list.
  */
 void
 gst_bin_remove_many (GstBin * bin, GstElement * element_1, ...)
index 60cdbf6..373b363 100644 (file)
@@ -37,8 +37,6 @@ extern GType _gst_bin_type;
 #define GST_BIN(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_BIN, GstBin))
 #define GST_BIN_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_BIN, GstBinClass))
 
-typedef void           (*GstBinPrePostIterateFunction)         (GstBin *bin, gpointer user_data);
-
 typedef enum {
   /* this bin is a manager of child elements, i.e. a pipeline or thread */
   GST_BIN_FLAG_MANAGER         = GST_ELEMENT_FLAG_LAST,
@@ -119,13 +117,6 @@ GstElementStateReturn gst_bin_sync_children_state (GstBin *bin);
 void           gst_bin_child_state_change              (GstBin *bin, GstElementState oldstate, 
                                                         GstElementState newstate, GstElement *child);
 
-void           gst_bin_set_pre_iterate_function        (GstBin *bin, 
-                                                        GstBinPrePostIterateFunction func, 
-                                                        gpointer user_data);
-void           gst_bin_set_post_iterate_function       (GstBin *bin, 
-                                                        GstBinPrePostIterateFunction func, 
-                                                        gpointer user_data);
-
 G_END_DECLS
 
 
index 1877607..325a9c2 100644 (file)
@@ -339,8 +339,8 @@ gst_buffer_merge (GstBuffer * buf1, GstBuffer * buf2)
  * @buf1: a first source #GstBuffer.
  * @buf2: the second source #GstBuffer.
  *
- * Determines whether a gst_buffer_span() is free (as in free beer), 
- * or requires a memcpy. 
+ * Determines whether a gst_buffer_span() can be done without copying
+ * the contents, that is, whether the data areas are contiguous.
  *
  * Returns: TRUE if the buffers are contiguous, 
  * FALSE if a copy would be required.
index f447e53..e14db46 100644 (file)
@@ -332,6 +332,8 @@ gst_caps_append_structure (GstCaps * caps, GstStructure * structure)
  * gst_caps_split_one:
  * @caps: 
  *
+ * This function is not implemented.
+ *
  * Returns:
  */
 GstCaps *
@@ -344,9 +346,11 @@ gst_caps_split_one (GstCaps * caps)
 }
 
 /**
- * gst_caps_split_one:
+ * gst_caps_get_size:
  * @caps: a #GstCaps
  *
+ * Gets the number of structures contained in @caps.
+ *
  * Returns: the number of structures that @caps contains
  */
 int
@@ -467,6 +471,8 @@ gst_caps_set_simple_valist (GstCaps * caps, char *field, va_list varargs)
  * gst_caps_is_any:
  * @caps: the @GstCaps to test
  *
+ * Determines if @caps represents any media format.
+ *
  * Returns: TRUE if @caps represents any format.
  */
 gboolean
@@ -481,6 +487,8 @@ gst_caps_is_any (const GstCaps * caps)
  * gst_caps_is_empty:
  * @caps: the @GstCaps to test
  *
+ * Determines if @caps represents no media formats.
+ *
  * Returns: TRUE if @caps represents no formats.
  */
 gboolean
@@ -498,6 +506,11 @@ gst_caps_is_empty (const GstCaps * caps)
  * gst_caps_is_chained:
  * @caps: the @GstCaps to test
  *
+ * Determines if @caps contains multiple #GstStructures.
+ *
+ * This function is deprecated, and should not be used in new code.
+ * Use #gst_caps_is_simple() instead.
+ *
  * Returns: TRUE if @caps contains more than one structure
  */
 gboolean
@@ -641,10 +654,14 @@ gst_caps_cap_is_always_compatible (const GstStructure * struct1,
 }
 
 /**
- * gst_caps_is_always_compatible
+ * gst_caps_is_always_compatible:
  * @caps1: the #GstCaps to test
  * @caps2: the #GstCaps to test
  *
+ * A given #GstCaps structure is always compatible with another if
+ * every media format that is in the first is also contained in the
+ * second.  That is, @caps1 is a subset of @caps2.
+ *
  * Returns: TRUE if @caps1 is a subset of @caps2.
  */
 gboolean
@@ -654,14 +671,15 @@ gst_caps_is_always_compatible (const GstCaps * caps1, const GstCaps * caps2)
 
   g_return_val_if_fail (caps1 != NULL, FALSE);
   g_return_val_if_fail (caps2 != NULL, FALSE);
-  /* FIXME: is this right ? */
-  g_return_val_if_fail (!gst_caps_is_empty (caps1), FALSE);
-  g_return_val_if_fail (!gst_caps_is_empty (caps2), FALSE);
 
   if (gst_caps_is_any (caps2))
     return TRUE;
   if (gst_caps_is_any (caps1))
     return FALSE;
+  if (gst_caps_is_empty (caps1))
+    return TRUE;
+  if (gst_caps_is_empty (caps2))
+    return FALSE;
 
   for (i = 0; i < caps1->structs->len; i++) {
     GstStructure *struct1 = gst_caps_get_structure (caps1, i);
@@ -996,6 +1014,15 @@ gst_caps_simplify (const GstCaps * caps)
 }
 
 #ifndef GST_DISABLE_LOADSAVE
+/**
+ * gst_caps_save_thyself:
+ * @caps: a #GstCaps structure
+ * @parent: a XML parent node
+ *
+ * Serializes a #GstCaps to XML and adds it as a child node of @parent.
+ *
+ * Returns: a XML node pointer
+ */
 xmlNodePtr
 gst_caps_save_thyself (const GstCaps * caps, xmlNodePtr parent)
 {
@@ -1003,6 +1030,14 @@ gst_caps_save_thyself (const GstCaps * caps, xmlNodePtr parent)
   return 0;
 }
 
+/**
+ * gst_caps_load_thyself:
+ * @parent: a XML node
+ *
+ * Creates a #GstCaps from its XML serialization.
+ *
+ * Returns: a new #GstCaps structure
+ */
 GstCaps *
 gst_caps_load_thyself (xmlNodePtr parent)
 {
@@ -1171,6 +1206,17 @@ gst_caps_copy_conditional (const GstCaps * src)
 
 /* fixate utility functions */
 
+/**
+ * gst_caps_structure_fixate_field_nearest_int:
+ * @structure: a #GstStructure
+ * @field_name: a field in @structure
+ * @target: the target value of the fixation
+ *
+ * Fixates a #GstStructure by changing the given field to the nearest
+ * integer to @target that is a subset of the existing field.
+ *
+ * Returns: TRUE if the structure could be fixated
+ */
 gboolean
 gst_caps_structure_fixate_field_nearest_int (GstStructure * structure,
     const char *field_name, int target)
@@ -1223,6 +1269,17 @@ gst_caps_structure_fixate_field_nearest_int (GstStructure * structure,
   return FALSE;
 }
 
+/**
+ * gst_caps_structure_fixate_field_nearest_double:
+ * @structure: a #GstStructure
+ * @field_name: a field in @structure
+ * @target: the target value of the fixation
+ *
+ * Fixates a #GstStructure by changing the given field to the nearest
+ * double to @target that is a subset of the existing field.
+ *
+ * Returns: TRUE if the structure could be fixated
+ */
 gboolean
 gst_caps_structure_fixate_field_nearest_double (GstStructure * structure,
     const char *field_name, double target)
index 777df08..0d121bf 100644 (file)
 
 #include <gst/gstfilter.h>
 
+/**
+ * gst_filter_run:
+ * @list: a linked list
+ * @func: the function to execute for each item
+ * @first: flag to stop execution after a successful item
+ * @user_data: user data
+ *
+ * Iterates over the elements in @list, calling @func with the
+ * list item data for each item.  If @func returns TRUE, @data is
+ * prepended to the list of results returned.  If @first is true,
+ * the search is halted after the first result is found.
+ *
+ * Returns: the list of results
+ */
 GList *
 gst_filter_run (const GList * list, GstFilterFunc func, gboolean first,
     gpointer user_data)
index 79bb6c1..2ec9945 100644 (file)
@@ -373,6 +373,8 @@ gst_tag_get_description (const gchar * tag)
  * gst_tag_get_flag:
  * @tag: the tag
  *
+ * Gets the flag of @tag.
+ *
  * Returns the flag of this tag.
  */
 GstTagFlag
@@ -388,7 +390,7 @@ gst_tag_get_flag (const gchar * tag)
 }
 
 /**
- * gst_tag_list_is_fixed:
+ * gst_tag_is_fixed:
  * @tag: tag to check
  *
  * Checks if the given tag is fixed. A fixed tag can only contain one value.
@@ -827,7 +829,7 @@ gst_event_new_tag (GstTagList * list)
 }
 
 /**
- * get_event_tag_get_list:
+ * gst_event_tag_get_list:
  * @tag_event: a tagging #GstEvent
  *
  * Gets the taglist from a given tagging event.
index 79bb6c1..2ec9945 100644 (file)
@@ -373,6 +373,8 @@ gst_tag_get_description (const gchar * tag)
  * gst_tag_get_flag:
  * @tag: the tag
  *
+ * Gets the flag of @tag.
+ *
  * Returns the flag of this tag.
  */
 GstTagFlag
@@ -388,7 +390,7 @@ gst_tag_get_flag (const gchar * tag)
 }
 
 /**
- * gst_tag_list_is_fixed:
+ * gst_tag_is_fixed:
  * @tag: tag to check
  *
  * Checks if the given tag is fixed. A fixed tag can only contain one value.
@@ -827,7 +829,7 @@ gst_event_new_tag (GstTagList * list)
 }
 
 /**
- * get_event_tag_get_list:
+ * gst_event_tag_get_list:
  * @tag_event: a tagging #GstEvent
  *
  * Gets the taglist from a given tagging event.
diff --git a/gst/gstthreaddummy.c b/gst/gstthreaddummy.c
deleted file mode 100644 (file)
index 94ca056..0000000
+++ /dev/null
@@ -1,161 +0,0 @@
-/* GStreamer
- * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
- * License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * Library General Public License for more details.
- *
- * You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
- */
-
-#include <unistd.h>
-#include <sys/time.h>
-#include <glib.h>
-#include "gstlog.h"
-
-static GMutex *mutex = NULL;
-static GCond *cond = NULL;
-
-static GMutex *
-gst_mutex_new_dummy_impl (void)
-{
-  if (!mutex)
-    mutex = g_malloc (8);
-
-  return mutex;
-}
-
-static void
-gst_mutex_dummy_impl (GMutex * mutex)
-{                               /* NOP */
-}
-
-static gboolean
-gst_mutex_trylock_dummy_impl (GMutex * mutex)
-{
-  return TRUE;
-}
-
-static GCond *
-gst_cond_new_dummy_impl (void)
-{
-  if (!cond)
-    cond = g_malloc (8);
-
-  return cond;
-}
-
-static void
-gst_cond_dummy_impl (GCond * cond)
-{                               /* NOP */
-}
-
-static gboolean
-gst_cond_timed_wait_dummy_impl (GCond * cond, GMutex * mutex,
-    GTimeVal * end_time)
-{
-  struct timeval tvtarget;
-  GTimeVal tvnow;
-  guint64 now, target;
-  gint64 diff;
-
-  target = end_time->tv_sec * 1000000 + end_time->tv_usec;
-
-  g_get_current_time (&tvnow);
-  now = tvnow.tv_sec * 1000000 + tvnow.tv_usec;
-
-  diff = target - now;
-  if (diff > 1000) {
-    tvtarget.tv_usec = diff % 1000000;
-    tvtarget.tv_sec = diff / 1000000;
-
-    select (0, NULL, NULL, NULL, &tvtarget);
-  }
-
-  return TRUE;
-}
-
-static GPrivate *
-gst_private_new_dummy_impl (GDestroyNotify destructor)
-{
-  gpointer data;
-
-  data = g_new0 (gpointer, 1);
-
-  return (GPrivate *) data;
-}
-
-static gpointer
-gst_private_get_dummy_impl (GPrivate * private_key)
-{
-  gpointer *data = (gpointer) private_key;
-
-  return *data;
-}
-
-static void
-gst_private_set_dummy_impl (GPrivate * private_key, gpointer data)
-{
-  *((gpointer *) private_key) = data;
-}
-
-static void
-gst_thread_create_dummy_impl (GThreadFunc func, gpointer data,
-    gulong stack_size, gboolean joinable, gboolean bound,
-    GThreadPriority priority, gpointer thread, GError ** error)
-{
-  g_warning ("GStreamer configured to not use threads");
-}
-
-static void
-gst_thread_dummy_impl (void)
-{                               /* NOP */
-}
-
-static void
-gst_thread_dummy_impl_1 (gpointer thread)
-{                               /* NOP */
-}
-
-static void
-gst_thread_set_priority_dummy_impl (gpointer thread, GThreadPriority priority)
-{                               /* NOP */
-}
-
-static gboolean
-gst_thread_equal_dummy_impl (gpointer thread1, gpointer thread2)
-{
-  return (thread1 == thread2);
-}
-
-GThreadFunctions gst_thread_dummy_functions = {
-  gst_mutex_new_dummy_impl,
-  (void (*)(GMutex *)) gst_mutex_dummy_impl,
-  gst_mutex_trylock_dummy_impl,
-  (void (*)(GMutex *)) gst_mutex_dummy_impl,
-  gst_mutex_dummy_impl,
-  gst_cond_new_dummy_impl,
-  (void (*)(GCond *)) gst_cond_dummy_impl,
-  (void (*)(GCond *)) gst_cond_dummy_impl,
-  (void (*)(GCond *, GMutex *)) gst_cond_dummy_impl,
-  gst_cond_timed_wait_dummy_impl,
-  gst_cond_dummy_impl,
-  gst_private_new_dummy_impl,
-  gst_private_get_dummy_impl,
-  gst_private_set_dummy_impl,
-  gst_thread_create_dummy_impl,
-  gst_thread_dummy_impl,
-  gst_thread_dummy_impl_1,
-  gst_thread_dummy_impl,
-  gst_thread_set_priority_dummy_impl,
-  gst_thread_dummy_impl_1, gst_thread_equal_dummy_impl
-};
index a5e224c..4917258 100644 (file)
@@ -140,6 +140,10 @@ gst_value_lcopy_list (const GValue * value, guint n_collect_values,
 
 /**
  * gst_value_list_prepend_value:
+ * @value: a GstValueList to prepend a value to
+ * @prepend_value: the value to prepend
+ *
+ * Prepends @prepend_value to the GstValueList in @value.
  *
  */
 void
@@ -152,7 +156,10 @@ gst_value_list_prepend_value (GValue * value, const GValue * prepend_value)
 
 /**
  * gst_value_list_append_value:
+ * @value: a GstValueList to append a value to
+ * @apppend_value: the value to append
  *
+ * Appends @append_value to the GstValueList in @value.
  */
 void
 gst_value_list_append_value (GValue * value, const GValue * append_value)
@@ -164,7 +171,11 @@ gst_value_list_append_value (GValue * value, const GValue * append_value)
 
 /**
  * gst_value_list_get_size:
+ * @value: a GstValueList
+ *
+ * Gets the number of values contained in @value.
  *
+ * Returns: the number of values
  */
 guint
 gst_value_list_get_size (const GValue * value)
@@ -176,7 +187,13 @@ gst_value_list_get_size (const GValue * value)
 
 /**
  * gst_value_list_get_value:
+ * @value: a GstValueList
+ * @index
  *
+ * Gets the value that is a member of the list contained in @value and
+ * has the index @index.
+ *
+ * Returns: the value at the given index
  */
 const GValue *
 gst_value_list_get_value (const GValue * value, guint index)
@@ -194,8 +211,8 @@ gst_value_list_get_value (const GValue * value, guint index)
  * @value1: first value to put into the union
  * @value2: second value to put into the union
  *
- * Concatenates copies of value1 and value2 into a list. dest will be 
- * initialized to the type GST_TYPE_LIST.
+ * Concatenates copies of value1 and value2 into a list.  The value
+ * @dest is initialized to the type GST_TYPE_LIST.
  */
 void
 gst_value_list_concat (GValue * dest, const GValue * value1,
@@ -362,7 +379,10 @@ gst_value_lcopy_fourcc (const GValue * value, guint n_collect_values,
 
 /**
  * gst_value_set_fourcc:
+ * @value: a GValue initialized to GST_TYPE_FOURCC
+ * @fourcc: the fourcc to set
  *
+ * Sets @value to @fourcc.
  */
 void
 gst_value_set_fourcc (GValue * value, guint32 fourcc)
@@ -374,7 +394,11 @@ gst_value_set_fourcc (GValue * value, guint32 fourcc)
 
 /**
  * gst_value_get_fourcc:
+ * @value: a GValue initialized to GST_TYPE_FOURCC
+ *
+ * Gets the fourcc contained in @value.
  *
+ * Returns: the fourcc contained in @value.
  */
 guint32
 gst_value_get_fourcc (const GValue * value)
@@ -495,7 +519,11 @@ gst_value_lcopy_int_range (const GValue * value, guint n_collect_values,
 
 /**
  * gst_value_set_int_range:
+ * @value: a GValue initialized to GST_TYPE_INT_RANGE
+ * @start: the start of the range
+ * @end: the end of the range
  *
+ * Sets @value to the range specified by @start and @end.
  */
 void
 gst_value_set_int_range (GValue * value, int start, int end)
@@ -508,7 +536,11 @@ gst_value_set_int_range (GValue * value, int start, int end)
 
 /**
  * gst_value_get_int_range_min:
+ * @value: a GValue initialized to GST_TYPE_INT_RANGE
  *
+ * Gets the minimum of the range specified by @value.
+ *
+ * Returns: the minumum of the range
  */
 int
 gst_value_get_int_range_min (const GValue * value)
@@ -520,7 +552,11 @@ gst_value_get_int_range_min (const GValue * value)
 
 /**
  * gst_value_get_int_range_max:
+ * @value: a GValue initialized to GST_TYPE_INT_RANGE
+ *
+ * Gets the maximum of the range specified by @value.
  *
+ * Returns: the maxumum of the range
  */
 int
 gst_value_get_int_range_max (const GValue * value)
@@ -610,7 +646,11 @@ gst_value_lcopy_double_range (const GValue * value, guint n_collect_values,
 
 /**
  * gst_value_set_double_range:
+ * @value: a GValue initialized to GST_TYPE_DOUBLE_RANGE
+ * @start: the start of the range
+ * @end: the end of the range
  *
+ * Sets @value to the range specified by @start and @end.
  */
 void
 gst_value_set_double_range (GValue * value, double start, double end)
@@ -623,7 +663,11 @@ gst_value_set_double_range (GValue * value, double start, double end)
 
 /**
  * gst_value_get_double_range_min:
+ * @value: a GValue initialized to GST_TYPE_DOUBLE_RANGE
  *
+ * Gets the minimum of the range specified by @value.
+ *
+ * Returns: the minumum of the range
  */
 double
 gst_value_get_double_range_min (const GValue * value)
@@ -635,7 +679,11 @@ gst_value_get_double_range_min (const GValue * value)
 
 /**
  * gst_value_get_double_range_max:
+ * @value: a GValue initialized to GST_TYPE_DOUBLE_RANGE
+ *
+ * Gets the maximum of the range specified by @value.
  *
+ * Returns: the maxumum of the range
  */
 double
 gst_value_get_double_range_max (const GValue * value)
@@ -690,7 +738,11 @@ gst_value_deserialize_double_range (GValue * dest, const char *s)
 
 /**
  * gst_value_set_caps:
+ * @value: a GValue initialized to GST_TYPE_CAPS
+ * @caps: the caps to set the value to
  *
+ * Sets the contents of @value to coorespond to @caps.  The actual
+ * #GstCaps structure is copied before it is used.
  */
 void
 gst_value_set_caps (GValue * value, const GstCaps * caps)
@@ -702,7 +754,11 @@ gst_value_set_caps (GValue * value, const GstCaps * caps)
 
 /**
  * gst_value_get_caps:
+ * @value: a GValue initialized to GST_TYPE_CAPS
  *
+ * Gets the contents of @value.
+ *
+ * Returns: the contents of @value
  */
 const GstCaps *
 gst_value_get_caps (const GValue * value)
@@ -1082,7 +1138,12 @@ gst_value_intersect_list (GValue * dest, const GValue * value1,
 
 /**
  * gst_value_can_compare:
+ * @value1: a value to compare
+ * @value2: another value to compare
+ *
+ * Determines if @value1 and @value2 can be compared.
  *
+ * Returns: TRUE if the values can be compared
  */
 gboolean
 gst_value_can_compare (const GValue * value1, const GValue * value2)
@@ -1103,7 +1164,16 @@ gst_value_can_compare (const GValue * value1, const GValue * value2)
 
 /**
  * gst_value_compare:
+ * @value1: a value to compare
+ * @value2: another value to compare
  *
+ * Compares @value1 and @value2.  If @value1 and @value2 cannot be
+ * compared, the function returns GST_VALUE_UNORDERED.  Otherwise,
+ * if @value1 is greater than @value2, GST_VALUE_GREATER is returned.
+ * If @value1 is less than @value2, GST_VALUE_LESSER is returned.
+ * If the values are equal, GST_VALUE_EQUAL is returned.
+ *
+ * Returns: A GstValueCompareType value
  */
 int
 gst_value_compare (const GValue * value1, const GValue * value2)
@@ -1131,7 +1201,19 @@ gst_value_compare (const GValue * value1, const GValue * value2)
 
 /**
  * gst_value_can_union:
+ * @value1: a value to union
+ * @value2: another value to union
+ *
+ * Determines if @value1 and @value2 can be non-trivially unioned.
+ * Any two values can be trivially unioned by adding both of them
+ * to a GstValueList.  However, certain types have the possibility
+ * to be unioned in a simpler way.  For example, an integer range
+ * and an integer can be unioned if the integer is a subset of the
+ * integer range.  If there is the possibility that two values can
+ * be unioned, this function returns TRUE.
  *
+ * Returns: TRUE if there is a function allowing the two values to
+ * be unioned.
  */
 gboolean
 gst_value_can_union (const GValue * value1, const GValue * value2)
@@ -1151,7 +1233,13 @@ gst_value_can_union (const GValue * value1, const GValue * value2)
 
 /**
  * gst_value_union:
+ * @dest: the destination value
+ * @value1: a value to union
+ * @value2: another value to union
  *
+ * Creates a GValue cooresponding to the union of @value1 and @value2.
+ *
+ * Returns: TRUE if the values could be unioned
  */
 gboolean
 gst_value_union (GValue * dest, const GValue * value1, const GValue * value2)
@@ -1173,6 +1261,12 @@ gst_value_union (GValue * dest, const GValue * value1, const GValue * value2)
 
 /**
  * gst_value_register_union_func:
+ * @type1: a type to union
+ * @type2: another type to union
+ * @func: a function that implments creating a union between the two types
+ *
+ * Registers a union function that can create a union between GValues
+ * of the type @type1 and @type2.
  *
  */
 void
@@ -1216,7 +1310,13 @@ gst_value_can_intersect (const GValue * value1, const GValue * value2)
 
 /**
  * gst_value_intersect:
+ * @dest: the destination value for intersection
+ * @value1: a value to intersect
+ * @value2: another value to intersect
+ *
+ * Calculates the intersection of the two values.
  *
+ * Returns: TRUE if the intersection is non-empty
  */
 gboolean
 gst_value_intersect (GValue * dest, const GValue * value1,
index 7e6105b..24af881 100644 (file)
@@ -69,8 +69,6 @@ struct _GstAggregatorClass {
 
 GType  gst_aggregator_get_type (void);
 
-gboolean       gst_aggregator_factory_init     (GstElementFactory *factory);
-
 G_END_DECLS
 
 #endif /* __GST_AGGREGATOR_H__ */
index a8e7cd0..e2ebe01 100644 (file)
@@ -75,8 +75,6 @@ struct _GstFakeSinkClass {
 
 GType gst_fakesink_get_type(void);
 
-gboolean gst_fakesink_factory_init (GstElementFactory *factory);
-
 G_END_DECLS
 
 #endif /* __GST_FAKESINK_H__ */
index e7880b2..3a4dc5f 100644 (file)
@@ -115,8 +115,6 @@ struct _GstFakeSrcClass {
 
 GType gst_fakesrc_get_type(void);
 
-gboolean gst_fakesrc_factory_init (GstElementFactory *factory);
-
 G_END_DECLS
 
 #endif /* __GST_FAKESRC_H__ */
index fc847b2..d2b8109 100644 (file)
@@ -69,8 +69,6 @@ struct _GstMD5SinkClass {
 
 GType                          gst_md5sink_get_type            (void);
 
-gboolean                       gst_md5sink_factory_init        (GstElementFactory *factory);
-
 G_END_DECLS
 
 #endif /* __GST_MD5SINK_H__ */
index 2cbaf53..1fe84e5 100644 (file)
@@ -66,8 +66,6 @@ struct _GstShaperClass {
 };
 
 GType          gst_shaper_get_type     (void);
-gboolean       gst_shaper_factory_init (GstElementFactory *factory);
-
 
 G_END_DECLS
 
index b58a6c0..f28b09d 100644 (file)
@@ -58,8 +58,6 @@ struct _GstTeeClass {
 
 GType  gst_tee_get_type        (void);
 
-gboolean       gst_tee_factory_init    (GstElementFactory *factory);
-
 G_END_DECLS
 
 #endif /* __GST_TEE_H__ */