mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-06-08 17:19:25 +00:00
Code Issues 1 Projects Releases Wiki Activity

doc fixes to match API

Browse source 
Original commit message from CVS:
doc fixes to match API
This commit is contained in:
Thomas Vander Stichele 2002-04-12 16:22:32 +00:00
parent 87ad51d894
commit 6a37dda6d6
8 changed files with 269 additions and 292 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
common

@ -1 +1 @@
Subproject commit 52a8d4bd490c495f1e71725644535dbf2cf209c7 Subproject commit 22ee9f59590241153f1b162344d760c303b1305a

188
docs/gst/gstreamer-sections.txt
View file

@ -137,21 +137,21 @@ GST_IS_SCHEDULER_CLASS
<SECTION> <SECTION>
<FILE>gstschedulerfactory</FILE> <FILE>gstschedulerfactory</FILE>
<TITLE>GstSchedulerFactory</TITLE> <TITLE>GstSchedulerFactory</TITLE>
gst_schedulerfactory_create gst_scheduler_factory_create
gst_schedulerfactory_destroy gst_scheduler_factory_destroy
gst_schedulerfactory_find gst_scheduler_factory_find
gst_schedulerfactory_get_list gst_scheduler_factory_get_list
gst_schedulerfactory_make gst_scheduler_factory_make
gst_schedulerfactory_new gst_scheduler_factory_new
gst_schedulerfactory_get_default_name gst_scheduler_factory_get_default_name
gst_schedulerfactory_set_default_name gst_scheduler_factory_set_default_name
<SUBSECTION Standard> <SUBSECTION Standard>
gst_schedulerfactory_get_type gst_scheduler_factory_get_type
GST_IS_SCHEDULERFACTORY GST_IS_SCHEDULER_FACTORY
GST_IS_SCHEDULERFACTORY_CLASS GST_IS_SCHEDULER_FACTORY_CLASS
GST_SCHEDULERFACTORY GST_SCHEDULER_FACTORY
GST_SCHEDULERFACTORY_CLASS GST_SCHEDULER_FACTORY_CLASS
GST_TYPE_SCHEDULERFACTORY GST_TYPE_SCHEDULER_FACTORY
GstSchedulerFactory GstSchedulerFactory
GstSchedulerFactoryClass GstSchedulerFactoryClass
</SECTION> </SECTION>
@ -338,7 +338,7 @@ GstElement
GstElementLoopFunction GstElementLoopFunction
GstElementGetClockFunction GstElementGetClockFunction
GstElementSetClockFunction GstElementSetClockFunction
gst_element_class_add_padtemplate gst_element_class_add_pad_template
gst_element_destroy gst_element_destroy
gst_element_set_loop_function gst_element_set_loop_function
gst_element_set_name gst_element_set_name
@ -354,8 +354,8 @@ gst_element_get_pad
gst_element_get_static_pad gst_element_get_static_pad
gst_element_get_request_pad gst_element_get_request_pad
gst_element_get_pad_list gst_element_get_pad_list
gst_element_get_padtemplate_list gst_element_get_pad_template_list
gst_element_get_padtemplate_by_name gst_element_get_pad_template_by_name
gst_element_add_ghost_pad gst_element_add_ghost_pad
gst_element_remove_ghost_pad gst_element_remove_ghost_pad
gst_element_get_compatible_pad gst_element_get_compatible_pad
@ -396,25 +396,25 @@ gst_element_class_install_std_props
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstelementfactory</FILE> <FILE>gstelement_factory</FILE>
<TITLE>GstElementFactory</TITLE> <TITLE>GstElementFactory</TITLE>
GstElementDetails GstElementDetails
gst_elementfactory_new gst_element_factory_new
gst_elementfactory_find gst_element_factory_find
gst_elementfactory_get_list gst_element_factory_get_list
gst_elementfactory_add_padtemplate gst_element_factory_add_pad_template
gst_elementfactory_can_src_caps gst_element_factory_can_src_caps
gst_elementfactory_can_sink_caps gst_element_factory_can_sink_caps
gst_elementfactory_create gst_element_factory_create
gst_elementfactory_make gst_element_factory_make
<SUBSECTION Standard> <SUBSECTION Standard>
GstElementFactory GstElementFactory
GST_ELEMENTFACTORY GST_ELEMENT_FACTORY
GST_IS_ELEMENTFACTORY GST_IS_ELEMENT_FACTORY
GST_TYPE_ELEMENTFACTORY GST_TYPE_ELEMENT_FACTORY
gst_elementfactory_get_type gst_element_factory_get_type
GST_ELEMENTFACTORY_CLASS GST_ELEMENT_FACTORY_CLASS
GST_IS_ELEMENTFACTORY_CLASS GST_IS_ELEMENT_FACTORY_CLASS
</SECTION> </SECTION>
@ -439,20 +439,20 @@ GST_IS_AUTOPLUG_CLASS
<FILE>gstautoplugfactory</FILE> <FILE>gstautoplugfactory</FILE>
<TITLE>GstAutoplugFactory</TITLE> <TITLE>GstAutoplugFactory</TITLE>
GstAutoplugFactory GstAutoplugFactory
gst_autoplugfactory_new gst_autoplug_factory_new
gst_autoplugfactory_destroy gst_autoplug_factory_destroy
gst_autoplugfactory_find gst_autoplug_factory_find
gst_autoplugfactory_get_list gst_autoplug_factory_get_list
gst_autoplugfactory_create gst_autoplug_factory_create
gst_autoplugfactory_make gst_autoplug_factory_make
<SUBSECTION Standard> <SUBSECTION Standard>
gst_autoplugfactory_get_type gst_autoplug_factory_get_type
GstAutoplugFactoryClass GstAutoplugFactoryClass
GST_TYPE_AUTOPLUGFACTORY GST_TYPE_AUTOPLUG_FACTORY
GST_AUTOPLUGFACTORY GST_AUTOPLUG_FACTORY
GST_AUTOPLUGFACTORY_CLASS GST_AUTOPLUG_FACTORY_CLASS
GST_IS_AUTOPLUGFACTORY GST_IS_AUTOPLUG_FACTORY
GST_IS_AUTOPLUGFACTORY_CLASS GST_IS_AUTOPLUG_FACTORY_CLASS
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -550,7 +550,7 @@ GST_OBJECT_CLASS_CAST
GST_PAD_NAME GST_PAD_NAME
GST_PAD_ELEMENT_PRIVATE GST_PAD_ELEMENT_PRIVATE
GST_PAD_PARENT GST_PAD_PARENT
GST_PAD_PADTEMPLATE GST_PAD_PAD_TEMPLATE
GST_PAD_REALIZE GST_PAD_REALIZE
GST_PAD_DIRECTION GST_PAD_DIRECTION
GST_PAD_CAPS GST_PAD_CAPS
@ -616,8 +616,8 @@ gst_pad_pullregion
gst_pad_get_bufferpool gst_pad_get_bufferpool
gst_pad_load_and_connect gst_pad_load_and_connect
gst_pad_proxy_connect gst_pad_proxy_connect
gst_pad_get_padtemplate gst_pad_get_pad_template
gst_pad_get_padtemplate_caps gst_pad_get_pad_template_caps
gst_pad_get_allowed_caps gst_pad_get_allowed_caps
gst_pad_recalc_allowed_caps gst_pad_recalc_allowed_caps
gst_pad_perform_negotiate gst_pad_perform_negotiate
@ -693,32 +693,32 @@ gst_ghost_pad_get_type
<SECTION> <SECTION>
<FILE>gstpadtemplate</FILE> <FILE>gstpadtemplate</FILE>
<TITLE>GstPadTemplate</TITLE> <TITLE>GstPAD_TEMPLATE</TITLE>
GstPadPresence GstPadPresence
GstPadTemplate GstPAD_TEMPLATE
GST_PADTEMPLATE_CAPS GST_PAD_TEMPLATE_CAPS
GST_PADTEMPLATE_DIRECTION GST_PAD_TEMPLATE_DIRECTION
GST_PADTEMPLATE_NAME_TEMPLATE GST_PAD_TEMPLATE_NAME_TEMPLATE
GST_PADTEMPLATE_PRESENCE GST_PAD_TEMPLATE_PRESENCE
GST_PADTEMPLATE_NEW GST_PAD_TEMPLATE_NEW
GST_PADTEMPLATE_FACTORY GST_PAD_TEMPLATE_FACTORY
GST_PADTEMPLATE_GET GST_PAD_TEMPLATE_GET
GST_PADTEMPLATE_FIXED GST_PAD_TEMPLATE_FIXED
GST_PADTEMPLATE_IS_FIXED GST_PAD_TEMPLATE_IS_FIXED
gst_padtemplate_new gst_pad_template_new
gst_padtemplate_load_thyself gst_pad_template_load_thyself
gst_padtemplate_save_thyself gst_pad_template_save_thyself
gst_padtemplate_get_caps gst_pad_template_get_caps
gst_padtemplate_get_caps_by_name gst_pad_template_get_caps_by_name
<SUBSECTION Standard> <SUBSECTION Standard>
GstPadTemplateClass GstPAD_TEMPLATEClass
GST_TYPE_PADTEMPLATE GST_TYPE_PAD_TEMPLATE
GST_PADTEMPLATE GST_PAD_TEMPLATE
GST_PADTEMPLATE_CLASS GST_PAD_TEMPLATE_CLASS
GST_IS_PADTEMPLATE GST_IS_PAD_TEMPLATE
GST_IS_PADTEMPLATE_CLASS GST_IS_PAD_TEMPLATE_CLASS
gst_padtemplate_get_type gst_pad_template_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -854,16 +854,16 @@ gst_type_get_list
GstTypeFactory GstTypeFactory
GstTypeDefinition GstTypeDefinition
GstTypeFindFunc GstTypeFindFunc
gst_typefactory_new gst_type_factory_new
gst_typefactory_find gst_type_factory_find
gst_typefactory_get_list gst_type_factory_get_list
<SUBSECTION Standard> <SUBSECTION Standard>
GST_TYPEFACTORY GST_TYPE_FACTORY
GST_IS_TYPEFACTORY GST_IS_TYPE_FACTORY
GST_TYPE_TYPEFACTORY GST_TYPE_TYPE_FACTORY
gst_typefactory_get_type gst_type_factory_get_type
GST_TYPEFACTORY_CLASS GST_TYPE_FACTORY_CLASS
GST_IS_TYPEFACTORY_CLASS GST_IS_TYPE_FACTORY_CLASS
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -1030,23 +1030,23 @@ gst_cpu_get_flags
GstTimeCacheEntry GstTimeCacheEntry
GstTimeCacheGroup GstTimeCacheGroup
GstTimeCacheCertainty GstTimeCacheCertainty
gst_timecache_new gst_time_cache_new
gst_timecache_get_group gst_time_cache_get_group
gst_timecache_new_group gst_time_cache_new_group
gst_timecache_set_group gst_time_cache_set_group
gst_timecache_set_certainty gst_time_cache_set_certainty
gst_timecache_get_certainty gst_time_cache_get_certainty
gst_timecache_add_entry gst_time_cache_add_entry
gst_timecache_find_location gst_time_cache_find_location
gst_timecache_find_timestamp gst_time_cache_find_timestamp
<SUBSECTION Standard> <SUBSECTION Standard>
GstTimeCache GstTimeCache
GST_TIMECACHE GST_TIME_CACHE
GST_IS_TIMECACHE GST_IS_TIME_CACHE
GST_TYPE_TIMECACHE GST_TYPE_TIME_CACHE
gst_timecache_get_type gst_time_cache_get_type
GST_TIMECACHE_CLASS GST_TIME_CACHE_CLASS
GST_IS_TIMECACHE_CLASS GST_IS_TIME_CACHE_CLASS
</SECTION> </SECTION>
<SECTION> <SECTION>

