Commit 9df69622 authored by Wim Taymans's avatar Wim Taymans

Documentation updates

Original commit message from CVS:
Documentation updates
parent c8e8981b
......@@ -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;
......
......@@ -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
......
......@@ -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.
......
......@@ -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>
......
......@@ -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>
......
......@@ -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>
......
......@@ -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 ##### -->
......
......@@ -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 ##### -->