Documentation updates
authorWim Taymans <wim.taymans@gmail.com>
Wed, 12 Jun 2002 22:27:18 +0000 (22:27 +0000)
committerWim Taymans <wim.taymans@gmail.com>
Wed, 12 Jun 2002 22:27:18 +0000 (22:27 +0000)
Original commit message from CVS:
Documentation updates

25 files changed:
docs/gst/gstreamer-docs.sgml
docs/gst/gstreamer-sections.txt
docs/gst/tmpl/gst.sgml
docs/gst/tmpl/gstautoplugfactory.sgml
docs/gst/tmpl/gstbin.sgml
docs/gst/tmpl/gstbuffer.sgml
docs/gst/tmpl/gstcaps.sgml
docs/gst/tmpl/gstclock.sgml
docs/gst/tmpl/gstelement.sgml
docs/gst/tmpl/gstelementfactory.sgml
docs/gst/tmpl/gstevent.sgml
docs/gst/tmpl/gstobject.sgml
docs/gst/tmpl/gstpad.sgml
docs/gst/tmpl/gstpadtemplate.sgml
docs/gst/tmpl/gstparse.sgml
docs/gst/tmpl/gstplugin.sgml
docs/gst/tmpl/gstpluginfeature.sgml
docs/gst/tmpl/gstprops.sgml
docs/gst/tmpl/gstreamer-unused.sgml
docs/gst/tmpl/gstregistry.sgml [new file with mode: 0644]
docs/gst/tmpl/gstscheduler.sgml
docs/gst/tmpl/gstschedulerfactory.sgml
docs/gst/tmpl/gstsystemclock.sgml [new file with mode: 0644]
docs/gst/tmpl/gstthread.sgml
docs/gst/tmpl/gsttypefactory.sgml

index bf31b99c78b0a0b5328f80d515c025e0f939b07b..e00a9d895fd82753b7b4232a418b3d414fc9c8a5 100644 (file)
@@ -21,6 +21,7 @@
 <!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
 <!entity GstPluginFeature SYSTEM "sgml/gstpluginfeature.sgml">
 <!entity GstThread SYSTEM "sgml/gstthread.sgml">
+<!entity GstRegistry SYSTEM "sgml/gstregistry.sgml">
 <!entity GstScheduler SYSTEM "sgml/gstscheduler.sgml">
 <!entity GstSchedulerFactory SYSTEM "sgml/gstschedulerfactory.sgml">
 <!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
@@ -91,6 +92,7 @@ with some more specialized elements.</para>
     &GstPluginFeature;
     &GstProps;
     &GstQueue;
+    &GstRegistry;
     &GstScheduler;
     &GstSchedulerFactory;
     &GstSystemClock;
index 522e12d7387f39a5cdf8334b89573bb49482901c..46f0bdfd69d182f5deba7265399958d8263633c2 100644 (file)
@@ -140,7 +140,6 @@ GST_IS_SCHEDULER_CLASS
 gst_scheduler_factory_create
 gst_scheduler_factory_destroy
 gst_scheduler_factory_find
-gst_scheduler_factory_get_list
 gst_scheduler_factory_make
 gst_scheduler_factory_new
 gst_scheduler_factory_get_default_name
@@ -162,6 +161,7 @@ GstSchedulerFactoryClass
 <TITLE>GstBin</TITLE>
 GstBinFlags
 GstBin
+GstBinPrePostIterateFunction
 gst_bin_new
 gst_bin_destroy
 gst_bin_add
@@ -172,8 +172,9 @@ gst_bin_get_by_name_recurse_up
 gst_bin_get_list
 gst_bin_set_state_type
 gst_bin_iterate
+gst_bin_set_post_iterate_function
+gst_bin_set_pre_iterate_function
 gst_bin_child_state_change
-gst_bin_child_error
 gst_bin_auto_clock
 gst_bin_get_clock
 gst_bin_use_clock
@@ -194,6 +195,8 @@ gst_bin_details
 <FILE>gstparse</FILE>
 <TITLE>GstParse</TITLE>
 GstParseError
+GST_PARSE_ERROR
+gst_parse_error_quark
 gst_parse_launch
 gst_parse_launchv
 </SECTION>
@@ -291,17 +294,31 @@ GST_EVENT_TYPE
 GST_EVENT_SRC
 GST_EVENT_TIMESTAMP
 GstSeekType
+GstSeekAccuracy
 GST_EVENT_SEEK_TYPE
+GST_EVENT_SEEK_FORMAT
+GST_EVENT_SEEK_METHOD
+GST_EVENT_SEEK_FLAGS
 GST_EVENT_SEEK_OFFSET
-GST_EVENT_SEEK_FLUSH
-GST_EVENT_INFO_PROPS
+GST_EVENT_SEEK_ACCURACY
+GST_SEEK_FLAGS_MASK
+GST_SEEK_FLAGS_SHIFT
+GST_SEEK_FORMAT_MASK
+GST_SEEK_FORMAT_SHIFT
+GST_SEEK_METHOD_MASK
+GST_SEEK_METHOD_SHIFT
+GST_EVENT_DISCONT_NEW_MEDIA
+GST_EVENT_DISCONT_OFFSET
+GST_EVENT_DISCONT_OFFSET_LEN
 GstEvent
 gst_event_new
-gst_event_free
 gst_event_copy
+gst_event_free
 gst_event_new_seek
+gst_event_new_discontinuous
+gst_event_discont_get_value
+gst_event_new_filler
 gst_event_new_flush
-gst_event_new_info
 <SUBSECTION Standard>
 GST_EVENT
 GST_IS_EVENT
@@ -324,10 +341,11 @@ gst_element_remove_ghost_pad
 gst_element_get_pad
 gst_element_get_static_pad
 gst_element_get_request_pad
+gst_element_release_request_pad
 gst_element_get_pad_list
 
+gst_element_get_pad_template
 gst_element_get_pad_template_list
-gst_element_get_pad_template_by_name
 gst_element_class_add_pad_template
 
 gst_element_connect
@@ -339,9 +357,8 @@ gst_element_disconnect
 gst_element_disconnect_many
 gst_element_disconnect_pads
 gst_element_get_compatible_pad
-gst_element_get_compatible_static_pad
-gst_element_get_compatible_request_pad
 gst_element_get_compatible_pad_filtered
+gst_element_get_compatible_pad_template
 
 gst_element_set_state
 gst_element_get_state
@@ -352,6 +369,7 @@ gst_element_error
 gst_element_set_eos
 gst_element_interrupt
 gst_element_yield
+gst_element_release_locks
 
 gst_element_get_clock
 gst_element_set_clock
@@ -367,6 +385,22 @@ gst_element_get_parent
 gst_element_set_parent
 gst_element_get_managing_bin
 
+GstElementPostRunFunction
+GstElementPreRunFunction
+
+gst_element_disable_threadsafe_properties
+gst_element_enable_threadsafe_properties
+gst_element_get
+gst_element_get_property
+gst_element_get_valist
+gst_element_set
+gst_element_set_pending_properties
+gst_element_set_property
+gst_element_set_valist
+
+gst_element_query
+gst_element_send_event
+
 GstElementState
 GstElementStateReturn
 GST_NUM_STATES
@@ -404,17 +438,21 @@ gst_element_class_install_std_props
 </SECTION>
 
 <SECTION>
-<FILE>gstelement_factory</FILE>
+<FILE>gstelementfactory</FILE>
 <TITLE>GstElementFactory</TITLE>
 GstElementDetails
 gst_element_factory_new
 gst_element_factory_find
-gst_element_factory_get_list
 gst_element_factory_add_pad_template
 gst_element_factory_can_src_caps
 gst_element_factory_can_sink_caps
 gst_element_factory_create
 gst_element_factory_make
+gst_element_factory_set_rank
+GST_ELEMENT_RANK_MARGINAL
+GST_ELEMENT_RANK_NONE
+GST_ELEMENT_RANK_PRIMARY
+GST_ELEMENT_RANK_SECONDARY
 <SUBSECTION Standard>
 GstElementFactory
 GST_ELEMENT_FACTORY
@@ -450,7 +488,6 @@ GstAutoplugFactory
 gst_autoplug_factory_new
 gst_autoplug_factory_destroy
 gst_autoplug_factory_find
-gst_autoplug_factory_get_list
 gst_autoplug_factory_create
 gst_autoplug_factory_make
 <SUBSECTION Standard>
@@ -471,27 +508,34 @@ GstClockTimeDiff
 GstClockCallback
 GstClockID
 GstClockReturn
+GST_CLOCK_TIME_NONE
+GST_SECOND
+GST_MSECOND
+GST_USECOND
+GST_NSECOND
 GST_CLOCK_DIFF
 GST_TIMEVAL_TO_TIME
+GST_TIME_TO_TIMEVAL
 GstClock
+gst_clock_set_speed
+gst_clock_get_speed
 gst_clock_set_active
 gst_clock_is_active
+gst_clock_reset
+gst_clock_handle_discont
 gst_clock_async_supported
+gst_clock_wait
 gst_clock_wait_async
 gst_clock_cancel_wait_async
 gst_clock_notify_async
 gst_clock_remove_notify_async
-gst_clock_unlock_id
 gst_clock_wait_id
 gst_clock_get_next_id
+gst_clock_unlock_id
 gst_clock_get_time
 gst_clock_id_get_time
 gst_clock_get_resolution
 gst_clock_set_resolution
-gst_clock_set_speed
-gst_clock_get_speed
-gst_clock_reset
-gst_clock_wait
 <SUBSECTION Standard>
 gst_clock_get_type
 GST_TYPE_CLOCK
