mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-30 05:31:15 +00:00
Code Issues 1 Projects Releases Wiki Activity

splitted documentation page for gstelement into three pages (more to come)

Browse source 
Original commit message from CVS:
splitted documentation page for gstelement into three pages (more to come)
This commit is contained in:
Stefan Kost 2004-07-23 15:38:47 +00:00
parent 13905b113e
commit faf9cf5242
5 changed files with 272 additions and 201 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/gst/gstreamer-docs.sgml
View file

@ -13,6 +13,8 @@
<!ENTITY GstCpu SYSTEM "xml/gstcpu.xml">
<!ENTITY GstData SYSTEM "xml/gstdata.xml">
<!ENTITY GstElement SYSTEM "xml/gstelement.xml">
<!ENTITY GstElementDetails SYSTEM "xml/gstelementdetails.xml">
<!ENTITY GstElementFactory SYSTEM "xml/gstelementfactory.xml">
<!ENTITY GstError SYSTEM "xml/gsterror.xml">
<!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
<!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
@ -86,6 +88,8 @@
&GstCpu;
&GstData;
&GstElement;
&GstElementDetails;
&GstElementFactory;
&GstError;
&GstEvent;
&GstFormat;

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

@ -268,11 +268,9 @@ gst_data_get_type
<SECTION>
<FILE>gstelement</FILE>
<TITLE>GstElement</TITLE>
GstElement
GST_TYPE_ELEMENT
GstElementDetails
GST_ELEMENT_DETAILS
GST_IS_ELEMENT_DETAILS
GST_NUM_STATES
GST_STATE
GST_STATE_PENDING
@ -299,7 +297,6 @@ GST_ELEMENT_ERROR
GstElementLoopFunction
GstElementPreRunFunction
GstElementPostRunFunction
<TITLE>GstElement</TITLE>
gst_element_class_add_pad_template
gst_element_class_install_std_props
gst_element_class_set_details
@ -382,7 +379,31 @@ gst_element_state_get_name
gst_element_get_factory
gst_element_get_managing_bin
gst_element_no_more_pads
<SUBSECTION Standard>
GstElementClass
GST_ELEMENT
GST_IS_ELEMENT
GST_ELEMENT_CLASS
GST_IS_ELEMENT_CLASS
GST_ELEMENT_GET_CLASS
<SUBSECTION Private>
gst_element_get_type
</SECTION>
<SECTION>
<FILE>gstelementdetails</FILE>
<TITLE>GstElementDetails</TITLE>
GstElementDetails
<SUBSECTION Standard>
GST_ELEMENT_DETAILS
GST_IS_ELEMENT_DETAILS
</SECTION>
<SECTION>
<FILE>gstelementfactory</FILE>
<TITLE>GstElementFactory</TITLE>
GST_TYPE_ELEMENT_FACTORY
GstElementFactory
gst_element_register
gst_element_factory_find
gst_element_factory_get_element_type
@ -398,22 +419,13 @@ gst_element_factory_create
gst_element_factory_make
gst_element_factory_can_src_caps
gst_element_factory_can_sink_caps
GstElementFactory
GST_TYPE_ELEMENT_FACTORY
<SUBSECTION Standard>
GstElementClass
GST_ELEMENT
GST_IS_ELEMENT
GST_ELEMENT_CLASS
GST_IS_ELEMENT_CLASS
GST_ELEMENT_GET_CLASS
GstElementFactoryClass
GST_ELEMENT_FACTORY
GST_IS_ELEMENT_FACTORY
GST_ELEMENT_FACTORY_CLASS
GST_IS_ELEMENT_FACTORY_CLASS
<SUBSECTION Private>
gst_element_get_type
gst_element_factory_get_type
</SECTION>

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

@ -159,37 +159,6 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
<!-- ##### STRUCT GstElementDetails ##### -->
<para>
This struct is used to define public information about the element. It
describes the element, mostly for the benefit of editors.
</para>
@longname:
@klass:
@description:
@author:
@_gst_reserved:
<!-- ##### MACRO GST_ELEMENT_DETAILS ##### -->
<para>
</para>
@longname:
@klass:
@description:
@author:
<!-- ##### MACRO GST_IS_ELEMENT_DETAILS ##### -->
<para>
</para>
@details:
<!-- ##### MACRO GST_NUM_STATES ##### -->
<para>
The maximun number of states.
@ -1218,160 +1187,3 @@ Sets the parent of an element.
@element:
<!-- ##### FUNCTION gst_element_register ##### -->
<para>
</para>
@plugin:
@name:
@rank:
@type:
@Returns:
<!-- # Unused Parameters # -->
@elementname:
<!-- ##### FUNCTION gst_element_factory_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_element_type ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_longname ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_klass ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_description ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_author ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_num_pad_templates ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_pad_templates ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_uri_type ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_uri_protocols ##### -->
<para>
</para>
@factory:
@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_can_src_caps ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### FUNCTION gst_element_factory_can_sink_caps ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### STRUCT GstElementFactory ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_ELEMENT_FACTORY ##### -->
<para>
</para>

30
docs/gst/tmpl/gstelementdetails.sgml Normal file
View file

@ -0,0 +1,30 @@
<!-- ##### SECTION Title ##### -->
GstElementDetails
<!-- ##### SECTION Short_Description ##### -->
Defines public information about a #GstElement
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstElementDetails ##### -->
<para>
This struct is used to define public information about the element. It
describes the element, mostly for the benefit of editors.
</para>
@longname:
@klass:
@description:
@author:
@_gst_reserved:

213
docs/gst/tmpl/gstelementfactory.sgml Normal file
View file

@ -0,0 +1,213 @@
<!-- ##### SECTION Title ##### -->
GstElementFactory
<!-- ##### SECTION Short_Description ##### -->
Create GstElements from a factory
<!-- ##### SECTION 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_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 GstFileSrc 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>
<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>
#GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
</para>
<!-- ##### MACRO GST_TYPE_ELEMENT_FACTORY ##### -->
<para>
</para>
<!-- ##### STRUCT GstElementFactory ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_element_register ##### -->
<para>
</para>
@plugin:
@name:
@rank:
@type:
@Returns:
<!-- # Unused Parameters # -->
@elementname:
<!-- ##### FUNCTION gst_element_factory_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_element_type ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_longname ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_klass ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_description ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_author ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_num_pad_templates ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_pad_templates ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_uri_type ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_element_factory_get_uri_protocols ##### -->
<para>
</para>
@factory:
@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_can_src_caps ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### FUNCTION gst_element_factory_can_sink_caps ##### -->
<para>
</para>
@factory:
@caps:
@Returns: