From 9df69622d9b415a4b1b7eec5d2c5446365d446fb Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Wed, 12 Jun 2002 22:27:18 +0000 Subject: [PATCH] Documentation updates Original commit message from CVS: Documentation updates --- docs/gst/gstreamer-docs.sgml | 2 + docs/gst/gstreamer-sections.txt | 216 ++++++++++++++---- docs/gst/tmpl/gst.sgml | 26 ++- docs/gst/tmpl/gstautoplugfactory.sgml | 8 - docs/gst/tmpl/gstbin.sgml | 35 +++ docs/gst/tmpl/gstbuffer.sgml | 5 + docs/gst/tmpl/gstcaps.sgml | 10 + docs/gst/tmpl/gstclock.sgml | 145 ++++++++---- docs/gst/tmpl/gstelement.sgml | 176 ++++++++++++++- docs/gst/tmpl/gstelementfactory.sgml | 114 +++++++++- docs/gst/tmpl/gstevent.sgml | 161 ++++++++++++-- docs/gst/tmpl/gstobject.sgml | 9 - docs/gst/tmpl/gstpad.sgml | 324 ++++++++++++++++++--------- docs/gst/tmpl/gstpadtemplate.sgml | 25 +-- docs/gst/tmpl/gstparse.sgml | 23 +- docs/gst/tmpl/gstplugin.sgml | 113 +++++----- docs/gst/tmpl/gstpluginfeature.sgml | 8 + docs/gst/tmpl/gstprops.sgml | 60 ++++- docs/gst/tmpl/gstreamer-unused.sgml | 391 ++++++++++++++++++++++++--------- docs/gst/tmpl/gstregistry.sgml | 263 ++++++++++++++++++++++ docs/gst/tmpl/gstscheduler.sgml | 1 + docs/gst/tmpl/gstschedulerfactory.sgml | 8 - docs/gst/tmpl/gstsystemclock.sgml | 26 +++ docs/gst/tmpl/gstthread.sgml | 12 +- docs/gst/tmpl/gsttypefactory.sgml | 8 - 25 files changed, 1712 insertions(+), 457 deletions(-) create mode 100644 docs/gst/tmpl/gstregistry.sgml create mode 100644 docs/gst/tmpl/gstsystemclock.sgml diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index bf31b99..e00a9d8 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -21,6 +21,7 @@ + @@ -91,6 +92,7 @@ with some more specialized elements. &GstPluginFeature; &GstProps; &GstQueue; + &GstRegistry; &GstScheduler; &GstSchedulerFactory; &GstSystemClock; diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 522e12d..46f0bdf 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -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 GstBin 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 gstparse GstParse GstParseError +GST_PARSE_ERROR +gst_parse_error_quark gst_parse_launch gst_parse_launchv @@ -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 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
-gstelement_factory +gstelementfactory GstElementFactory 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 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 @@ -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 gst_clock_get_type GST_TYPE_CLOCK @@ -502,6 +546,69 @@ GST_IS_CLOCK_CLASS
+gstregistry +GstRegistry +GstRegistryReturn +GstRegistryFlags +GstRegistry +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 + +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 +
+ +
+gstsystemclock +GstSystemClock +gst_system_clock_obtain + +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 +
+ + +
gstlog gst_info @@ -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
gstpadtemplate -GstPAD_TEMPLATE +GstPadTemplate 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 -GstPAD_TEMPLATEClass +GstPadTemplateClass GST_TYPE_PAD_TEMPLATE GST_PAD_TEMPLATE GST_PAD_TEMPLATE_CLASS @@ -749,37 +871,37 @@ gst_pipeline_details
gstplugin GstPlugin +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 +GST_PLUGIN
gstpluginfeature GstPluginFeature +GST_PLUGIN_FEATURE_NAME gst_plugin_feature_ensure_loaded gst_plugin_feature_unload_thyself @@ -864,7 +986,6 @@ GstTypeDefinition GstTypeFindFunc gst_type_factory_new gst_type_factory_find -gst_type_factory_get_list GST_TYPE_FACTORY GST_IS_TYPE_FACTORY @@ -929,7 +1050,6 @@ GST_CAPS gstprops GstProps 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 diff --git a/docs/gst/tmpl/gst.sgml b/docs/gst/tmpl/gst.sgml index 9b5ab0c..3cfee93 100644 --- a/docs/gst/tmpl/gst.sgml +++ b/docs/gst/tmpl/gst.sgml @@ -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 (&argc, &argv); ... } + + +You can also use a popt table to initialize your own parameters as shown in the next code +fragment: + + static gboolean stats = FALSE; + ... + + int + main (int argc, char *argv[]) + { + struct poptOption options[] = { + { "stats", 's', POPT_ARG_NONE|POPT_ARGFLAG_STRIP, &stats, 0, + "Show pad stats", NULL}, + POPT_TABLEEND + }; + + /* initialize the GStreamer library */ + gst_init_with_popt_table (&argc, &argv, options); + + ... + } + + Use gst_version() to query the library version at runtime or use the GST_VERSION_* macros to find the version at compile time. diff --git a/docs/gst/tmpl/gstautoplugfactory.sgml b/docs/gst/tmpl/gstautoplugfactory.sgml index a2f47ed..36848b6 100644 --- a/docs/gst/tmpl/gstautoplugfactory.sgml +++ b/docs/gst/tmpl/gstautoplugfactory.sgml @@ -65,14 +65,6 @@ Use gst_autoplug_factory_destroy() to remove the factory from the global list. @Returns: - - - - - -@Returns: - - diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml index 6ac0bbf..3368846 100644 --- a/docs/gst/tmpl/gstbin.sgml +++ b/docs/gst/tmpl/gstbin.sgml @@ -39,6 +39,11 @@ The "object_added" signal is fired whenever a new object is added to the bin. gst_bin_destroy() is used to destroy the bin. + +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. + @@ -62,6 +67,16 @@ Flags for a bin. + + +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(). + + +@bin: The bin that performed the callback +@data: user data + + @@ -156,6 +171,26 @@ Free the memory allocated by this bin @Returns: + + + + + +@bin: +@func: +@func_data: + + + + + + + +@bin: +@func: +@func_data: + + diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index 834280d..4c8d7c9 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -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 diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index a1f63ca..78e2ca7 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -223,6 +223,15 @@ Check if the GstCaps has fixed properties, ie. it has no ranges or lists. @Returns: + + + + + +@caps: +@Returns: + + @@ -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: diff --git a/docs/gst/tmpl/gstclock.sgml b/docs/gst/tmpl/gstclock.sgml index 367e168..18d0546 100644 --- a/docs/gst/tmpl/gstclock.sgml +++ b/docs/gst/tmpl/gstclock.sgml @@ -6,7 +6,14 @@ Abstract class for global clocks - +GStreamer uses a global clock to synchronise the plugins in a pipeline. +Different clock implementations are possible by implementing this abstract +base class. + + +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. @@ -16,13 +23,13 @@ Abstract class for global clocks -A datatype to hold a time, measured in microseconds. +A datatype to hold a time, measured in nanoseconds. -A datatype to hold a timedifference, measured in microseconds. +A datatype to hold a timedifference, measured in nanoseconds. @@ -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 + + +Constant to define an undefined clock time + + + + + + +Constant that defines one GStreamer second + + + + + + +Constant that defines one GStreamer millisecond + + + + + + +Constant that defines one GStreamer microsecond + + + + + + +Constant that defines one GStreamer nanosecond + + + + Calculate a difference between to clock times. @@ -70,180 +112,201 @@ Convert a GTimeVal to a GstClockTime @tv: the timeval to convert + + +Convert a GstClockTime to a GTimeVal + + +@t: The GstClockTime to convert +@tv: The target timeval + + The opaque data structure of the clock. - + @clock: -@active: +@speed: - + @clock: @Returns: + +@speed: - + @clock: -@Returns: +@active: - + @clock: -@time: -@func: -@user_data: @Returns: - + @clock: -@id: - + @clock: -@interval: -@func: -@user_data: +@time: @Returns: - + @clock: -@id: +@Returns: - + @clock: -@id: +@time: +@jitter: +@Returns: - + @clock: -@id: +@time: +@func: +@user_data: @Returns: - + @clock: -@Returns: +@id: - + @clock: +@interval: +@func: +@user_data: @Returns: - + +@clock: @id: -@Returns: - + @clock: +@id: +@jitter: @Returns: - + @clock: -@resolution: +@Returns: - + @clock: -@speed: +@id: - + @clock: @Returns: - -@speed: - + -@clock: +@id: +@Returns: - + @clock: -@time: @Returns: + + + + + +@clock: +@resolution: + + diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 4311676..41a04a6 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -184,6 +184,15 @@ of an element he doesn't need anymore. @Returns: + + + + + +@element: +@pad: + + @@ -193,6 +202,16 @@ of an element he doesn't need anymore. @Returns: + + + + + +@element: +@name: +@Returns: + + @@ -331,6 +350,16 @@ of an element he doesn't need anymore. @Returns: + + + + + +@element: +@compattempl: +@Returns: + + @@ -404,6 +433,15 @@ of an element he doesn't need anymore. @element: + + + + + +@element: +@Returns: + + @@ -430,6 +468,7 @@ of an element he doesn't need anymore. @element: @clock: @time: +@jitter: @Returns: @@ -517,6 +556,128 @@ circumstances. + + + + + +@element: + + + + + + + +@element: + + + + + + + +@element: + + + + + + + +@element: + + + + + + + +@element: +@first_property_name: +@Varargs: + + + + + + + +@element: +@property_name: +@value: + + + + + + + +@element: +@first_property_name: +@var_args: + + + + + + + +@element: +@first_property_name: +@Varargs: + + + + + + + +@element: + + + + + + + +@element: +@property_name: +@value: + + + + + + + +@element: +@first_property_name: +@var_args: + + + + + + + +@element: +@type: +@format: +@value: +@Returns: + + + + + + + +@element: +@event: +@Returns: + + 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: @@ -711,6 +872,15 @@ Get the clock of this element @obj: a #GstElement to query + + + + + +@gstelement: the object which received the signal. +@arg1: +@arg2: + diff --git a/docs/gst/tmpl/gstelementfactory.sgml b/docs/gst/tmpl/gstelementfactory.sgml index f223086..0473f24 100644 --- a/docs/gst/tmpl/gstelementfactory.sgml +++ b/docs/gst/tmpl/gstelementfactory.sgml @@ -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(). -gst_element_factory_get_list() is used to get a list of all available factories in -the plugin repository. - - 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. ... + +An elementfactory can be assigned a rank with gst_element_factory_set_rank() +so that the autopluggers can select a plugin more appropriatly + @@ -67,3 +67,109 @@ describes the element, mostly for the benefit of editors. @author: @copyright: + + + + + +@name: +@type: +@details: +@Returns: + + + + + + + +@name: +@Returns: + + + + + + + +@elementfactory: +@templ: + + + + + + + +@factory: +@caps: +@Returns: + + + + + + + +@factory: +@caps: +@Returns: + + + + + + + +@factory: +@name: +@Returns: + + + + + + + +@factoryname: +@name: +@Returns: + + + + + + + +@factory: +@rank: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml index 60295a0..a550bdf 100644 --- a/docs/gst/tmpl/gstevent.sgml +++ b/docs/gst/tmpl/gstevent.sgml @@ -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 @@ -71,11 +71,21 @@ Get the timestamp of the event. The different types of seek events. -@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 + + + +The seekaccuracy gives more information of how the seek was performed, +if the seek was accurate or fuzzy. + + +@GST_SEEK_CERTAIN: +@GST_SEEK_FUZZY: @@ -85,6 +95,30 @@ Get the seektype of the GST_EVENT_SEEK. @event: The event to query. + + +The format of the seek value + + +@event: The event operate on + + + + +The seek method to use as one of #GstSeekType + + +@event: The event operate on + + + + +The optional seek flags + + +@event: The event operate on + + Get the offset of the seek event. @@ -93,20 +127,81 @@ Get the offset of the seek event. @event: The event to query. - + -Qeury wether the seek event also needs a flush. +Indicates how accurate the event was performed. -@event: The event to query. +@event: The event to query + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + -The properties of the info event + + + + + + + + + + + + + + +Flag that indicates the discont event was because of a new media +type. + + +@event: The event to operate on + + + + +The offset of the discont event. A discont evetn can hold up to 8 different +format/value pairs. @event: The event to query +@i: The offset/value pair. + + + + +Get the number of offset/value pairs this event has. + + +@event: The event to query. @@ -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 @@ -128,21 +223,21 @@ The event data structure. @Returns: - + @event: +@Returns: - + @event: -@Returns: @@ -152,24 +247,42 @@ The event data structure. @type: @offset: -@flush: @Returns: - + -Create a new flush event. + +@new_media: +@format1: +@Varargs: +@Returns: - + -@firstname: -@Varargs: +@event: +@format: +@value: @Returns: + + +Create a new dummy event that should be ignored + + + + + + +Create a new flush event. + + + + diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml index 78d1091..272263a 100644 --- a/docs/gst/tmpl/gstobject.sgml +++ b/docs/gst/tmpl/gstobject.sgml @@ -281,15 +281,6 @@ Check if the object has been destroyed. @Returns: - - - - - -@gstobject: the object which received the signal. -@arg1: -@arg2: - Is trigered whenever a new object is saved to XML. You can connect to diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 43be1e4..501e301 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -167,20 +167,6 @@ The function that will be called when pulling a buffer. @Returns: a #GstBuffer - - -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. - - -@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 - - 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. - - -the region types for #gst_pad_pullregion. - - -@GST_REGION_VOID: -@GST_REGION_OFFSET_LEN: an offet/length pair -@GST_REGION_TIME_LEN: a time start/length pair - - - -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. - - -@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 - - Function signature to handle an event for the pad. @@ -247,13 +210,68 @@ Function signature to handle a new connection on the pad. +The result of a pad connection. + + +@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. + + + +The signature of a convert function. + + +@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. + + + + +The signature of the dispatcher callback. + + +@pad: The pad that is being dispatched +@data: user data +@Returns: TRUE if no further pads need to be processed + + + + +The signature of the internal pad connection function + + +@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. + + + + +The different supported query types + + +@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 + + +The signature of query function -@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 + @@ -283,6 +301,28 @@ Flags for the pad. @Returns: + + + + + +@type: +@name: +@direction: +@Returns: + + + + + + + +@type: +@templ: +@name: +@Returns: + + Destroy the pad. @@ -330,15 +370,6 @@ Destroy the pad. @get: - - - - - -@pad: -@getregion: - - @@ -617,20 +648,6 @@ Destroy the pad. @Returns: - - - - - -@pad: -@type: -@offset: -@len: -@Returns: - -@size: - - @@ -747,6 +764,17 @@ Destroy the pad. @Returns: + + + + + +@pad: +@dispatch: +@data: +@Returns: + + @@ -764,6 +792,7 @@ Destroy the pad. @pad: @event: +@Returns: @@ -775,6 +804,101 @@ Destroy the pad. @event: + + + + + +@pad: +@convert: + + + + + + + +@pad: +@src_format: +@src_value: +@dest_format: +@dest_value: +@Returns: + + + + + + + +@pad: +@src_format: +@src_value: +@dest_format: +@dest_value: +@Returns: + + + + + + + +@pad: +@Returns: + + + + + + + +@pad: +@Returns: + + + + + + + +@pad: +@intconn: + + + + + + + +@pad: +@query: + + + + + + + +@pad: +@type: +@format: +@value: +@Returns: + + + + + + + +@pad: +@type: +@format: +@value: +@Returns: + + @@ -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: - - -Get the length of the region that is being pulled. - - -@pad: the real pad to query. - - - - -Get the offset of the region that is being pulled. - - -@pad: the real pad to query. - - Get the scheduler of this real pad. @@ -829,14 +935,6 @@ Get the scheduler of this real pad. @pad: the real pad to query. - - -Get the type of the region that is being pulled. - - -@pad: the real pad to query. - - Get the direction of the real pad. @@ -901,22 +999,6 @@ Get get getfunction of the real pad. @pad: the real pad to query. - - -Get the getregion function of the real pad. - - -@pad: the real pad to query. - - - - -Get the pullregion function of the real pad. - - -@pad: the real pad to query. - - Get the bufferpoolfunction from the real pad. @@ -973,6 +1055,30 @@ Get the getcaps function of this pad @pad: the pad to query + + +Get the convert function of this pad + + +@pad: the pad to query + + + + +Get the internal connection function of this pad + + +@pad: the pad to query + + + + +Get the query function of this pad + + +@pad: the pad to query + + Get the real pad of this ghost pad. diff --git a/docs/gst/tmpl/gstpadtemplate.sgml b/docs/gst/tmpl/gstpadtemplate.sgml index e7eb2fa..7b0ebef 100644 --- a/docs/gst/tmpl/gstpadtemplate.sgml +++ b/docs/gst/tmpl/gstpadtemplate.sgml @@ -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(). + + + + + + Get a handle to the padtemplate #GstCaps @@ -174,25 +180,6 @@ Check if the properties of the padtemplate are fixed @Returns: - - - - - -@parent: -@Returns: - - - - - - - -@templ: -@parent: -@Returns: - - diff --git a/docs/gst/tmpl/gstparse.sgml b/docs/gst/tmpl/gstparse.sgml index 5346cc2..dc17171 100644 --- a/docs/gst/tmpl/gstparse.sgml +++ b/docs/gst/tmpl/gstparse.sgml @@ -49,10 +49,25 @@ can be made with . -@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 + + + + + + + + + + + + + +@Returns: + diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml index b04e7d7..1a4878d 100644 --- a/docs/gst/tmpl/gstplugin.sgml +++ b/docs/gst/tmpl/gstplugin.sgml @@ -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. -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. 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 + + + + + + + + + + + + +@Returns: + + + + +The plugin loading errors + + +@GST_PLUGIN_ERROR_MODULE: The plugin could not be loaded +@GST_PLUGIN_ERROR_DEPENDENCIES: The plugin has unresolved dependencies + @@ -45,7 +67,9 @@ to bring the plugin into memory. @filename: @features: @numfeatures: +@manager: @module: +@init_called: @@ -103,6 +127,19 @@ A macro used to define a statically linked plugin. @init: The init function of this plugin. + + + + + +@filename: +@Returns: + +@name: +@major: +@minor: + + @@ -157,79 +194,42 @@ A macro used to define a statically linked plugin. @Returns: - - - - - - - - - - - - -@name: -@Returns: - - - - - - - -@name: -@Returns: - - - - - - - -@path: - - - + -@name: +@plugin: @Returns: - + +@plugin: @name: +@type: @Returns: - + +@plugin: +@error: @Returns: - + -@parent: - - - - - - - -@parent: +@plugin: @Returns: @@ -242,28 +242,21 @@ A macro used to define a statically linked plugin. @feature: - + -@plugin: +@name: @Returns: - + -@plugin: +@name: @Returns: - - - - - - - diff --git a/docs/gst/tmpl/gstpluginfeature.sgml b/docs/gst/tmpl/gstpluginfeature.sgml index 03da9d3..c19812b 100644 --- a/docs/gst/tmpl/gstpluginfeature.sgml +++ b/docs/gst/tmpl/gstpluginfeature.sgml @@ -14,6 +14,14 @@ This is a base class for anything that can be added to a #GstPlugin. #GstPlugin + + +Get the name of the feature + + +@feature: The feature to query + + diff --git a/docs/gst/tmpl/gstprops.sgml b/docs/gst/tmpl/gstprops.sgml index 39a8d8e..160f6d1 100644 --- a/docs/gst/tmpl/gstprops.sgml +++ b/docs/gst/tmpl/gstprops.sgml @@ -24,12 +24,6 @@ are usually used in conjunction with GstCaps. @fixed: indicates that this props has no lists or ranges @properties: the properties - - - - - - @@ -172,6 +166,12 @@ Create an integer property that can hold positive ints. + + +An entry hols one key/value pair. + + + @@ -192,6 +192,14 @@ Create an integer property that can hold positive ints. @Returns: + + + + + +@Returns: + + @@ -301,6 +309,27 @@ Create an integer property that can hold positive ints. @Returns: + + + + + +@props: +@first_name: +@Varargs: +@Returns: + + + + + + + +@props: +@name: +@Returns: + + @@ -369,6 +398,25 @@ Create an integer property that can hold positive ints. @Returns: + + + + + +@props: +@entry: + + + + + + + +@name: +@Varargs: +@Returns: + + diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index be15d7f..5354aa4 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -219,63 +219,23 @@ Asynchronous read from a file (disksrc) GstDiskSrc - + -GstElementFactory is used to create instances of elements. A GstElementfactory -can be added to a #GstPlugin as it is also a #GstPluginFeature. - - -Use gst_element_factory_new() to create a new factory which can be added to a plugin -with gst_plugin_add_feature(). - - -gst_element_factory_get_list() is used to get a list of all available factories in -the plugin repository. - - -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. - - -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. - - -The following code example shows you how to create a GstDiskSrc element. - - - - - #include <gst/gst.h> - GstElement *src; - GstElementFactory *srcfactory; - - gst_init(&argc,&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); - ... - - + -#GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate. + - -Create GstElements from a factory + - + + GstElementFactory @@ -507,7 +467,8 @@ GstIdentity - +MD5 Sink can be used to automate regression tests on media pipelines by +computing a hash on the resulting buffers. @@ -518,7 +479,7 @@ GstIdentity - +Compute a hash on buffer data. @@ -795,26 +756,6 @@ Provide statistics about data that passes this plugin GstStatistics - - - - - - - - - - - - - - - - - -GstSystemClock - - 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 + + +Set or get the flush flag of the discont event. + + +@event: The event to operate on + + + +The properties of the info event + + +@event: The event to query + + + +Qeury wether the seek event also needs a flush. + + +@event: The event to query. + @@ -1933,6 +1895,20 @@ Get the EOS function of the real pad. @pad: the real pad to query. + + +Get the getregion function of the real pad. + + +@pad: the real pad to query. + + + +Get the length of the region that is being pulled. + + +@pad: the real pad to query. + 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. + + +Get the offset of the region that is being pulled. + + +@pad: the real pad to query. + Get the pullfunction of the real pad. @@ -1954,6 +1937,13 @@ Get the pullfunction of the real pad. @pad: the real pad to query. + + +Get the pullregion function of the real pad. + + +@pad: the real pad to query. + 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. + + +Get the type of the region that is being pulled. + + +@pad: the real pad to query. + 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. + + + + + + @@ -3565,6 +3568,15 @@ Flags indicating properties about the meta data. @GST_MULTIDISKSRC_OPEN: @GST_MULTIDISKSRC_FLAG_LAST: + + + + + +@gstobject: the object which received the signal. +@arg1: +@arg2: + @@ -3606,6 +3618,19 @@ The padfactory. + + +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. + + +@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 + 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 + + +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. + + +@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 + @@ -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 - - - - - - @@ -3773,6 +3805,32 @@ blocks. + + +the region types for #gst_pad_pullregion. + + +@GST_REGION_VOID: +@GST_REGION_OFFSET_LEN: an offet/length pair +@GST_REGION_TIME_LEN: a time start/length pair + + + + + + +@global_reg: +@local_reg: + + + + + + +@dir: +@file: +@tmp_file: + @@ -3954,7 +4012,6 @@ Flags for the GstSrc element -@clock: @@ -4146,6 +4203,24 @@ Query the element for the current mime type @y1: @y2: + + + + + + + + + + + + + + + + + + @@ -5067,6 +5142,13 @@ must be defined to activate the tracing functionality. @srccaps: @sinkcaps: + + + + + +@Returns: + @@ -5210,14 +5292,6 @@ must be defined to activate the tracing functionality. @buffer: @meta: - - - - - -@caps: -@Returns: - @@ -5572,14 +5646,6 @@ must be defined to activate the tracing functionality. @parent: @Returns: - - - - - -@element: -@event: - @@ -5641,6 +5707,15 @@ must be defined to activate the tracing functionality. @esdsink: + + + + + +@firstname: +@Varargs: +@Returns: + @@ -5988,6 +6063,18 @@ Call the EOS function of the pad @size: @Returns: + + + + + +@pad: +@type: +@offset: +@len: +@Returns: +@size: + @@ -6046,6 +6133,14 @@ Call the EOS function of the pad @pad: @eos: + + + + + +@pad: +@getregion: + @@ -6097,6 +6192,23 @@ Call the EOS function of the pad @caps: @Returns: + + + + + +@parent: +@Returns: + + + + + + +@templ: +@parent: +@Returns: + @@ -6136,6 +6248,13 @@ Call the EOS function of the pad @plugin: @factory: + + + + + +@path: + @@ -6151,6 +6270,14 @@ Call the EOS function of the pad @Returns: + + + + + +@name: +@Returns: + @@ -6167,6 +6294,13 @@ Call the EOS function of the pad @plugin: @Returns: + + + + + +@Returns: + @@ -6181,6 +6315,20 @@ Call the EOS function of the pad + + + + + +@name: +@Returns: + + + + + + + @@ -6197,6 +6345,13 @@ Call the EOS function of the pad @name: @Returns: + + + + + +@parent: + @@ -6204,16 +6359,20 @@ Call the EOS function of the pad @mime: - + -@name: -@major: -@minor: +@parent: @Returns: + + + + + + @@ -6306,6 +6465,27 @@ Call the EOS function of the pad @connection: + + + + + +@registry: + + + + + + +@Returns: + + + + + + +@Returns: + @@ -6404,6 +6584,13 @@ Call the EOS function of the pad @sched: @element: + + + + + +@Returns: + @@ -6478,13 +6665,6 @@ Call the EOS function of the pad @src: - - - - - -@Returns: - @@ -6634,6 +6814,13 @@ Call the EOS function of the pad + + + + + +@Returns: + diff --git a/docs/gst/tmpl/gstregistry.sgml b/docs/gst/tmpl/gstregistry.sgml new file mode 100644 index 0000000..d033dcd --- /dev/null +++ b/docs/gst/tmpl/gstregistry.sgml @@ -0,0 +1,263 @@ + +GstRegistry + + +Abstract class for managing plugins. + + + +The registry holds the available plugins in the system. + + + + +#GstPlugin, #GstPluginFeature + + + + + + + +@GST_REGISTRY_OK: +@GST_REGISTRY_LOAD_ERROR: +@GST_REGISTRY_SAVE_ERROR: +@GST_REGISTRY_PLUGIN_LOAD_ERROR: +@GST_REGISTRY_PLUGIN_SIGNATURE_ERROR: + + + + + + +@GST_REGISTRY_READABLE: +@GST_REGISTRY_WRITABLE: +@GST_REGISTRY_REMOTE: +@GST_REGISTRY_DELAYED_LOADING: + + + + + + +@registry: +@Returns: + + + + + + + +@registry: +@Returns: + + + + + + + +@registry: +@Returns: + + + + + + + +@registry: +@Returns: + + + + + + + +@registry: +@Returns: + + + + + + + +@registry: +@path: + + + + + + + +@registry: +@Returns: + + + + + + + +@registry: + + + + + + + +@registry: +@plugin: +@Returns: + + + + + + + +@registry: +@plugin: + + + + + + + +@registry: +@name: +@Returns: + + + + + + + +@registry: +@name: +@type: +@Returns: + + + + + + + +@registry: +@plugin: +@Returns: + + + + + + + +@registry: +@plugin: +@Returns: + + + + + + + +@registry: +@plugin: +@Returns: + + + + + + + +@Returns: + + + + + + + +@registry: +@priority: + + + + + + + +@registry: + + + + + + + +@plugin: + + + + + + + + + + + + + + +@Returns: + + + + + + + +@type: +@Returns: + + + + + + + +@name: +@Returns: + + + + + + + +@name: +@type: +@Returns: + + + + + + + +@flags: +@Returns: + + diff --git a/docs/gst/tmpl/gstscheduler.sgml b/docs/gst/tmpl/gstscheduler.sgml index ad215a6..4b1bc9d 100644 --- a/docs/gst/tmpl/gstscheduler.sgml +++ b/docs/gst/tmpl/gstscheduler.sgml @@ -239,6 +239,7 @@ Destroy the scheduler @element: @clock: @time: +@jitter: @Returns: diff --git a/docs/gst/tmpl/gstschedulerfactory.sgml b/docs/gst/tmpl/gstschedulerfactory.sgml index a231913..e56a56e 100644 --- a/docs/gst/tmpl/gstschedulerfactory.sgml +++ b/docs/gst/tmpl/gstschedulerfactory.sgml @@ -58,14 +58,6 @@ Use gst_scheduler_factory_destroy() to remove the factory from the global list. @Returns: - - - - - -@Returns: - - diff --git a/docs/gst/tmpl/gstsystemclock.sgml b/docs/gst/tmpl/gstsystemclock.sgml new file mode 100644 index 0000000..978f745 --- /dev/null +++ b/docs/gst/tmpl/gstsystemclock.sgml @@ -0,0 +1,26 @@ + +GstSystemClock + + +A default clock that uses the current system time + + + + +The System clock is an implementation of GstClock using the +system time. + + + + +#GstClock + + + + + + + +@Returns: + + diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml index 85f271d..1a74de5 100644 --- a/docs/gst/tmpl/gstthread.sgml +++ b/docs/gst/tmpl/gstthread.sgml @@ -7,15 +7,15 @@ A bin that will become a thread 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. + + +A Thread can act as a toplevel bin as it has its own scheduler. - +#GstBin, #GstPipeline @@ -23,7 +23,7 @@ to be dealt with in the separate thread. Thread flags: -@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 diff --git a/docs/gst/tmpl/gsttypefactory.sgml b/docs/gst/tmpl/gsttypefactory.sgml index 7df5e4f..815d4a6 100644 --- a/docs/gst/tmpl/gsttypefactory.sgml +++ b/docs/gst/tmpl/gsttypefactory.sgml @@ -97,11 +97,3 @@ performed by a plugin. @Returns: - - - - - -@Returns: - - -- 2.7.4