@@ -501,6 +545,69 @@ GST_IS_CLOCK
 GST_IS_CLOCK_CLASS
 </SECTION>
 
+<SECTION>
+<FILE>gstregistry</FILE>
+<TITLE>GstRegistry</TITLE>
+GstRegistryReturn
+GstRegistryFlags
+<TITLE>GstRegistry</TITLE>
+gst_registry_load
+gst_registry_is_loaded
+gst_registry_save
+gst_registry_rebuild
+gst_registry_unload
+gst_registry_add_path
+gst_registry_get_path_list
+gst_registry_clear_paths
+gst_registry_add_plugin
+gst_registry_remove_plugin
+gst_registry_find_plugin
+gst_registry_find_feature
+gst_registry_load_plugin
+gst_registry_unload_plugin
+gst_registry_update_plugin
+gst_registry_pool_list
+gst_registry_pool_add
+gst_registry_pool_remove
+gst_registry_pool_add_plugin
+gst_registry_pool_load_all
+gst_registry_pool_plugin_list
+gst_registry_pool_feature_list
+gst_registry_pool_find_plugin
+gst_registry_pool_find_feature
+gst_registry_pool_get_prefered
+<SUBSECTION Standard>
+REGISTRY_DIR_PERMS
+REGISTRY_TMPFILE_PERMS
+REGISTRY_FILE_PERMS
+GLOBAL_REGISTRY_DIR
+GLOBAL_REGISTRY_FILE
+GLOBAL_REGISTRY_FILE_TMP
+LOCAL_REGISTRY_DIR
+LOCAL_REGISTRY_FILE
+LOCAL_REGISTRY_FILE_TMP
+GST_REGISTRY
+GST_IS_REGISTRY
+GST_TYPE_REGISTRY
+gst_registry_get_type
+GST_REGISTRY_CLASS
+GST_IS_REGISTRY_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gstsystemclock</FILE>
+<TITLE>GstSystemClock</TITLE>
+gst_system_clock_obtain
+<SUBSECTION Standard>
+GST_SYSTEM_CLOCK
+GST_IS_SYSTEM_CLOCK
+GST_TYPE_SYSTEM_CLOCK
+gst_system_clock_get_type
+GST_SYSTEM_CLOCK_CLASS
+GST_IS_SYSTEM_CLOCK_CLASS
+</SECTION>
+
+
 <SECTION>
 <FILE>gstlog</FILE>
 <SUBSECTION Standard>
@@ -571,26 +678,30 @@ GST_PAD_IS_CONNECTED
 GstPad
 GstPadChainFunction
 GstPadGetFunction
-GstPadGetRegionFunction
 GstPadBufferPoolFunction
 GstPadGetCapsFunction
 
-GstRegionType
-GstPadPullRegionFunction
 GstPadEventFunction
 GstPadConnectFunction
 GstPadConnectReturn
+GstPadConvertFunction
+GstPadDispatcherFunc
+GstPadIntConnFunction
+
+GstPadQueryType
+GstPadQueryFunction
 
 GstPadDirection
 GstPadFlags
 
 gst_pad_new
+gst_pad_custom_new
+gst_pad_custom_new_from_template
 gst_pad_destroy
 gst_pad_new_from_template
 gst_pad_get_direction
 gst_pad_set_chain_function
 gst_pad_set_get_function
-gst_pad_set_getregion_function
 gst_pad_set_bufferpool_function
 gst_pad_set_connect_function
 gst_pad_set_getcaps_function
@@ -620,7 +731,6 @@ gst_pad_can_connect
 gst_pad_can_connect_filtered
 gst_pad_push
 gst_pad_pull
-gst_pad_pullregion
 gst_pad_get_bufferpool
 gst_pad_load_and_connect
 gst_pad_proxy_connect
@@ -633,15 +743,28 @@ gst_pad_ghost_save_thyself
 gst_pad_peek
 gst_pad_select
 gst_pad_selectv
+
+gst_pad_dispatcher
+
 gst_pad_send_event
 gst_pad_event_default
 gst_pad_set_event_function
 
+gst_pad_set_convert_function
+gst_pad_convert
+gst_pad_convert_default
+
+gst_pad_get_internal_connections
+gst_pad_get_internal_connections_default
+gst_pad_set_internal_connection_function
+
+gst_pad_set_query_function
+gst_pad_query
+gst_pad_query_default
+
+
 GstRealPad
-GST_RPAD_LEN
-GST_RPAD_OFFSET
 GST_RPAD_SCHED
-GST_RPAD_REGIONTYPE
 GST_RPAD_DIRECTION
 GST_RPAD_CAPS
 GST_RPAD_PEER
@@ -650,8 +773,6 @@ GST_RPAD_CHAINFUNC
 GST_RPAD_FILTER
 GST_RPAD_APPFILTER
 GST_RPAD_GETFUNC
-GST_RPAD_GETREGIONFUNC
-GST_RPAD_PULLREGIONFUNC
 GST_RPAD_BUFFERPOOLFUNC
 GST_RPAD_CHAINHANDLER
 GST_RPAD_EVENTFUNC
@@ -659,6 +780,9 @@ GST_RPAD_EVENTHANDLER
 GST_RPAD_GETHANDLER
 GST_RPAD_CONNECTFUNC
 GST_RPAD_GETCAPSFUNC
+GST_RPAD_CONVERTFUNC
+GST_RPAD_INTCONNFUNC
+GST_RPAD_QUERYFUNC
 
 GST_GPAD_REALPAD
 GstGhostPad
@@ -701,9 +825,9 @@ gst_ghost_pad_get_type
 
 <SECTION>
 <FILE>gstpadtemplate</FILE>
-<TITLE>GstPAD_TEMPLATE</TITLE>
+<TITLE>GstPadTemplate</TITLE>
 GstPadPresence
-GstPAD_TEMPLATE
+GstPadTemplate
 GST_PAD_TEMPLATE_CAPS
 GST_PAD_TEMPLATE_DIRECTION
 GST_PAD_TEMPLATE_NAME_TEMPLATE
@@ -714,13 +838,11 @@ GST_PAD_TEMPLATE_GET
 GST_PAD_TEMPLATE_FIXED
 GST_PAD_TEMPLATE_IS_FIXED
 gst_pad_template_new
-gst_pad_template_load_thyself
-gst_pad_template_save_thyself
 gst_pad_template_get_caps
 gst_pad_template_get_caps_by_name
 
 <SUBSECTION Standard>
-GstPAD_TEMPLATEClass
+GstPadTemplateClass
 GST_TYPE_PAD_TEMPLATE
 GST_PAD_TEMPLATE
 GST_PAD_TEMPLATE_CLASS
@@ -749,37 +871,37 @@ gst_pipeline_details
 <SECTION>
 <FILE>gstplugin</FILE>
 <TITLE>GstPlugin</TITLE>
+GST_PLUGIN_ERROR
+gst_plugin_error_quark
+GstPluginError
 GstPlugin
 GstPluginInitFunc
 GstPluginDesc
 GST_PLUGIN_DESC
 GST_PLUGIN_DESC_DYNAMIC
 GST_PLUGIN_DESC_STATIC
+gst_plugin_new
 gst_plugin_set_name
 gst_plugin_get_name
 gst_plugin_get_longname
 gst_plugin_set_longname
 gst_plugin_get_filename
 gst_plugin_is_loaded
-gst_plugin_load_all
-gst_plugin_load
-gst_plugin_load_absolute
-gst_plugin_add_path
-gst_library_load
-gst_plugin_find
-gst_plugin_get_list
-gst_plugin_load_thyself
-gst_plugin_save_thyself
-gst_plugin_add_feature
 gst_plugin_get_feature_list
+gst_plugin_find_feature
 gst_plugin_load_plugin
-gst_plugin_unload_all
+gst_plugin_unload_plugin
+gst_plugin_add_feature
+gst_plugin_load
+gst_library_load
 <SUBSECTION Standard>
+GST_PLUGIN
 </SECTION>
 
 <SECTION>
 <FILE>gstpluginfeature</FILE>
 <TITLE>GstPluginFeature</TITLE>
+GST_PLUGIN_FEATURE_NAME
 gst_plugin_feature_ensure_loaded
 gst_plugin_feature_unload_thyself
 <SUBSECTION Standard>
@@ -864,7 +986,6 @@ GstTypeDefinition
 GstTypeFindFunc
 gst_type_factory_new
 gst_type_factory_find
-gst_type_factory_get_list
 <SUBSECTION Standard>
 GST_TYPE_FACTORY
 GST_IS_TYPE_FACTORY
@@ -929,7 +1050,6 @@ GST_CAPS
 <FILE>gstprops</FILE>
 <TITLE>GstProps</TITLE>
 GstProps
-GstPropsEntry
 GstPropsType
 GST_TYPE_PROPS
 GST_MAKE_FOURCC
@@ -945,8 +1065,10 @@ GST_PROPS_STRING
 GST_PROPS_FLOAT
 GST_PROPS_FLOAT_RANGE
 GST_PROPS_INT_POSITIVE
+GstPropsEntry
 gst_props_new
 gst_props_newv
+gst_props_empty_new
 gst_props_merge
 gst_props_copy
 gst_props_copy_on_write
@@ -958,6 +1080,8 @@ gst_props_has_property
 gst_props_normalize
 gst_props_set
 gst_props_get
+gst_props_get_safe
+gst_props_has_property
 gst_props_has_fixed_property
 gst_props_has_property_typed
 gst_props_intersect
@@ -966,6 +1090,8 @@ gst_props_save_thyself
 gst_props_load_thyself
 
 gst_props_get_entry