9
docs/gst/tmpl/gstcaps.sgml
View file

@ -223,15 +223,6 @@ Check if the GstCaps has fixed properties, ie. it has no ranges or lists.
@Returns: @Returns:
<!-- ##### FUNCTION gst_caps_copy_1 ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_copy_on_write ##### --> <!-- ##### FUNCTION gst_caps_copy_on_write ##### -->
<para> <para>

10
docs/gst/tmpl/gstelement.sgml
View file

@ -414,16 +414,6 @@ instead.
@Returns: @Returns:
<!-- ##### FUNCTION gst_element_get_pad_template_by_name ##### -->
<para>
</para>
@element:
@name:
@Returns:
<!-- ##### FUNCTION gst_element_add_ghost_pad ##### --> <!-- ##### FUNCTION gst_element_add_ghost_pad ##### -->
<para> <para>

80
docs/gst/tmpl/gstelementfactory.sgml
View file

@ -67,83 +67,3 @@ describes the element, mostly for the benefit of editors.
@author: @author:
@copyright: @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_get_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_element_factory_add_pad_template ##### -->
<para>
</para>
@elementfactory:
@templ:
<!-- # Unused Parameters # -->
@temp:
@pad:
<!-- ##### 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:

1
docs/gst/tmpl/gstpad.sgml
View file

