From 6a37dda6d64da3c1d3596d83788d5c42645753fb Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Fri, 12 Apr 2002 16:22:32 +0000 Subject: [PATCH] doc fixes to match API Original commit message from CVS: doc fixes to match API --- common | 2 +- docs/gst/gstreamer-sections.txt | 188 +++++++++---------- docs/gst/tmpl/gstcaps.sgml | 9 - docs/gst/tmpl/gstelement.sgml | 10 - docs/gst/tmpl/gstelementfactory.sgml | 80 -------- docs/gst/tmpl/gstpad.sgml | 1 - docs/gst/tmpl/gstpadtemplate.sgml | 6 - docs/gst/tmpl/gstreamer-unused.sgml | 265 ++++++++++++++++++--------- 8 files changed, 269 insertions(+), 292 deletions(-) diff --git a/common b/common index 52a8d4bd49..22ee9f5959 160000 --- a/common +++ b/common @@ -1 +1 @@ -Subproject commit 52a8d4bd490c495f1e71725644535dbf2cf209c7 +Subproject commit 22ee9f59590241153f1b162344d760c303b1305a diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index f81b57e7b9..9df84a571a 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -137,21 +137,21 @@ GST_IS_SCHEDULER_CLASS
gstschedulerfactory GstSchedulerFactory -gst_schedulerfactory_create -gst_schedulerfactory_destroy -gst_schedulerfactory_find -gst_schedulerfactory_get_list -gst_schedulerfactory_make -gst_schedulerfactory_new -gst_schedulerfactory_get_default_name -gst_schedulerfactory_set_default_name +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 +gst_scheduler_factory_set_default_name -gst_schedulerfactory_get_type -GST_IS_SCHEDULERFACTORY -GST_IS_SCHEDULERFACTORY_CLASS -GST_SCHEDULERFACTORY -GST_SCHEDULERFACTORY_CLASS -GST_TYPE_SCHEDULERFACTORY +gst_scheduler_factory_get_type +GST_IS_SCHEDULER_FACTORY +GST_IS_SCHEDULER_FACTORY_CLASS +GST_SCHEDULER_FACTORY +GST_SCHEDULER_FACTORY_CLASS +GST_TYPE_SCHEDULER_FACTORY GstSchedulerFactory GstSchedulerFactoryClass
@@ -338,7 +338,7 @@ GstElement GstElementLoopFunction GstElementGetClockFunction GstElementSetClockFunction -gst_element_class_add_padtemplate +gst_element_class_add_pad_template gst_element_destroy gst_element_set_loop_function gst_element_set_name @@ -354,8 +354,8 @@ gst_element_get_pad gst_element_get_static_pad gst_element_get_request_pad gst_element_get_pad_list -gst_element_get_padtemplate_list -gst_element_get_padtemplate_by_name +gst_element_get_pad_template_list +gst_element_get_pad_template_by_name gst_element_add_ghost_pad gst_element_remove_ghost_pad gst_element_get_compatible_pad @@ -396,25 +396,25 @@ gst_element_class_install_std_props
-gstelementfactory +gstelement_factory GstElementFactory GstElementDetails -gst_elementfactory_new -gst_elementfactory_find -gst_elementfactory_get_list -gst_elementfactory_add_padtemplate -gst_elementfactory_can_src_caps -gst_elementfactory_can_sink_caps -gst_elementfactory_create -gst_elementfactory_make +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 GstElementFactory -GST_ELEMENTFACTORY -GST_IS_ELEMENTFACTORY -GST_TYPE_ELEMENTFACTORY -gst_elementfactory_get_type -GST_ELEMENTFACTORY_CLASS -GST_IS_ELEMENTFACTORY_CLASS +GST_ELEMENT_FACTORY +GST_IS_ELEMENT_FACTORY +GST_TYPE_ELEMENT_FACTORY +gst_element_factory_get_type +GST_ELEMENT_FACTORY_CLASS +GST_IS_ELEMENT_FACTORY_CLASS
@@ -439,20 +439,20 @@ GST_IS_AUTOPLUG_CLASS gstautoplugfactory GstAutoplugFactory GstAutoplugFactory -gst_autoplugfactory_new -gst_autoplugfactory_destroy -gst_autoplugfactory_find -gst_autoplugfactory_get_list -gst_autoplugfactory_create -gst_autoplugfactory_make +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 -gst_autoplugfactory_get_type +gst_autoplug_factory_get_type GstAutoplugFactoryClass -GST_TYPE_AUTOPLUGFACTORY -GST_AUTOPLUGFACTORY -GST_AUTOPLUGFACTORY_CLASS -GST_IS_AUTOPLUGFACTORY -GST_IS_AUTOPLUGFACTORY_CLASS +GST_TYPE_AUTOPLUG_FACTORY +GST_AUTOPLUG_FACTORY +GST_AUTOPLUG_FACTORY_CLASS +GST_IS_AUTOPLUG_FACTORY +GST_IS_AUTOPLUG_FACTORY_CLASS
@@ -550,7 +550,7 @@ GST_OBJECT_CLASS_CAST GST_PAD_NAME GST_PAD_ELEMENT_PRIVATE GST_PAD_PARENT -GST_PAD_PADTEMPLATE +GST_PAD_PAD_TEMPLATE GST_PAD_REALIZE GST_PAD_DIRECTION GST_PAD_CAPS @@ -616,8 +616,8 @@ gst_pad_pullregion gst_pad_get_bufferpool gst_pad_load_and_connect gst_pad_proxy_connect -gst_pad_get_padtemplate -gst_pad_get_padtemplate_caps +gst_pad_get_pad_template +gst_pad_get_pad_template_caps gst_pad_get_allowed_caps gst_pad_recalc_allowed_caps gst_pad_perform_negotiate @@ -693,32 +693,32 @@ gst_ghost_pad_get_type
gstpadtemplate -GstPadTemplate +GstPAD_TEMPLATE GstPadPresence -GstPadTemplate -GST_PADTEMPLATE_CAPS -GST_PADTEMPLATE_DIRECTION -GST_PADTEMPLATE_NAME_TEMPLATE -GST_PADTEMPLATE_PRESENCE -GST_PADTEMPLATE_NEW -GST_PADTEMPLATE_FACTORY -GST_PADTEMPLATE_GET -GST_PADTEMPLATE_FIXED -GST_PADTEMPLATE_IS_FIXED -gst_padtemplate_new -gst_padtemplate_load_thyself -gst_padtemplate_save_thyself -gst_padtemplate_get_caps -gst_padtemplate_get_caps_by_name +GstPAD_TEMPLATE +GST_PAD_TEMPLATE_CAPS +GST_PAD_TEMPLATE_DIRECTION +GST_PAD_TEMPLATE_NAME_TEMPLATE +GST_PAD_TEMPLATE_PRESENCE +GST_PAD_TEMPLATE_NEW +GST_PAD_TEMPLATE_FACTORY +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 -GstPadTemplateClass -GST_TYPE_PADTEMPLATE -GST_PADTEMPLATE -GST_PADTEMPLATE_CLASS -GST_IS_PADTEMPLATE -GST_IS_PADTEMPLATE_CLASS -gst_padtemplate_get_type +GstPAD_TEMPLATEClass +GST_TYPE_PAD_TEMPLATE +GST_PAD_TEMPLATE +GST_PAD_TEMPLATE_CLASS +GST_IS_PAD_TEMPLATE +GST_IS_PAD_TEMPLATE_CLASS +gst_pad_template_get_type
@@ -854,16 +854,16 @@ gst_type_get_list GstTypeFactory GstTypeDefinition GstTypeFindFunc -gst_typefactory_new -gst_typefactory_find -gst_typefactory_get_list +gst_type_factory_new +gst_type_factory_find +gst_type_factory_get_list -GST_TYPEFACTORY -GST_IS_TYPEFACTORY -GST_TYPE_TYPEFACTORY -gst_typefactory_get_type -GST_TYPEFACTORY_CLASS -GST_IS_TYPEFACTORY_CLASS +GST_TYPE_FACTORY +GST_IS_TYPE_FACTORY +GST_TYPE_TYPE_FACTORY +gst_type_factory_get_type +GST_TYPE_FACTORY_CLASS +GST_IS_TYPE_FACTORY_CLASS
@@ -1030,23 +1030,23 @@ gst_cpu_get_flags GstTimeCacheEntry GstTimeCacheGroup GstTimeCacheCertainty -gst_timecache_new -gst_timecache_get_group -gst_timecache_new_group -gst_timecache_set_group -gst_timecache_set_certainty -gst_timecache_get_certainty -gst_timecache_add_entry -gst_timecache_find_location -gst_timecache_find_timestamp +gst_time_cache_new +gst_time_cache_get_group +gst_time_cache_new_group +gst_time_cache_set_group +gst_time_cache_set_certainty +gst_time_cache_get_certainty +gst_time_cache_add_entry +gst_time_cache_find_location +gst_time_cache_find_timestamp GstTimeCache -GST_TIMECACHE -GST_IS_TIMECACHE -GST_TYPE_TIMECACHE -gst_timecache_get_type -GST_TIMECACHE_CLASS -GST_IS_TIMECACHE_CLASS +GST_TIME_CACHE +GST_IS_TIME_CACHE +GST_TYPE_TIME_CACHE +gst_time_cache_get_type +GST_TIME_CACHE_CLASS +GST_IS_TIME_CACHE_CLASS
diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index af82122ee6..a1f63ca419 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -223,15 +223,6 @@ Check if the GstCaps has fixed properties, ie. it has no ranges or lists. @Returns: - - - - - -@caps: -@Returns: - - diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 40e586cfc0..98f3f44ad7 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -414,16 +414,6 @@ instead. @Returns: - - - - - -@element: -@name: -@Returns: - - diff --git a/docs/gst/tmpl/gstelementfactory.sgml b/docs/gst/tmpl/gstelementfactory.sgml index 7115f4c6ae..f2230863db 100644 --- a/docs/gst/tmpl/gstelementfactory.sgml +++ b/docs/gst/tmpl/gstelementfactory.sgml @@ -67,83 +67,3 @@ describes the element, mostly for the benefit of editors. @author: @copyright: - - - - - -@name: -@type: -@details: -@Returns: - - - - - - - -@name: -@Returns: - - - - - - - -@Returns: - - - - - - - -@elementfactory: -@templ: - -@temp: -@pad: - - - - - - - -@factory: -@caps: -@Returns: - - - - - - - -@factory: -@caps: -@Returns: - - - - - - - -@factory: -@name: -@Returns: - - - - - - - -@factoryname: -@name: -@Returns: - - diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 97a332216f..c3bce94650 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -789,7 +789,6 @@ Destroy the pad. @sched_private: @peer: @bufpen: -@regiontype: @offset: @len: @chainfunc: diff --git a/docs/gst/tmpl/gstpadtemplate.sgml b/docs/gst/tmpl/gstpadtemplate.sgml index 0a8b9e3d56..e7eb2fac96 100644 --- a/docs/gst/tmpl/gstpadtemplate.sgml +++ b/docs/gst/tmpl/gstpadtemplate.sgml @@ -81,12 +81,6 @@ 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 diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 62ea66ce74..507a0e8190 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -219,6 +219,66 @@ 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 + + @@ -3599,6 +3659,12 @@ The function that will be called when a QoS message is sent. @pad: the pad that sent the QoS message @qos_message: the message + + + + + + @@ -5144,6 +5210,14 @@ must be defined to activate the tracing functionality. @buffer: @meta: + + + + + +@caps: +@Returns: + @@ -5302,6 +5376,80 @@ must be defined to activate the tracing functionality. @src: @dest: + + + + + +@elementfactory: +@id: + + + + + + +@elementfactory: +@id: + + + + + + +@factory: +@caps: +@Returns: + + + + + + +@factory: +@caps: +@Returns: + + + + + + +@elementfactory: + + + + + + +@parent: +@Returns: + + + + + + +@elementfactory: + + + + + + +@factory: +@parent: +@Returns: + + + + + + +@element: +@name: +@Returns: + @@ -5413,71 +5561,6 @@ must be defined to activate the tracing functionality. @element: - - - - - -@elementfactory: -@id: - - - - - - -@elementfactory: -@id: - - - - - - -@factory: -@caps: -@Returns: - - - - - - -@factory: -@caps: -@Returns: - - - - - - -@elementfactory: - - - - - - -@parent: -@Returns: - - - - - - -@elementfactory: - - - - - - -@factory: -@parent: -@Returns: - @@ -5977,15 +6060,6 @@ Call the EOS function of the pad @pad: @id: - - - - - -@srcpad: -@sinkpad: -@Returns: - @@ -5997,6 +6071,15 @@ Call the EOS function of the pad @caps: @Returns: + + + + + +@srcpad: +@sinkpad: +@Returns: + @@ -6525,6 +6608,23 @@ Call the EOS function of the pad + + + + + +@parent: +@Returns: + + + + + + +@factory: +@parent: +@Returns: + @@ -6573,23 +6673,6 @@ Call the EOS function of the pad @parent: @Returns: - - - - - -@parent: -@Returns: - - - - - - -@factory: -@parent: -@Returns: -