+gst_props_add_entry
+gst_props_entry_new
 gst_props_entry_get
 gst_props_entry_get_boolean
 gst_props_entry_get_float
index 9b5ab0c5fc502aa33f3099fee49eef61928265f4..3cfee930226ebef996fe841b8fefac5855e24d9a 100644 (file)
@@ -33,12 +33,36 @@ process its own command line options, as shown in the following example.
   int 
   main (int argc, char *argv[])
   {
-    // initialize the GStreamer library
+    /* initialize the GStreamer library */
     gst_init (&amp;argc, &amp;argv);
     ...
   }
   </programlisting>
 </para>
+
+<para>
+You can also use a popt table to initialize your own parameters as shown in the next code 
+fragment:
+  <programlisting>
+  static gboolean stats = FALSE;
+  ...
+
+  int 
+  main (int argc, char *argv[])
+  {
+    struct poptOption options[] = {
+      { "stats",  's',  POPT_ARG_NONE|POPT_ARGFLAG_STRIP,   &amp;stats,   0,
+          "Show pad stats", NULL},
+        POPT_TABLEEND
+      };
+
+    /* initialize the GStreamer library */
+    gst_init_with_popt_table (&amp;argc, &amp;argv, options);
+      
+    ...
+  }
+  </programlisting>
+</para>
 <para>
   Use gst_version() to query the library version at runtime or use the GST_VERSION_* macros
   to find the version at compile time.
index a2f47ed16e2d415f2a5b0384228252440881a4b2..36848b63014bfcc6f3035bf549cbc33bd848924c 100644 (file)
@@ -65,14 +65,6 @@ Use gst_autoplug_factory_destroy() to remove the factory from the global list.
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_autoplug_factory_get_list ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### FUNCTION gst_autoplug_factory_create ##### -->
 <para>
 
index 6ac0bbffe87151c28b924ff17b67c93361d6bb40..3368846bab306da5026e580bbc38a91fe742d581 100644 (file)
@@ -39,6 +39,11 @@ The "object_added" signal is fired whenever a new object is added to the bin.
 <para>
 gst_bin_destroy() is used to destroy the bin. 
 </para>
+<para>
+To control the selection of the clock in a bin, you can use the following methods:
+gst_bin_auto_clock() to let the bin select a clock automatically, gst_bin_get_clock() to
+get the current clock of the bin and gst_bin_use_clock() to specify a clock explicitly.
+</para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
@@ -62,6 +67,16 @@ Flags for a bin.
 </para>
 
 
+<!-- ##### 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
+@data: user data
+
+
 <!-- ##### FUNCTION gst_bin_new ##### -->
 <para>
 
@@ -156,6 +171,26 @@ Free the memory allocated by this bin
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_bin_set_post_iterate_function ##### -->
+<para>
+
+</para>
+
+@bin: 
+@func: 
+@func_data: 
+
+
+<!-- ##### FUNCTION gst_bin_set_pre_iterate_function ##### -->
+<para>
+
+</para>
+
+@bin: 
+@func: 
+@func_data: 
+
+
 <!-- ##### FUNCTION gst_bin_child_state_change ##### -->
 <para>
 
index 834280d47299297b32ff9cc64116af45f313c595..4c8d7c97947e9b9c5821aba78d18cfa7b929f308 100644 (file)
@@ -249,6 +249,11 @@ This enumeration type describes the flags that can be used for a buffer.
 @GST_BUFFER_READONLY: buffer is read-only
 @GST_BUFFER_ORIGINAL: buffer is not a copy of another buffer
 @GST_BUFFER_DONTFREE: do not try to free the data when this buffer is unreferenced
+@GST_BUFFER_DISCONTINOUS: This buffer is the first one after a discontinuity in the stream
+@GST_BUFFER_KEY_UNIT: This buffer holds a key unit, a unit that can be decoded independently
+                      of other buffers
+@GST_BUFFER_PREROLL: This buffer should be decoded but not rendered, it is mainly used
+                     to resynchronise the stream
 
 <!-- ##### STRUCT GstBuffer ##### -->
 <para>
index a1f63ca419dbae37dc63a018ccb3d7ee8206bd7a..78e2ca7a74b06d72d1c9048995aff8de558bd2c1 100644 (file)
@@ -223,6 +223,15 @@ Check if the GstCaps has fixed properties, ie. it has no ranges or lists.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_caps_copy_1 ##### -->
+<para>
+
+</para>
+
+@caps: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_caps_copy_on_write ##### -->
 <para>
 
@@ -370,6 +379,7 @@ Check if the GstCaps has a property with the given type
 
 @caps: the caps to query
 @name: the name of the property
+@type: 
 
 
 <!-- ##### FUNCTION gst_caps_normalize ##### -->
index 367e16828ff4f84ee671de59827e6f2cbb845b45..18d0546b5595d9a715df5720b6161ec8170423e4 100644 (file)
@@ -6,7 +6,14 @@ Abstract class for global clocks
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+GStreamer uses a global clock to synchronise the plugins in a pipeline.
+Different clock implementations are possible by implementing this abstract
+base class.
+</para>
+<para>
+The clock time is always measured in nanoseconds, with the clock being set
+to 0 when the pipeline goes to READY. Usually all renderers sync to the global
+clock so that the clock is always a good measure of the time in the pipeline.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -16,13 +23,13 @@ Abstract class for global clocks
 
 <!-- ##### TYPEDEF GstClockTime ##### -->
 <para>
-A datatype to hold a time, measured in microseconds.
+A datatype to hold a time, measured in nanoseconds.
 </para>
 
 
 <!-- ##### TYPEDEF GstClockTimeDiff ##### -->
 <para>
-A datatype to hold a timedifference, measured in microseconds.
+A datatype to hold a timedifference, measured in nanoseconds.
 </para>
 
 
@@ -53,6 +60,41 @@ The return value of a clock operation.
 @GST_CLOCK_EARLY: The operation was scheduled too late.
 @GST_CLOCK_ERROR: An error occured
 
+<!-- ##### MACRO GST_CLOCK_TIME_NONE ##### -->
+<para>
+Constant to define an undefined clock time
+</para>
+
+
+
+<!-- ##### MACRO GST_SECOND ##### -->
+<para>
+Constant that defines one GStreamer second
+</para>
+
+
+
+<!-- ##### MACRO GST_MSECOND ##### -->
+<para>
+Constant that defines one GStreamer millisecond
+</para>
+
+
+
+<!-- ##### MACRO GST_USECOND ##### -->
+<para>
+Constant that defines one GStreamer microsecond
+</para>
+
+
+
+<!-- ##### MACRO GST_NSECOND ##### -->
+<para>
+Constant that defines one GStreamer nanosecond
+</para>
+
+
+
 <!-- ##### MACRO GST_CLOCK_DIFF ##### -->
 <para>
 Calculate a difference between to clock times.
@@ -70,180 +112,201 @@ Convert a GTimeVal to a GstClockTime
 @tv: the timeval to convert
 
 
+<!-- ##### MACRO GST_TIME_TO_TIMEVAL ##### -->
+<para>
+Convert a GstClockTime to a GTimeVal
+</para>
+
+@t: The GstClockTime to convert
+@tv: The target timeval
+
+
 <!-- ##### STRUCT GstClock ##### -->
 <para>
 The opaque data structure of the clock.
 </para>
 
 
-<!-- ##### FUNCTION gst_clock_set_active ##### -->
+<!-- ##### FUNCTION gst_clock_set_speed ##### -->
 <para>
 
 </para>
 
 @clock: 
-@active
+@speed
 
 
-<!-- ##### FUNCTION gst_clock_is_active ##### -->
+<!-- ##### FUNCTION gst_clock_get_speed ##### -->
 <para>
 
 </para>
 
 @clock: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@speed: 
 
 
-<!-- ##### FUNCTION gst_clock_async_supported ##### -->
+<!-- ##### FUNCTION gst_clock_set_active ##### -->
 <para>
 
 </para>
 
 @clock: 
-@Returns
+@active
 
 
-<!-- ##### FUNCTION gst_clock_wait_async ##### -->
+<!-- ##### FUNCTION gst_clock_is_active ##### -->
 <para>
 
 </para>
 
 @clock: 
-@time: 
-@func: 
-@user_data: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_clock_cancel_wait_async ##### -->
+<!-- ##### FUNCTION gst_clock_reset ##### -->
 <para>
 
 </para>
 
 @clock: 
-@id: 
 
 
-<!-- ##### FUNCTION gst_clock_notify_async ##### -->
+<!-- ##### FUNCTION gst_clock_handle_discont ##### -->
 <para>
 
 </para>
 
 @clock: 
-@interval: 
-@func: 
-@user_data: 
+@time: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_clock_remove_notify_async ##### -->
+<!-- ##### FUNCTION gst_clock_async_supported ##### -->
 <para>
 
 </para>
 
 @clock: 
-@id
+@Returns
 
 
-<!-- ##### FUNCTION gst_clock_unlock_id ##### -->
+<!-- ##### FUNCTION gst_clock_wait ##### -->
 <para>
 
 </para>
 
 @clock: 
-@id: 
+@time: 
+@jitter: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gst_clock_wait_id ##### -->
+<!-- ##### FUNCTION gst_clock_wait_async ##### -->
 <para>
 
 </para>
 
 @clock: 
-@id: 
+@time: 
+@func: 
+@user_data: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_clock_get_next_id ##### -->
+<!-- ##### FUNCTION gst_clock_cancel_wait_async ##### -->
 <para>
 
 </para>
 
 @clock: 