@ -789,7 +789,6 @@ Destroy the pad.
@sched_private: @sched_private:
@peer: @peer:
@bufpen: @bufpen:
@regiontype:
@offset: @offset:
@len: @len:
@chainfunc: @chainfunc:

6
docs/gst/tmpl/gstpadtemplate.sgml
View file

@ -81,12 +81,6 @@ Indicates when this pad will become available.
@GST_PAD_REQUEST: th pad is only available on request with @GST_PAD_REQUEST: th pad is only available on request with
gst_element_request_pad_by_name() or gst_element_request_compatible_pad(). gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
<!-- ##### STRUCT GstPadTemplate ##### -->
<para>
</para>
<!-- ##### MACRO GST_PAD_TEMPLATE_CAPS ##### --> <!-- ##### MACRO GST_PAD_TEMPLATE_CAPS ##### -->
<para> <para>
Get a handle to the padtemplate #GstCaps Get a handle to the padtemplate #GstCaps

265
docs/gst/tmpl/gstreamer-unused.sgml
View file

@ -219,6 +219,66 @@ Asynchronous read from a file (disksrc)
GstDiskSrc GstDiskSrc
<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:Long_Description ##### -->
<para>
GstElementFactory is used to create instances of elements. A GstElementfactory
can be added to a #GstPlugin as it is also a #GstPluginFeature.
</para>
<para>
Use gst_element_factory_new() to create a new factory which can be added to a plugin
with gst_plugin_add_feature().
</para>
<para>
gst_element_factory_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 ##### -->
<para>
#GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
</para>
<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:Short_Description ##### -->
Create GstElements from a factory
<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:Title ##### -->
GstElementFactory
<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Long_Description ##### --> <!-- ##### SECTION ./tmpl/gstesdsink.sgml:Long_Description ##### -->
<para> <para>
@ -3599,6 +3659,12 @@ The function that will be called when a QoS message is sent.
@pad: the pad that sent the QoS message @pad: the pad that sent the QoS message
@qos_message: the message @qos_message: the message
<!-- ##### STRUCT GstPadTemplate ##### -->
<para>
</para>
<!-- ##### ENUM GstParseErrors ##### --> <!-- ##### ENUM GstParseErrors ##### -->
<para> <para>
@ -5144,6 +5210,14 @@ must be defined to activate the tracing functionality.
@buffer: @buffer:
@meta: @meta:
<!-- ##### FUNCTION gst_caps_copy_1 ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_list_check_compatibility ##### --> <!-- ##### FUNCTION gst_caps_list_check_compatibility ##### -->
<para> <para>
@ -5302,6 +5376,80 @@ must be defined to activate the tracing functionality.
@src: @src:
@dest: @dest:
<!-- ##### FUNCTION gst_element_factory_add_sink ##### -->
<para>
</para>
@elementfactory:
@id:
<!-- ##### FUNCTION gst_element_factory_add_src ##### -->
<para>
</para>
@elementfactory:
@id:
<!-- ##### FUNCTION gst_element_factory_can_sink_caps_list ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### FUNCTION gst_element_factory_can_src_caps_list ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### FUNCTION gst_element_factory_destroy ##### -->
<para>
</para>
@elementfactory:
<!-- ##### FUNCTION gst_element_factory_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_element_factory_register ##### -->
<para>
</para>
@elementfactory:
<!-- ##### FUNCTION gst_element_factory_save_thyself ##### -->
<para>
</para>
@factory:
@parent:
@Returns:
<!-- ##### FUNCTION gst_element_get_pad_template_by_name ##### -->
<para>
</para>
@element:
@name:
@Returns:
<!-- ##### FUNCTION gst_element_get_type ##### --> <!-- ##### FUNCTION gst_element_get_type ##### -->
<para> <para>
@ -5413,71 +5561,6 @@ must be defined to activate the tracing functionality.
@element: @element:
<!-- ##### FUNCTION gst_element_factory_add_sink ##### -->
<para>
</para>
@elementfactory:
@id:
<!-- ##### FUNCTION gst_element_factory_add_src ##### -->
<para>
</para>
@elementfactory:
@id:
<!-- ##### FUNCTION gst_element_factory_can_sink_caps_list ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### FUNCTION gst_element_factory_can_src_caps_list ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### FUNCTION gst_element_factory_destroy ##### -->
<para>
</para>
@elementfactory:
<!-- ##### FUNCTION gst_element_factory_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_element_factory_register ##### -->
<para>
</para>
@elementfactory:
<!-- ##### FUNCTION gst_element_factory_save_thyself ##### -->
<para>
</para>
@factory:
@parent:
@Returns:
<!-- ##### FUNCTION gst_esdsink_chain ##### --> <!-- ##### FUNCTION gst_esdsink_chain ##### -->
<para> <para>
@ -5977,15 +6060,6 @@ Call the EOS function of the pad
@pad: @pad:
@id: @id:
<!-- ##### FUNCTION gst_pad_try_connect ##### -->
<para>
</para>
@srcpad:
@sinkpad:
@Returns:
<!-- ##### FUNCTION gst_pad_template_create ##### --> <!-- ##### FUNCTION gst_pad_template_create ##### -->
<para> <para>
@ -5997,6 +6071,15 @@ Call the EOS function of the pad
@caps: @caps:
@Returns: @Returns:
<!-- ##### FUNCTION gst_pad_try_connect ##### -->
<para>
</para>
@srcpad:
@sinkpad:
@Returns:
<!-- ##### FUNCTION gst_pipeline_get_type ##### --> <!-- ##### FUNCTION gst_pipeline_get_type ##### -->
<para> <para>
@ -6525,6 +6608,23 @@ Call the EOS function of the pad
</para> </para>
<!-- ##### FUNCTION gst_type_factory_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_type_factory_save_thyself ##### -->
<para>
</para>
@factory:
@parent:
@Returns:
<!-- ##### FUNCTION gst_type_get_sink_to_src ##### --> <!-- ##### FUNCTION gst_type_get_sink_to_src ##### -->
<para> <para>
@ -6573,23 +6673,6 @@ Call the EOS function of the pad
@parent: @parent:
@Returns: @Returns:
<!-- ##### FUNCTION gst_type_factory_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_type_factory_save_thyself ##### -->
<para>
</para>
@factory:
@parent:
@Returns:
<!-- ##### FUNCTION gst_util_get_widget_arg ##### --> <!-- ##### FUNCTION gst_util_get_widget_arg ##### -->
<para> <para>