-@Returns
+@id
 
 
-<!-- ##### FUNCTION gst_clock_get_time ##### -->
+<!-- ##### FUNCTION gst_clock_notify_async ##### -->
 <para>
 
 </para>
 
 @clock: 
+@interval: 
+@func: 
+@user_data: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_clock_id_get_time ##### -->
+<!-- ##### FUNCTION gst_clock_remove_notify_async ##### -->
 <para>
 
 </para>
 
+@clock: 
 @id: 
-@Returns: 
 
 
-<!-- ##### FUNCTION gst_clock_get_resolution ##### -->
+<!-- ##### FUNCTION gst_clock_wait_id ##### -->
 <para>
 
 </para>
 
 @clock: 
+@id: 
+@jitter: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_clock_set_resolution ##### -->
+<!-- ##### FUNCTION gst_clock_get_next_id ##### -->
 <para>
 
 </para>
 
 @clock: 
-@resolution
+@Returns
 
 
-<!-- ##### FUNCTION gst_clock_set_speed ##### -->
+<!-- ##### FUNCTION gst_clock_unlock_id ##### -->
 <para>
 
 </para>
 
 @clock: 
-@speed: 
+@id: 
 
 
-<!-- ##### FUNCTION gst_clock_get_speed ##### -->
+<!-- ##### FUNCTION gst_clock_get_time ##### -->
 <para>
 
 </para>
 
 @clock: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@speed: 
 
 
-<!-- ##### FUNCTION gst_clock_reset ##### -->
+<!-- ##### FUNCTION gst_clock_id_get_time ##### -->
 <para>
 
 </para>
 
-@clock: 
+@id: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gst_clock_wait ##### -->
+<!-- ##### FUNCTION gst_clock_get_resolution ##### -->
 <para>
 
 </para>
 
 @clock: 
-@time: 
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_clock_set_resolution ##### -->
+<para>
+
+</para>
+
+@clock: 
+@resolution: 
+
+
index 4311676e8fc074bd8d630af6f564c1bf2ce2155f..41a04a6302ed587ed46c1e730a3248e2032ab6a6 100644 (file)
@@ -184,6 +184,15 @@ of an element he doesn't need anymore.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_element_release_request_pad ##### -->
+<para>
+
+</para>
+
+@element: 
+@pad: 
+
+
 <!-- ##### FUNCTION gst_element_get_pad_list ##### -->
 <para>
 
@@ -193,6 +202,16 @@ of an element he doesn't need anymore.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_element_get_pad_template ##### -->
+<para>
+
+</para>
+
+@element: 
+@name: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_element_get_pad_template_list ##### -->
 <para>
 
@@ -331,6 +350,16 @@ of an element he doesn't need anymore.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_element_get_compatible_pad_template ##### -->
+<para>
+
+</para>
+
+@element: 
+@compattempl: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_element_set_state ##### -->
 <para>
 
@@ -404,6 +433,15 @@ of an element he doesn't need anymore.
 @element: 
 
 
+<!-- ##### FUNCTION gst_element_release_locks ##### -->
+<para>
+
+</para>
+
+@element: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_element_get_clock ##### -->
 <para>
 
@@ -430,6 +468,7 @@ of an element he doesn't need anymore.
 @element: 
 @clock: 
 @time: 
+@jitter: 
 @Returns: 
 
 
@@ -517,6 +556,128 @@ circumstances.
 <!-- clocking -->
 
 
+<!-- ##### USER_FUNCTION GstElementPostRunFunction ##### -->
+<para>
+
+</para>
+
+@element: 
+
+
+<!-- ##### USER_FUNCTION GstElementPreRunFunction ##### -->
+<para>
+
+</para>
+
+@element: 
+
+
+<!-- ##### FUNCTION gst_element_disable_threadsafe_properties ##### -->
+<para>
+
+</para>
+
+@element: 
+
+
+<!-- ##### FUNCTION gst_element_enable_threadsafe_properties ##### -->
+<para>
+
+</para>
+
+@element: 
+
+
+<!-- ##### FUNCTION gst_element_get ##### -->
+<para>
+
+</para>
+
+@element: 
+@first_property_name: 
+@Varargs: 
+
+
+<!-- ##### FUNCTION gst_element_get_property ##### -->
+<para>
+
+</para>
+
+@element: 
+@property_name: 
+@value: 
+
+
+<!-- ##### FUNCTION gst_element_get_valist ##### -->
+<para>
+
+</para>
+
+@element: 
+@first_property_name: 
+@var_args: 
+
+
+<!-- ##### FUNCTION gst_element_set ##### -->
+<para>
+
+</para>
+
+@element: 
+@first_property_name: 
+@Varargs: 
+
+
+<!-- ##### FUNCTION gst_element_set_pending_properties ##### -->
+<para>
+
+</para>
+
+@element: 
+
+
+<!-- ##### FUNCTION gst_element_set_property ##### -->
+<para>
+
+</para>
+
+@element: 
+@property_name: 
+@value: 
+
+
+<!-- ##### FUNCTION gst_element_set_valist ##### -->
+<para>
+
+</para>
+
+@element: 
+@first_property_name: 
+@var_args: 
+
+
+<!-- ##### FUNCTION gst_element_query ##### -->
+<para>
+
+</para>
+
+@element: 
+@type: 
+@format: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_element_send_event ##### -->
+<para>
+
+</para>
+
+@element: 
+@event: 
+@Returns: 
+
+
 <!-- ##### ENUM GstElementState ##### -->
 <para>
 This enum defines the standard states an element may be in.  You will normally
@@ -623,12 +784,12 @@ This enum defines the standard flags that an element may have.
 @GST_ELEMENT_COMPLEX: 
 @GST_ELEMENT_DECOUPLED: 
 @GST_ELEMENT_THREAD_SUGGESTED: 
-@GST_ELEMENT_NO_SEEK: 
 @GST_ELEMENT_INFINITE_LOOP: 
-@GST_ELEMENT_SCHEDULER_PRIVATE1: 
-@GST_ELEMENT_SCHEDULER_PRIVATE2: 
 @GST_ELEMENT_NEW_LOOPFUNC: 
 @GST_ELEMENT_EVENT_AWARE: 
+@GST_ELEMENT_USE_THREADSAFE_PROPERTIES: 
+@GST_ELEMENT_SCHEDULER_PRIVATE1: 
+@GST_ELEMENT_SCHEDULER_PRIVATE2: 
 @GST_ELEMENT_FLAG_LAST: 
 
 <!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### -->
@@ -711,6 +872,15 @@ Get the clock of this element
 @obj: a #GstElement to query
 
 
+<!-- ##### SIGNAL GstElement::deep-notify ##### -->
+<para>
+
+</para>
+
+@gstelement: the object which received the signal.
+@arg1: 
+@arg2: 
+
 <!-- ##### SIGNAL GstElement::eos ##### -->
 <para>
 
index f2230863dbc7150cd9e0daa7eac110d816f88265..0473f240afc55746846c0f94e1b5e81ebc934af4 100644 (file)
@@ -14,10 +14,6 @@ Use gst_element_factory_new() to create a new factory which can be added to a pl
 with gst_plugin_add_feature().
 </para>
 <para>
-gst_element_factory_get_list() is used to get a list of all available factories in
-the plugin repository.
-</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.
@@ -48,6 +44,10 @@ The following code example shows you how to create a GstDiskSrc element.
   ...
   </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 See_Also ##### -->
 <para>
@@ -67,3 +67,109 @@ describes the element, mostly for the benefit of editors.
 @author: 
 @copyright: 
 
+<!-- ##### FUNCTION gst_element_factory_new ##### -->
+<para>
+
+</para>
+
+@name: 
+@type: 
+@details: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_element_factory_find ##### -->
+<para>
+
+</para>
+
+@name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_element_factory_add_pad_template ##### -->
+<para>
+
+</para>
+
+@elementfactory: 
+@templ: 
+
+
+<!-- ##### FUNCTION gst_element_factory_can_src_caps ##### -->
+<para>
+
+</para>
+
+@factory: 
+@caps: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_element_factory_can_sink_caps ##### -->
+<para>
+
+</para>
+
+@factory: 
+@caps: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_element_factory_create ##### -->
+<para>
+
+</para>
+
+@factory: 
+@name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_element_factory_make ##### -->
+<para>
+
+</para>
+
+@factoryname: 
+@name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_element_factory_set_rank ##### -->
+<para>
+
+</para>
+
+@factory: 
+@rank: 
+
+
+<!-- ##### MACRO GST_ELEMENT_RANK_MARGINAL ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_ELEMENT_RANK_NONE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_ELEMENT_RANK_PRIMARY ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_ELEMENT_RANK_SECONDARY ##### -->
+<para>
+
+</para>
+
+
+
index 60295a0667a6450ed4f99be81992c4c73fe56cf2..a550bdf75cdca6c8392057a08ce852545b7f3d2c 100644 (file)
@@ -36,11 +36,11 @@ The different major types of events.
 @GST_EVENT_EOS: an end-of-stream event.
 @GST_EVENT_FLUSH: a flush event.
 @GST_EVENT_EMPTY: an empty event.
-@GST_EVENT_SEEK: a seek event.
 @GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
-@GST_EVENT_NEW_MEDIA: 
-@GST_EVENT_INFO: an informational event
-@GST_EVENT_ERROR: an error event
+@GST_EVENT_NEW_MEDIA: a new media stream is started
+@GST_EVENT_QOS: a quality of service event
+@GST_EVENT_SEEK: a seek event.
+@GST_EVENT_FILLER: a dummy element that should be ignored by plugins
 
 <!-- ##### MACRO GST_EVENT_TYPE ##### -->
 <para>
@@ -71,11 +71,21 @@ Get the timestamp of the event.
 The different types of seek events.
 </para>
 
-@GST_SEEK_ANY: the seek is performed anyway.
-@GST_SEEK_TIMEOFFSET_SET: 
-@GST_SEEK_BYTEOFFSET_SET: 
-@GST_SEEK_BYTEOFFSET_CUR: 
-@GST_SEEK_BYTEOFFSET_END: 
+@GST_SEEK_METHOD_CUR: Seek to an relative position
+@GST_SEEK_METHOD_SET: Seek to an absolute position
+@GST_SEEK_METHOD_END: Seek relative to the end of the stream
+@GST_SEEK_FLAG_FLUSH: Flush any pending data while seeking
+@GST_SEEK_FLAG_ACCURATE: Seek as accuratly as possible
+@GST_SEEK_FLAG_KEY_UNIT: Seek to a nearby key unit
+
+<!-- ##### ENUM GstSeekAccuracy ##### -->
+<para>
+The seekaccuracy gives more information of how the seek was performed,
+if the seek was accurate or fuzzy.
+</para>
+
+@GST_SEEK_CERTAIN: 
+@GST_SEEK_FUZZY: 
 
 <!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
 <para>
@@ -85,6 +95,30 @@ Get the seektype of the GST_EVENT_SEEK.
 @event: The event to query.
 
 
+<!-- ##### MACRO GST_EVENT_SEEK_FORMAT ##### -->
+<para>
+The format of the seek value
+</para>
+
+@event: The event operate on
+
+
+<!-- ##### MACRO GST_EVENT_SEEK_METHOD ##### -->
+<para>
+The seek method to use as one of #GstSeekType
+</para>
+
+@event: The event operate on
+
+
+<!-- ##### MACRO GST_EVENT_SEEK_FLAGS ##### -->
+<para>
+The optional seek flags
+</para>
+
+@event: The event operate on
+
+
 <!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
 <para>
 Get the offset of the seek event.
@@ -93,20 +127,81 @@ Get the offset of the seek event.
 @event: The event to query.
 
 
-<!-- ##### MACRO GST_EVENT_SEEK_FLUSH ##### -->
+<!-- ##### MACRO GST_EVENT_SEEK_ACCURACY ##### -->
 <para>
-Qeury wether the seek event also needs a flush.
+Indicates how accurate the event was performed.
 </para>
 
-@event: The event to query.
+@event: The event to query
+
 
+<!-- ##### MACRO GST_SEEK_FLAGS_MASK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_SEEK_FLAGS_SHIFT ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_SEEK_FORMAT_MASK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_SEEK_FORMAT_SHIFT ##### -->
+<para>
+
+</para>
 
-<!-- ##### MACRO GST_EVENT_INFO_PROPS ##### -->
+
+
+<!-- ##### MACRO GST_SEEK_METHOD_MASK ##### -->
 <para>
-The properties of the info event
+
+</para>
+
+
+
+<!-- ##### MACRO GST_SEEK_METHOD_SHIFT ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_EVENT_DISCONT_NEW_MEDIA ##### -->
+<para>
+Flag that indicates the discont event was because of a new media
+type.
+</para>
+
+@event: The event to operate on
+
+
+<!-- ##### MACRO GST_EVENT_DISCONT_OFFSET ##### -->
+<para>
+The offset of the discont event. A discont evetn can hold up to 8 different
+format/value pairs.
 </para>
 
 @event: The event to query
+@i: The offset/value pair.
+
+
+<!-- ##### MACRO GST_EVENT_DISCONT_OFFSET_LEN ##### -->
+<para>
+Get the number of offset/value pairs this event has.
+</para>
+
+@event: The event to query.
 
 
 <!-- ##### STRUCT GstEvent ##### -->
@@ -117,7 +212,7 @@ The event data structure.
 @data: The parent data type.
 @type: The event type.
 @timestamp: The event timestamp.
-@src: 
+@src: The object that generated the event
 
 <!-- ##### FUNCTION gst_event_new ##### -->
 <para>
@@ -128,21 +223,21 @@ The event data structure.
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_event_free ##### -->
+<!-- ##### FUNCTION gst_event_copy ##### -->
 <para>
 
 </para>
 
 @event: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gst_event_copy ##### -->
+<!-- ##### FUNCTION gst_event_free ##### -->
 <para>
 
 </para>
 
 @event: 
-@Returns: 
 
 
 <!-- ##### FUNCTION gst_event_new_seek ##### -->
@@ -152,24 +247,42 @@ The event data structure.
 
 @type: 
 @offset: 
-@flush: 
 @Returns: 
 
 
-<!-- ##### MACRO gst_event_new_flush ##### -->
+<!-- ##### FUNCTION gst_event_new_discontinuous ##### -->
 <para>
-Create a new flush event.
+
 </para>
 
+@new_media: 
+@format1: 
+@Varargs: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gst_event_new_info ##### -->
+<!-- ##### FUNCTION gst_event_discont_get_value ##### -->
 <para>
 
 </para>
 
-@firstname: 
-@Varargs: 
+@event: 
+@format: 
+@value: 
 @Returns: 
 
 
+<!-- ##### MACRO gst_event_new_filler ##### -->
+<para>
+Create a new dummy event that should be ignored
+</para>
+
+
+
+<!-- ##### MACRO gst_event_new_flush ##### -->
+<para>
+Create a new flush event.
+</para>
+
+
+
index 78d109178b8ccd8fb2bcb6ac11cf5259d1fbb4d9..272263aa4734f195e442e6b7b0c0176fae097a5a 100644 (file)
@@ -281,15 +281,6 @@ Check if the object has been destroyed.
 @Returns: 
 
 
-<!-- ##### SIGNAL GstObject::deep-notify ##### -->
-<para>
-
-</para>
-
-@gstobject: the object which received the signal.
-@arg1: 
-@arg2: 
-
 <!-- ##### SIGNAL GstObject::object-saved ##### -->
 <para>
 Is trigered whenever a new object is saved to XML. You can connect to
index 43be1e4b0f447cffb3b60c679847bdcb11c127cd..501e30149617dc1fbfdef91720683ac0f79e8b99 100644 (file)
@@ -167,20 +167,6 @@ The function that will be called when pulling a buffer.
 @Returns: a #GstBuffer
 
 
-<!-- ##### 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 GstPadBufferPoolFunction ##### -->
 <para>
 The function that will be called when a bufferpool is requested
@@ -202,29 +188,6 @@ will return the pad template caps but can optionally be overridden.
 @Returns: The caps of the pad.
 
 
-<!-- ##### 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
-
-<!-- ##### 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 GstPadEventFunction ##### -->
 <para>
 Function signature to handle an event for the pad.
@@ -247,13 +210,68 @@ Function signature to handle a new connection on the pad.
 
 <!-- ##### ENUM GstPadConnectReturn ##### -->
 <para>
+The result of a pad connection.
+</para>
+
+@GST_PAD_CONNECT_REFUSED: The connectino was refused
+@GST_PAD_CONNECT_DELAYED: The connection was delayed, probably because the
+                          element needs more specific pad caps.
+@GST_PAD_CONNECT_OK: The connection succeeded.
+@GST_PAD_CONNECT_DONE: The connection succeeded, any more attempts are not needed.
+
+<!-- ##### USER_FUNCTION GstPadConvertFunction ##### -->
+<para>
+The signature of a convert function. 
+</para>
+
+@pad: The pad to perform the convert on
+@src_format: The source format of the conversion
+@src_value: The source value of the conversion
+@dest_format: a pointer to the destination format
+@dest_value: a pointer to the destination value
+@Returns: TRUE if the conversion could be performed.
+
+
+<!-- ##### 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 GstPadIntConnFunction ##### -->
+<para>
+The signature of the internal pad connection function
+</para>
+
+@pad: The pad to query
+@Returns: a Glist of pads that connect to the requested pad internally to the
+          parent element. g_list_free() after use.
+
+
+<!-- ##### ENUM GstPadQueryType ##### -->
+<para>
+The different supported query types
+</para>
+
+@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
 
+<!-- ##### USER_FUNCTION GstPadQueryFunction ##### -->
+<para>
+The signature of query function
 </para>
 
-@GST_PAD_CONNECT_REFUSED: 
-@GST_PAD_CONNECT_DELAYED: 
-@GST_PAD_CONNECT_OK: 
-@GST_PAD_CONNECT_DONE: 
+@pad: The pad to query
+@type: The query type
+@format: a pointer to the target format
+@value: a pointer to the target value
+@Returns: TRUE if the query could be performed
+
 
 <!-- ##### ENUM GstPadDirection ##### -->
 <para>
@@ -283,6 +301,28 @@ Flags for the pad.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_pad_custom_new ##### -->
+<para>
+
+</para>
+
+@type: 
+@name: 
+@direction: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_pad_custom_new_from_template ##### -->
+<para>
+
+</para>
+
+@type: 
+@templ: 
+@name: 
+@Returns: 
+
+
 <!-- ##### MACRO gst_pad_destroy ##### -->
 <para>
 Destroy the pad.
@@ -330,15 +370,6 @@ Destroy the pad.
 @get: 
 
 
-<!-- ##### FUNCTION gst_pad_set_getregion_function ##### -->
-<para>
-
-</para>
-
-@pad: 
-@getregion: 
-
-
 <!-- ##### FUNCTION gst_pad_set_bufferpool_function ##### -->
 <para>
 
@@ -617,20 +648,6 @@ Destroy the pad.
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_pad_pullregion ##### -->
-<para>
-
-</para>
-
-@pad: 
-@type: 
-@offset: 
-@len: 
-@Returns: 
-<!-- # Unused Parameters # -->
-@size: 
-
-
 <!-- ##### FUNCTION gst_pad_get_bufferpool ##### -->
 <para>
 
@@ -747,6 +764,17 @@ Destroy the pad.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_pad_dispatcher ##### -->
+<para>
+
+</para>
+
+@pad: 
+@dispatch: 
+@data: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_pad_send_event ##### -->
 <para>
 
@@ -764,6 +792,7 @@ Destroy the pad.
 
 @pad: 
 @event: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gst_pad_set_event_function ##### -->
@@ -775,6 +804,101 @@ Destroy the pad.
 @event: 
 
 
+<!-- ##### FUNCTION gst_pad_set_convert_function ##### -->
+<para>
+
+</para>
+
+@pad: 
+@convert: 
+
+
+<!-- ##### FUNCTION gst_pad_convert ##### -->
+<para>
+
+</para>
+
+@pad: 
+@src_format: 
+@src_value: 
+@dest_format: 
+@dest_value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_pad_convert_default ##### -->
+<para>
+
+</para>
+
+@pad: 
+@src_format: 
+@src_value: 
+@dest_format: 
+@dest_value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_pad_get_internal_connections ##### -->
+<para>
+
+</para>
+
+@pad: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_pad_get_internal_connections_default ##### -->
+<para>
+
+</para>
+
+@pad: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_pad_set_internal_connection_function ##### -->
+<para>
+
+</para>
+
+@pad: 
+@intconn: 
+
+
+<!-- ##### FUNCTION gst_pad_set_query_function ##### -->
+<para>
+
+</para>
+
+@pad: 
+@query: 
+
+
+<!-- ##### FUNCTION gst_pad_query ##### -->
+<para>
+
+</para>
+
+@pad: 
+@type: 
+@format: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_pad_query_default ##### -->
+<para>
+
+</para>
+
+@pad: 
+@type: 
+@format: 
+@value: 
+@Returns: 
+
+
 <!-- ##### STRUCT GstRealPad ##### -->
 <para>
 
@@ -789,38 +913,20 @@ Destroy the pad.
 @sched_private: 
 @peer: 
 @bufpen: 
-@regiontype: 
-@offset: 
-@len: 
 @chainfunc: 
 @chainhandler: 
 @getfunc: 
 @gethandler: 
 @eventfunc: 
 @eventhandler: 
-@getregionfunc: 
-@pullregionfunc: 
+@convertfunc: 
+@queryfunc: 
+@intconnfunc: 
 @getcapsfunc: 
 @connectfunc: 
 @bufferpoolfunc: 
 @ghostpads: 
 
-<!-- ##### 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_OFFSET ##### -->
-<para>
-Get the offset of the region that is being pulled.
-</para>
-
-@pad: the real pad to query.
-
-
 <!-- ##### MACRO GST_RPAD_SCHED ##### -->
 <para>
 Get the scheduler of this real pad.
@@ -829,14 +935,6 @@ Get the scheduler of this real pad.
 @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_RPAD_DIRECTION ##### -->
 <para>
 Get the direction of the real pad.
@@ -901,22 +999,6 @@ Get get getfunction of the real pad.
 @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_PULLREGIONFUNC ##### -->
-<para>
-Get the pullregion function of the real pad.
-</para>
-
-@pad: the real pad to query.
-
-
 <!-- ##### MACRO GST_RPAD_BUFFERPOOLFUNC ##### -->
 <para>
 Get the bufferpoolfunction from the real pad.
@@ -973,6 +1055,30 @@ Get the getcaps function of this pad
 @pad: the pad to query
 
 
+<!-- ##### MACRO GST_RPAD_CONVERTFUNC ##### -->
+<para>
+Get the convert function of this pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_INTCONNFUNC ##### -->
+<para>
+Get the internal connection function of this pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_QUERYFUNC ##### -->
+<para>
+Get the query function of this pad
+</para>
+
+@pad: the pad to query
+
+
 <!-- ##### MACRO GST_GPAD_REALPAD ##### -->
 <para>
 Get the real pad of this ghost pad.
index e7eb2fac96da576c41bea026354f409409eeb12d..7b0ebef8d1adc75fc30d5166e1a96a17728130d5 100644 (file)
@@ -81,6 +81,12 @@ Indicates when this pad will become available.
 @GST_PAD_REQUEST: th pad is only available on request with 
 gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
 
+<!-- ##### STRUCT GstPadTemplate ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### MACRO GST_PAD_TEMPLATE_CAPS ##### -->
 <para>
 Get a handle to the padtemplate #GstCaps
@@ -174,25 +180,6 @@ Check if the properties of the padtemplate are fixed
 @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_template_get_caps ##### -->
 <para>
 
index 5346cc252c6694dd511783a33b5a70576f84ae01..dc17171943c3de5fe8cca0c789a5cb0b847b9326 100644 (file)
@@ -49,10 +49,25 @@ can be made with <option>{}</option>.
 
 </para>
 
-@GST_PARSE_ERROR_SYNTAX: 
-@GST_PARSE_ERROR_NO_SUCH_ELEMENT: 
-@GST_PARSE_ERROR_NO_SUCH_PROPERTY: 
-@GST_PARSE_ERROR_CONNECT: 
+@GST_PARSE_ERROR_SYNTAX: A syntax error was detected
+@GST_PARSE_ERROR_NO_SUCH_ELEMENT: The pipeline description contains a non existing element
+@GST_PARSE_ERROR_NO_SUCH_PROPERTY: The pipeline description contains a non existing element property
+@GST_PARSE_ERROR_CONNECT: A pad connection could not be made
+
+<!-- ##### MACRO GST_PARSE_ERROR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gst_parse_error_quark ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
 
 <!-- ##### FUNCTION gst_parse_launch ##### -->
 <para>
index b04e7d7dbd79d334724966e21a9acf8ee41e4640..1a4878dac715dbeabaa1b0601f4edad8faffd9b5 100644 (file)
@@ -20,8 +20,7 @@ that was provided in the plugin_desc.
 Once you have a handle to a #GstPlugin, you can add any object that subclasses #GstPluginFeature.
 </para>
 <para>
-use gst_plugin_find(), gst_plugin_get_list() and gst_plugin_get_feature_list()
-to query the plugin repository.
+use gst_plugin_find_feature() and gst_plugin_get_feature_list() to find features in a plugin.
 </para>
 <para>
 Usually plugins are always automaticlly loaded so you don't need to call gst_plugin_load() explicitly 
@@ -35,6 +34,29 @@ to bring the plugin into memory.
 #GstPluginFeature, #GstType, #GstAutoplug, #GstElementFactory
 </para>
 
+<!-- ##### MACRO GST_PLUGIN_ERROR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gst_plugin_error_quark ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### ENUM GstPluginError ##### -->
+<para>
+The plugin loading errors
+</para>
+
+@GST_PLUGIN_ERROR_MODULE: The plugin could not be loaded
+@GST_PLUGIN_ERROR_DEPENDENCIES: The plugin has unresolved dependencies
+
 <!-- ##### STRUCT GstPlugin ##### -->
 <para>
 
@@ -45,7 +67,9 @@ to bring the plugin into memory.
 @filename: 
 @features: 
 @numfeatures: 
+@manager: 
 @module: 
+@init_called: 
 
 <!-- ##### USER_FUNCTION GstPluginInitFunc ##### -->
 <para>
@@ -103,6 +127,19 @@ A macro used to define a statically linked plugin.
 @init: The init function of this plugin.
 
 
+<!-- ##### FUNCTION gst_plugin_new ##### -->
+<para>
+
+</para>
+
+@filename: 
+@Returns: 
+<!-- # Unused Parameters # -->
+@name: 
+@major: 
+@minor: 
+
+
 <!-- ##### FUNCTION gst_plugin_set_name ##### -->
 <para>
 
@@ -157,79 +194,42 @@ A macro used to define a statically linked plugin.
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_plugin_load_all ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_plugin_load ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_plugin_load_absolute ##### -->
-<para>
-
-</para>
-
-@name: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_plugin_add_path ##### -->
-<para>
-
-</para>
-
-@path: 
-
-
-<!-- ##### FUNCTION gst_library_load ##### -->
+<!-- ##### FUNCTION gst_plugin_get_feature_list ##### -->
 <para>
 
 </para>
 
-@name
+@plugin
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_plugin_find ##### -->
+<!-- ##### FUNCTION gst_plugin_find_feature ##### -->
 <para>
 
 </para>
 
+@plugin: 
 @name: 
+@type: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_plugin_get_list ##### -->
+<!-- ##### FUNCTION gst_plugin_load_plugin ##### -->
 <para>
 
 </para>
 
+@plugin: 
+@error: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_plugin_load_thyself ##### -->
+<!-- ##### FUNCTION gst_plugin_unload_plugin ##### -->
 <para>
 
 </para>
 
-@parent: 
-
-
-<!-- ##### FUNCTION gst_plugin_save_thyself ##### -->
-<para>
-
-</para>
-
-@parent: 
+@plugin: 
 @Returns: 
 
 
@@ -242,28 +242,21 @@ A macro used to define a statically linked plugin.
 @feature: 
 
 
-<!-- ##### FUNCTION gst_plugin_get_feature_list ##### -->
+<!-- ##### FUNCTION gst_plugin_load ##### -->
 <para>
 
 </para>
 
-@plugin
+@name
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_plugin_load_plugin ##### -->
+<!-- ##### FUNCTION gst_library_load ##### -->
 <para>
 
 </para>
 
-@plugin
+@name
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_plugin_unload_all ##### -->
-<para>
-
-</para>
-
-
-
index 03da9d3b32586a1e98d3cdaf7f8d8b6bb6f29527..c19812b1c597888a7d1289c0266b8b3366a62792 100644 (file)
@@ -14,6 +14,14 @@ This is a base class for anything that can be added to a #GstPlugin.
 #GstPlugin
 </para>
 
+<!-- ##### MACRO GST_PLUGIN_FEATURE_NAME ##### -->
+<para>
+Get the name of the feature
+</para>
+
+@feature: The feature to query
+
+
 <!-- ##### FUNCTION gst_plugin_feature_ensure_loaded ##### -->
 <para>
 
index 39a8d8e22fb21a5a0f3648f953aeb0a7452c47f3..160f6d1c525be0306d6b8896804fd93527101da2 100644 (file)
@@ -24,12 +24,6 @@ are usually used in conjunction with GstCaps.
 @fixed: indicates that this props has no lists or ranges
 @properties: the properties
 
-<!-- ##### STRUCT GstPropsEntry ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### ENUM GstPropsType ##### -->
 <para>
 
@@ -172,6 +166,12 @@ Create an integer property that can hold positive ints.
 
 
 
+<!-- ##### STRUCT GstPropsEntry ##### -->
+<para>
+An entry hols one key/value pair.
+</para>
+
+
 <!-- ##### FUNCTION gst_props_new ##### -->
 <para>
 
@@ -192,6 +192,14 @@ Create an integer property that can hold positive ints.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_props_empty_new ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_props_merge ##### -->
 <para>
 
@@ -301,6 +309,27 @@ Create an integer property that can hold positive ints.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_props_get_safe ##### -->
+<para>
+
+</para>
+
+@props: 
+@first_name: 
+@Varargs: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_props_has_property ##### -->
+<para>
+
+</para>
+
+@props: 
+@name: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_props_has_fixed_property ##### -->
 <para>
 
@@ -369,6 +398,25 @@ Create an integer property that can hold positive ints.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_props_add_entry ##### -->
+<para>
+
+</para>
+
+@props: 
+@entry: 
+
+
+<!-- ##### FUNCTION gst_props_entry_new ##### -->
+<para>
+
+</para>
+
+@name: 
+@Varargs: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_props_entry_get ##### -->
 <para>
 
index be15d7ff6d14d5f6b4b23d7b1af1beac8e7b4e2b..5354aa410d9e74057def4db7fe5d6be33c0d7b8c 100644 (file)
@@ -219,63 +219,23 @@ Asynchronous read from a file (disksrc)
 GstDiskSrc
 
 
-<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:Long_Description ##### -->
+<!-- ##### SECTION ./tmpl/gstelement_factory.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_get_list() is used to get a list of all available factories in
-the plugin repository.
-</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 GstDiskSrc 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>
 
 
-<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:See_Also ##### -->
+<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:See_Also ##### -->
 <para>
-#GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
+
 </para>
 
 
-<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:Short_Description ##### -->
-Create GstElements from a factory
+<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:Short_Description ##### -->
 
 
-<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:Title ##### -->
+
+<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:Title ##### -->
 GstElementFactory
 
 
@@ -507,7 +467,8 @@ GstIdentity
 
 <!-- ##### SECTION ./tmpl/gstmd5sink.sgml:Long_Description ##### -->
 <para>
-
+MD5 Sink can be used to automate regression tests on media pipelines by
+computing a hash on the resulting buffers.
 </para>
 
 
@@ -518,7 +479,7 @@ GstIdentity
 
 
 <!-- ##### SECTION ./tmpl/gstmd5sink.sgml:Short_Description ##### -->
-
+Compute a hash on buffer data.
 
 
 <!-- ##### SECTION ./tmpl/gstmd5sink.sgml:Title ##### -->
@@ -795,26 +756,6 @@ Provide statistics about data that passes this plugin
 GstStatistics
 
 
-<!-- ##### SECTION ./tmpl/gstsystemclock.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstsystemclock.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstsystemclock.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gstsystemclock.sgml:Title ##### -->
-GstSystemClock
-
-
 <!-- ##### SECTION ./tmpl/gsttypefind.sgml:Long_Description ##### -->
 <para>
 This element can be added to the pipeline and will notify the listener of
@@ -1279,6 +1220,27 @@ Query whether this object has multiple input pads.
 
 @klass: <<<<<<< gstreamer-unused.sgml
 
+<!-- ##### 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_INFO_PROPS ##### -->
+<para>
+The properties of the info event
+</para>
+
+@event: The event to query
+
+<!-- ##### 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>
 
@@ -1933,6 +1895,20 @@ Get the EOS function of the real pad.
 
 @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.
@@ -1947,6 +1923,13 @@ Get the newcaps function from the real pad.
 
 @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.
@@ -1954,6 +1937,13 @@ Get the pullfunction of the real pad.
 
 @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.
@@ -1968,6 +1958,13 @@ Get the QoS function of the real pad.
 
 @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.
@@ -3540,6 +3537,12 @@ Specify the location of the file. The location must be a fully qualified URL.
 </para>
 
 
+<!-- ##### ARG GstMD5Sink:md5 ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### STRUCT GstMeta ##### -->
 <para>
 
@@ -3565,6 +3568,15 @@ Flags indicating properties about the meta data.
 @GST_MULTIDISKSRC_OPEN: 
 @GST_MULTIDISKSRC_FLAG_LAST: 
 
+<!-- ##### SIGNAL GstObject::deep-notify ##### -->
+<para>
+
+</para>
+
+@gstobject: the object which received the signal.
+@arg1: 
+@arg2: 
+
 <!-- ##### STRUCT GstObjectClass ##### -->
 <para>
 
@@ -3606,6 +3618,19 @@ 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.
@@ -3642,6 +3667,19 @@ The function that will be called when pulling buffers.
 @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>
 
@@ -3659,12 +3697,6 @@ The function that will be called when a QoS message is sent.
 @pad: the pad that sent the QoS message
 @qos_message: the message
 
-<!-- ##### STRUCT GstPadTemplate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### ENUM GstParseErrors ##### -->
 <para>
 
@@ -3773,6 +3805,32 @@ blocks.
 </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 GstRegistryRead ##### -->
+<para>
+
+</para>
+
+@global_reg: 
+@local_reg: 
+
+<!-- ##### STRUCT GstRegistryWrite ##### -->
+<para>
+
+</para>
+
+@dir: 
+@file: 
+@tmp_file: 
+
 <!-- ##### STRUCT GstScheduleChain ##### -->
 <para>
 
@@ -3954,7 +4012,6 @@ Flags for the GstSrc element
 
 </para>
 
-@clock: 
 
 <!-- ##### STRUCT GstTee ##### -->
 <para>
@@ -4146,6 +4203,24 @@ Query the element for the current mime type
 @y1: 
 @y2: 
 
+<!-- ##### MACRO REGISTRY_DIR_PERMS ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO REGISTRY_FILE_PERMS ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO REGISTRY_TMPFILE_PERMS ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### MACRO STACK_SIZE ##### -->
 <para>
 
@@ -5067,6 +5142,13 @@ must be defined to activate the tracing functionality.
 @srccaps: 
 @sinkcaps: 
 
+<!-- ##### FUNCTION gst_autoplug_factory_get_list ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
 <!-- ##### FUNCTION gst_autoplug_factory_load_thyself ##### -->
 <para>
 
@@ -5210,14 +5292,6 @@ must be defined to activate the tracing functionality.
 @buffer: 
 @meta: 
 
-<!-- ##### FUNCTION gst_caps_copy_1 ##### -->
-<para>
-
-</para>
-
-@caps: 
-@Returns: 
-
 <!-- ##### FUNCTION gst_caps_list_check_compatibility ##### -->
 <para>
 
@@ -5572,14 +5646,6 @@ must be defined to activate the tracing functionality.
 @parent: 
 @Returns: 
 
-<!-- ##### FUNCTION gst_element_send_event ##### -->
-<para>
-
-</para>
-
-@element: 
-@event: 
-
 <!-- ##### FUNCTION gst_element_signal_eos ##### -->
 <para>
 
@@ -5641,6 +5707,15 @@ must be defined to activate the tracing functionality.
 
 @esdsink: 
 
+<!-- ##### FUNCTION gst_event_new_info ##### -->
+<para>
+
+</para>
+
+@firstname: 
+@Varargs: 
+@Returns: 
+
 <!-- ##### FUNCTION gst_extra_get_filename_type ##### -->
 <para>
 
@@ -5988,6 +6063,18 @@ Call the EOS function of the pad
 @size: 
 @Returns: 
 
+<!-- ##### FUNCTION gst_pad_pullregion ##### -->
+<para>
+
+</para>
+
+@pad: 
+@type: 
+@offset: 
+@len: 
+@Returns: 
+@size: 
+
 <!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
 <para>
 
@@ -6046,6 +6133,14 @@ Call the EOS function of the pad
 @pad: 
 @eos: 
 
+<!-- ##### FUNCTION gst_pad_set_getregion_function ##### -->
+<para>
+
+</para>
+
+@pad: 
+@getregion: 
+
 <!-- ##### FUNCTION gst_pad_set_negotiate_function ##### -->
 <para>
 
@@ -6097,6 +6192,23 @@ Call the EOS function of the pad
 @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_connect ##### -->
 <para>
 
@@ -6136,6 +6248,13 @@ Call the EOS function of the pad
 @plugin: 
 @factory: 
 
+<!-- ##### FUNCTION gst_plugin_add_path ##### -->
+<para>
+
+</para>
+
+@path: 
+
 <!-- ##### FUNCTION gst_plugin_add_type ##### -->
 <para>
 
@@ -6151,6 +6270,14 @@ Call the EOS function of the pad
 
 @Returns: 
 
+<!-- ##### FUNCTION gst_plugin_find ##### -->
+<para>
+
+</para>
+
+@name: 
+@Returns: 
+
 <!-- ##### FUNCTION gst_plugin_get_autoplug_list ##### -->
 <para>
 
@@ -6167,6 +6294,13 @@ Call the EOS function of the pad
 @plugin: 
 @Returns: 
 
+<!-- ##### FUNCTION gst_plugin_get_list ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
 <!-- ##### FUNCTION gst_plugin_get_type_list ##### -->
 <para>
 
@@ -6181,6 +6315,20 @@ Call the EOS function of the pad
 </para>
 
 
+<!-- ##### FUNCTION gst_plugin_load_absolute ##### -->
+<para>
+
+</para>
+
+@name: 
+@Returns: 
+
+<!-- ##### FUNCTION gst_plugin_load_all ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### FUNCTION gst_plugin_load_autoplug_factory ##### -->
 <para>
 
@@ -6197,6 +6345,13 @@ Call the EOS function of the pad
 @name: 
 @Returns: 
 
+<!-- ##### FUNCTION gst_plugin_load_thyself ##### -->
+<para>
+
+</para>
+
+@parent: 
+
 <!-- ##### FUNCTION gst_plugin_load_type_factory ##### -->
 <para>
 
@@ -6204,16 +6359,20 @@ Call the EOS function of the pad
 
 @mime: 
 
-<!-- ##### FUNCTION gst_plugin_new ##### -->
+<!-- ##### FUNCTION gst_plugin_save_thyself ##### -->
 <para>
 
 </para>
 
-@name: 
-@major: 
-@minor: 
+@parent: 
 @Returns: 
 
+<!-- ##### FUNCTION gst_plugin_unload_all ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### FUNCTION gst_props_get_boolean ##### -->
 <para>
 
@@ -6306,6 +6465,27 @@ Call the EOS function of the pad
 
 @connection: 
 
+<!-- ##### 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>
 
@@ -6404,6 +6584,13 @@ Call the EOS function of the pad
 @sched: 
 @element: 
 
+<!-- ##### FUNCTION gst_scheduler_factory_get_list ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
 <!-- ##### FUNCTION gst_scheduler_factory_get_type ##### -->
 <para>
 
@@ -6478,13 +6665,6 @@ Call the EOS function of the pad
 
 @src: 
 
-<!-- ##### FUNCTION gst_system_clock_obtain ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
 <!-- ##### FUNCTION gst_tee_chain ##### -->
 <para>
 
@@ -6634,6 +6814,13 @@ Call the EOS function of the pad
 </para>
 
 
+<!-- ##### FUNCTION gst_type_factory_get_list ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
 <!-- ##### FUNCTION gst_type_factory_load_thyself ##### -->
 <para>
 
diff --git a/docs/gst/tmpl/gstregistry.sgml b/docs/gst/tmpl/gstregistry.sgml
new file mode 100644 (file)
index 0000000..d033dcd
--- /dev/null
@@ -0,0 +1,263 @@
+<!-- ##### SECTION Title ##### -->
+GstRegistry
+
+<!-- ##### SECTION Short_Description ##### -->
+Abstract class for managing plugins.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+The registry holds the available plugins in the system.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+#GstPlugin, #GstPluginFeature
+</para>
+
+<!-- ##### ENUM GstRegistryReturn ##### -->
+<para>
+
+</para>
+
+@GST_REGISTRY_OK: 
+@GST_REGISTRY_LOAD_ERROR: 
+@GST_REGISTRY_SAVE_ERROR: 
+@GST_REGISTRY_PLUGIN_LOAD_ERROR: 
+@GST_REGISTRY_PLUGIN_SIGNATURE_ERROR: 
+
+<!-- ##### ENUM GstRegistryFlags ##### -->
+<para>
+
+</para>
+
+@GST_REGISTRY_READABLE: 
+@GST_REGISTRY_WRITABLE: 
+@GST_REGISTRY_REMOTE: 
+@GST_REGISTRY_DELAYED_LOADING: 
+
+<!-- ##### FUNCTION gst_registry_load ##### -->
+<para>
+
+</para>
+
+@registry: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_is_loaded ##### -->
+<para>
+
+</para>
+
+@registry: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_save ##### -->
+<para>
+
+</para>
+
+@registry: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_rebuild ##### -->
+<para>
+
+</para>
+
+@registry: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_unload ##### -->
+<para>
+
+</para>
+
+@registry: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_add_path ##### -->
+<para>
+
+</para>
+
+@registry: 
+@path: 
+
+
+<!-- ##### FUNCTION gst_registry_get_path_list ##### -->
+<para>
+
+</para>
+
+@registry: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_clear_paths ##### -->
+<para>
+
+</para>
+
+@registry: 
+
+
+<!-- ##### FUNCTION gst_registry_add_plugin ##### -->
+<para>
+
+</para>
+
+@registry: 
+@plugin: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_remove_plugin ##### -->
+<para>
+
+</para>
+
+@registry: 
+@plugin: 
+
+
+<!-- ##### FUNCTION gst_registry_find_plugin ##### -->
+<para>
+
+</para>
+
+@registry: 
+@name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_find_feature ##### -->
+<para>
+
+</para>
+
+@registry: 
+@name: 
+@type: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_load_plugin ##### -->
+<para>
+
+</para>
+
+@registry: 
+@plugin: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_unload_plugin ##### -->
+<para>
+
+</para>
+
+@registry: 
+@plugin: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_update_plugin ##### -->
+<para>
+
+</para>
+
+@registry: 
+@plugin: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_pool_list ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_pool_add ##### -->
+<para>
+
+</para>
+
+@registry: 
+@priority: 
+
+
+<!-- ##### FUNCTION gst_registry_pool_remove ##### -->
+<para>
+
+</para>
+
+@registry: 
+
+
+<!-- ##### FUNCTION gst_registry_pool_add_plugin ##### -->
+<para>
+
+</para>
+
+@plugin: 
+
+
+<!-- ##### FUNCTION gst_registry_pool_load_all ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gst_registry_pool_plugin_list ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_pool_feature_list ##### -->
+<para>
+
+</para>
+
+@type: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_pool_find_plugin ##### -->
+<para>
+
+</para>
+
+@name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_pool_find_feature ##### -->
+<para>
+
+</para>
+
+@name: 
+@type: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_registry_pool_get_prefered ##### -->
+<para>
+
+</para>
+
+@flags: 
+@Returns: 
+
+
index ad215a650795d1ac733536905d700db186caef5c..4b1bc9db61abc20f54ed04df7ef3ef8b27d9d765 100644 (file)
@@ -239,6 +239,7 @@ Destroy the scheduler
 @element: 
 @clock: 
 @time: 
+@jitter: 
 @Returns: 
 
 
index a231913249297490234749d306d8084547c348fd..e56a56e7f07b75ecad7f7f3aebff0e8cf2865a33 100644 (file)
@@ -58,14 +58,6 @@ Use gst_scheduler_factory_destroy() to remove the factory from the global list.
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_scheduler_factory_get_list ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### FUNCTION gst_scheduler_factory_make ##### -->
 <para>
 
diff --git a/docs/gst/tmpl/gstsystemclock.sgml b/docs/gst/tmpl/gstsystemclock.sgml
new file mode 100644 (file)
index 0000000..978f745
--- /dev/null
@@ -0,0 +1,26 @@
+<!-- ##### SECTION Title ##### -->
+GstSystemClock
+
+<!-- ##### SECTION Short_Description ##### -->
+A default clock that uses the current system time
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+The System clock is an implementation of GstClock using the
+system time.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+#GstClock
+</para>
+
+<!-- ##### FUNCTION gst_system_clock_obtain ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
index 85f271d45b10998e0ccd3a4f91aa4b7824377058..1a74de5e42d6a7345744815167745d28e67e7e2e 100644 (file)
@@ -7,15 +7,15 @@ A bin that will become a thread
 <!-- ##### SECTION Long_Description ##### -->
 <para>
 A bin that will become a thread if possible when the pipeline is started
-up.  Can contain any set of GstObjects except another GstThread.  All
-starting points and/or clocked events must be registered with this object,
-to be dealt with in the separate thread.
-
+up. It can contain any set of GstObjects. 
+</para>
+<para>
+A Thread can act as a toplevel bin as it has its own scheduler.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
-
+#GstBin, #GstPipeline
 </para>
 
 <!-- ##### ENUM GstThreadState ##### -->
@@ -23,7 +23,7 @@ to be dealt with in the separate thread.
 Thread flags:
 </para>
 
-@GST_THREAD_STATE_STARTED: 
+@GST_THREAD_STATE_STARTED: The thread is started
 @GST_THREAD_STATE_SPINNING: The thread is runnning
 @GST_THREAD_STATE_REAPING: The thread is ending.
 @GST_THREAD_FLAG_LAST: subclass use this to start their enumeration
index 7df5e4f2ddb21876e2e8a7ed9599da8fa7d5692b..815d4a6e99b1727999383dd6ab4b4c14e756ecbd 100644 (file)
@@ -97,11 +97,3 @@ performed by a plugin.
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_type_factory_get_list ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-