mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-09 08:55:33 +00:00
Code Issues 1 Projects Releases Wiki Activity

fixed all double <TITLE> elements in sections.txt added missing <TITLE> elements in sections.txt

Browse source 
Original commit message from CVS:
fixed all double <TITLE> elements in sections.txt
added missing <TITLE> elements in sections.txt
This commit is contained in:
Stefan Kost 2004-07-26 16:34:35 +00:00
parent cb9b415aa5
commit e4c86da4f5
23 changed files with 1656 additions and 2572 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/README
View file

@ -114,17 +114,20 @@ GTK-DOC NOTES
* what to do when adding a new piece of API:
- add both an entity and use the entity in gstreamer-docs.sgml
- add a new section to gstreamer-sections.txt
- add a new <SECTION> to gstreamer-sections.txt in the correct alphabetical
position related to the other sections (so that it is easier to locate)
- add all documented symbols to gstreamer-sections.txt in the proper section
(default),<SUBSECTION Standard>,<SUBSECTION Private>
- document at least the Short_Description in tmpl/.sgml
- signals: document them properly in tmpl/.sgml (or better in the c-source)
* checklist:
- make sure -sections.txt has a <TITLE> set for each <FILE>
- the title should be named like the type, when it gets registered
(otherwise gtkdoc introspection fails)
- for clarity name the file like the title, but all lowercase
- make sure *-sections.txt has a <TITLE> set for each <FILE>
- add only *one* <TITLE> to each file, when you have multiple classes in one
source-file, create one <FILE> section for each class
- the <TITLE> *must* be named like the type of the GType, when it gets
registered (otherwise gtkdoc introspection fails)
- for clarity name the <FILE> like the <TITLE>, but all lowercase
* what to do when trying to improve the docs
- compare the output of

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

@ -18,31 +18,37 @@
<!ENTITY GstError SYSTEM "xml/gsterror.xml">
<!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
<!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
<!ENTITY GstGhostPad SYSTEM "xml/gstghostpad.xml">
<!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
<!ENTITY GstIndexFactory SYSTEM "xml/gstindexfactory.xml">
<!ENTITY GstImplementsInterface SYSTEM "xml/gstimplementsinterface.xml">
<!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
<!ENTITY GstLog SYSTEM "xml/gstlog.xml">
<!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml">
<!ENTITY GstObject SYSTEM "xml/gstobject.xml">
<!ENTITY GstPad SYSTEM "xml/gstpad.xml">
<!ENTITY GstPadTemplate SYSTEM "xml/gstpadtemplate.xml">
<!ENTITY GstParse SYSTEM "xml/gstparse.xml">
<!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
<!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
<!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
<!ENTITY GstProbe SYSTEM "xml/gstprobe.xml">
<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
<!ENTITY GstRealPad SYSTEM "xml/gstrealpad.xml">
<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
<!ENTITY GstRegistryPool SYSTEM "xml/gstregistrypool.xml">
<!ENTITY GstScheduler SYSTEM "xml/gstscheduler.xml">
<!ENTITY GstSchedulerFactory SYSTEM "xml/gstschedulerfactory.xml">
<!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
<!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
<!ENTITY GstTag SYSTEM "xml/gsttag.xml">
<!ENTITY GstTagList SYSTEM "xml/gsttaglist.xml">
<!ENTITY GstTagSetter SYSTEM "xml/gsttagsetter.xml">
<!ENTITY GstThread SYSTEM "xml/gstthread.xml">
<!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
<!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
<!ENTITY GstTypeFindFactory SYSTEM "xml/gsttypefindfactory.xml">
<!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
<!ENTITY GstUri SYSTEM "xml/gsturi.xml">
<!ENTITY GstUriHandler SYSTEM "xml/gsturihandler.xml">
<!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
@ -66,7 +72,8 @@
]>
<book>
<bookinfo>
<title>GStreamer &GST_MAJORMINOR; Core API Reference (&GST_VERSION;)</title>
<title>GStreamer &GST_MAJORMINOR; Core API Reference</title>
<releaseinfo>for GStreamer Core &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
</bookinfo>
<chapter id="gstreamer">
@ -93,11 +100,14 @@
&GstError;
&GstEvent;
&GstFormat;
&GstGhostPad;
&GstIndex;
&GstIndexFactory;
&GstInfo;
&GstImplementsInterface;
&GstObject;
&GstPad;
&GstPadTemplate;
&GstParse;
&GstPipeline;
&GstPlugin;
@ -105,16 +115,19 @@
&GstProbe;
&GstQuery;
&GstQueue;
&GstRealPad;
&GstRegistry;
&GstRegistryPool;
&GstScheduler;
&GstSchedulerFactory;
&GstStructure;
&GstSystemClock;
&GstTag;
&GstTagList;
&GstTagSetter;
&GstThread;
&GstTypeFind;
&GstUri;
&GstTypeFindFactory;
&GstUriHandler;
&GstUtils;
&GstValue;
&GstXML;

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

File diff suppressed because it is too large Load diff

2
docs/gst/tmpl/gstconfig.sgml
View file

@ -128,9 +128,11 @@ Under Windows it permits to export variables from a DLL, otherwise it just means
</para>
<!-- ##### MACRO GST_PLUGIN_EXPORT ##### -->
<para>
Under Windows it permits to automatically export the plugin definition, otherwise it just defines as nothing.
</para>

2
docs/gst/tmpl/gstelementdetails.sgml
View file

@ -9,13 +9,11 @@ Defines public information about a #GstElement
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstElementDetails ##### -->
<para>
This struct is used to define public information about the element. It

55
docs/gst/tmpl/gstghostpad.sgml Normal file
View file

@ -0,0 +1,55 @@
<!-- ##### SECTION Title ##### -->
GstGhostPad
<!-- ##### SECTION Short_Description ##### -->
Pseudo link pads
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstGhostPad ##### -->
<para>
</para>
<!-- ##### ARG GstGhostPad:real-pad ##### -->
<para>
</para>
<!-- ##### MACRO GST_GPAD_REALPAD ##### -->
<para>
Get the real pad of this ghost pad.
</para>
@pad: the real pad to query.
<!-- ##### FUNCTION gst_ghost_pad_new ##### -->
<para>
</para>
@name:
@pad:
@Returns:
<!-- ##### FUNCTION gst_ghost_pad_save_thyself ##### -->
<para>
</para>
@pad:
@parent:
@Returns:

59
docs/gst/tmpl/gstindex.sgml
View file

@ -438,62 +438,3 @@ Check if the index can be written to
@Returns:
<!-- ##### MACRO GST_TYPE_INDEX_FACTORY ##### -->
<para>
</para>
<!-- ##### STRUCT GstIndexFactory ##### -->
<para>
The GstIndexFactory object
</para>
<!-- ##### FUNCTION gst_index_factory_new ##### -->
<para>
</para>
@name:
@longdesc:
@type:
@Returns:
<!-- ##### FUNCTION gst_index_factory_destroy ##### -->
<para>
</para>
@factory:
<!-- ##### FUNCTION gst_index_factory_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_index_factory_create ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_index_factory_make ##### -->
<para>
</para>
@name:
@Returns:

75
docs/gst/tmpl/gstindexfactory.sgml Normal file
View file

@ -0,0 +1,75 @@
<!-- ##### SECTION Title ##### -->
GstIndexFactory
<!-- ##### SECTION Short_Description ##### -->
Create GstIndexes from a factory
<!-- ##### SECTION Long_Description ##### -->
<para>
GstIndexFactory is used to dynamically create GstIndex implementations.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstIndex
</para>
<!-- ##### MACRO GST_TYPE_INDEX_FACTORY ##### -->
<para>
</para>
<!-- ##### STRUCT GstIndexFactory ##### -->
<para>
The GstIndexFactory object
</para>
<!-- ##### FUNCTION gst_index_factory_new ##### -->
<para>
</para>
@name:
@longdesc:
@type:
@Returns:
<!-- ##### FUNCTION gst_index_factory_destroy ##### -->
<para>
</para>
@factory:
<!-- ##### FUNCTION gst_index_factory_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_index_factory_create ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_index_factory_make ##### -->
<para>
</para>
@name:
@Returns:

12
docs/gst/tmpl/gstinfo.sgml
View file

@ -483,18 +483,6 @@ output with the function name of the message.
@Returns:
<!-- ##### VARIABLE GST_CAT_DEFAULT ##### -->
<para>
The default category that is used when no other category is defined as the
default. If you want to define a default category, do it like this:
<informalexample>
<programlisting>
&hash;define GST_CAT_DEFAULT category_to_be_default
</programlisting>
</informalexample>
</para>
<!-- ##### MACRO GST_CAT_LEVEL_LOG ##### -->
<para>
GST_CAT_LEVEL_LOG:

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

@ -63,93 +63,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
</para>
<!-- ##### STRUCT GstRealPad ##### -->
<para>
</para>
<!-- ##### STRUCT GstGhostPad ##### -->
<para>
</para>
<!-- ##### ARG GstGhostPad:real-pad ##### -->
<para>
</para>
<!-- ##### STRUCT GstPadTemplate ##### -->
<para>
The padtemplate object.
</para>
<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
<para>
This signal is fired when an element creates a pad from this
template.
</para>
@gstpadtemplate: the object which received the signal.
@arg1: The pad that was created.
<!-- ##### MACRO GST_TYPE_PAD ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_REAL_PAD ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_REAL_PAD_FAST ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_TYPE_GHOST_PAD ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_GHOST_PAD_FAST ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_PAD_FAST ##### -->
<para>
</para>
@obj:
<!-- ##### STRUCT GstStaticPadTemplate ##### -->
<para>
</para>
@name_template:
@direction:
@presence:
@static_caps:
<!-- ##### STRUCT GstPadLink ##### -->
<para>
@ -425,198 +338,6 @@ Gets the pad template that was used to create this pad.
used.
<!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
<para>
Get the direction of the real pad.
</para>
@pad: the realpad to query.
<!-- ##### MACRO GST_RPAD_CAPS ##### -->
<para>
Get the caps of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_APPFILTER ##### -->
<para>
Get the application filter for this pad
</para>
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_PEER ##### -->
<para>
Get the peer element of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_CHAINFUNC ##### -->
<para>
Get the chain function of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_CHAINHANDLER ##### -->
<para>
Get the eventhandler function from the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_GETFUNC ##### -->
<para>
Get get getfunction of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_GETHANDLER ##### -->
<para>
Get the gethandler function of this real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_EVENTFUNC ##### -->
<para>
Get the event function of this real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_EVENTHANDLER ##### -->
<para>
Get the eventhandler function of this real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_CONVERTFUNC ##### -->
<para>
Get the convert function of this pad
</para>
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_QUERYFUNC ##### -->
<para>
Get the query function of this pad
</para>
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_INTLINKFUNC ##### -->
<para>
Get the internal link function of this pad
</para>
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_FORMATSFUNC ##### -->
<para>
Get the formats function of this pad
</para>
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_QUERYTYPEFUNC ##### -->
<para>
Get the query types function of this pad
</para>
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_EVENTMASKFUNC ##### -->
<para>
Get the event mask function of this pad
</para>
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_LINKFUNC ##### -->
<para>
Get the link function of the pad
</para>
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_UNLINKFUNC ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_RPAD_GETCAPSFUNC ##### -->
<para>
Get the getcaps function of this pad
</para>
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_FIXATEFUNC ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_RPAD_BUFFERALLOCFUNC ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_RPAD_LINK ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_RPAD_EXPLICIT_CAPS ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_GPAD_REALPAD ##### -->
<para>
Get the real pad of this ghost pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_PAD_REALIZE ##### -->
<para>
Returns the real pad of this pad.
@ -735,65 +456,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().
<!-- ##### MACRO GST_PAD_TEMPLATE_NAME_TEMPLATE ##### -->
<para>
Get the nametemplate of the padtemplate.
</para>
@templ: the template to query
<!-- ##### MACRO GST_PAD_TEMPLATE_DIRECTION ##### -->
<para>
Get the direction of the padtemplate.
</para>
@templ: the template to query
<!-- ##### MACRO GST_PAD_TEMPLATE_PRESENCE ##### -->
<para>
Get the presence of the padtemplate.
</para>
@templ: the template to query
<!-- ##### MACRO GST_PAD_TEMPLATE_CAPS ##### -->
<para>
Get a handle to the padtemplate #GstCaps
</para>
@templ: the template to query
<!-- ##### ENUM GstPadTemplateFlags ##### -->
<para>
Flags for the padtemplate
</para>
@GST_PAD_TEMPLATE_FIXED: The padtemplate has no variable properties
@GST_PAD_TEMPLATE_FLAG_LAST: first flag that can be used by subclasses.
<!-- ##### MACRO GST_PAD_TEMPLATE_IS_FIXED ##### -->
<para>
Check if the properties of the padtemplate are fixed
</para>
@templ: the template to query
<!-- ##### MACRO GST_STATIC_PAD_TEMPLATE ##### -->
<para>
</para>
@padname:
@dir:
@pres:
@caps:
<!-- ##### FUNCTION gst_pad_new ##### -->
<para>
@ -1644,67 +1306,3 @@ Remove the probe from the pad
@parent:
<!-- ##### FUNCTION gst_ghost_pad_new ##### -->
<para>
</para>
@name:
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_template_new ##### -->
<para>
</para>
@name_template:
@direction:
@presence:
@caps:
@Returns:
<!-- # Unused Parameters # -->
@Varargs:
<!-- ##### FUNCTION gst_static_pad_template_get ##### -->
<para>
</para>
@pad_template:
@Returns:
<!-- # Unused Parameters # -->
@templ:
<!-- ##### FUNCTION gst_pad_template_get_caps ##### -->
<para>
</para>
@templ:
@Returns:
<!-- ##### FUNCTION gst_pad_template_get_caps_by_name ##### -->
<para>
</para>
@templ:
@name:
@Returns:
<!-- ##### FUNCTION gst_ghost_pad_save_thyself ##### -->
<para>
</para>
@pad:
@parent:
@Returns:

222
docs/gst/tmpl/gstpadtemplate.sgml Normal file
View file

@ -0,0 +1,222 @@
<!-- ##### SECTION Title ##### -->
GstPadTemplate
<!-- ##### SECTION Short_Description ##### -->
Describe the media type of a pad.
<!-- ##### SECTION Long_Description ##### -->
<para>
Padtemplates describe the possible media types a pad or an elementfactory can
handle.
</para>
<para>
Pad and PadTemplates have #GstCaps attached to it to describe the media type they
are capable of dealing with. gst_pad_template_get_caps() is used to get the
caps of a padtemplate. It's not possible to modify the caps of a padtemplate after
creation.
</para>
<para>
Padtemplates can be created with gst_pad_template_new() or with the convenient
GST_PAD_TEMPLATE_FACTORY() macro. A padtemplate can be used to create a pad or
to add to an elementfactory.
</para>
<para>
The following code example shows the code to create a pad from a padtemplate.
<example>
<title>Create a pad from a padtemplate</title>
<programlisting>
GstStaticPadTemplate my_template =
GST_STATIC_PAD_TEMPLATE (
"sink", /* the name of the pad */
GST_PAD_SINK, /* the direction of the pad */
GST_PAD_ALWAYS, /* when this pad will be present */
GST_STATIC_CAPS ( /* the capabilities of the padtemplate */
"audio/x-raw-int, "
"channels = (int) [ 1, 6 ]"
)
)
void
my_method (void)
{
GstPad *pad;
pad = gst_pad_new_from_template (GST_PAD_TEMPLATE_GET (my_template_factory), "sink");
...
}
</programlisting>
</example>
</para>
<para>
The following example shows you how to add the padtemplate to an elementfactory:
<programlisting>
gboolean
my_factory_init (GstPlugin *plugin)
{
GstElementFactory *factory;
factory = gst_element_factory_new ("my_factory", GST_TYPE_MYFACTORY, &amp;gst_myfactory_details);
g_return_val_if_fail (factory != NULL, FALSE);
gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (my_template_factory));
gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));
return TRUE;
}
</programlisting>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstPad, #GstElementFactory
</para>
<!-- ##### STRUCT GstPadTemplate ##### -->
<para>
The padtemplate object.
</para>
<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
<para>
This signal is fired when an element creates a pad from this
template.
</para>
@gstpadtemplate: the object which received the signal.
@arg1: The pad that was created.
<!-- ##### STRUCT GstStaticPadTemplate ##### -->
<para>
</para>
@name_template:
@direction:
@presence:
@static_caps:
<!-- ##### MACRO GST_TYPE_PAD ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_GHOST_PAD ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_GHOST_PAD_FAST ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_PAD_FAST ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_PAD_TEMPLATE_NAME_TEMPLATE ##### -->
<para>
Get the nametemplate of the padtemplate.
</para>
@templ: the template to query
<!-- ##### MACRO GST_PAD_TEMPLATE_DIRECTION ##### -->
<para>
Get the direction of the padtemplate.
</para>
@templ: the template to query
<!-- ##### MACRO GST_PAD_TEMPLATE_PRESENCE ##### -->
<para>
Get the presence of the padtemplate.
</para>
@templ: the template to query
<!-- ##### MACRO GST_PAD_TEMPLATE_CAPS ##### -->
<para>
Get a handle to the padtemplate #GstCaps
</para>
@templ: the template to query
<!-- ##### MACRO GST_PAD_TEMPLATE_IS_FIXED ##### -->
<para>
Check if the properties of the padtemplate are fixed
</para>
@templ: the template to query
<!-- ##### ENUM GstPadTemplateFlags ##### -->
<para>
Flags for the padtemplate
</para>
@GST_PAD_TEMPLATE_FIXED: The padtemplate has no variable properties
@GST_PAD_TEMPLATE_FLAG_LAST: first flag that can be used by subclasses.
<!-- ##### FUNCTION gst_pad_template_new ##### -->
<para>
</para>
@name_template:
@direction:
@presence:
@caps:
@Returns:
<!-- # Unused Parameters # -->
@Varargs:
<!-- ##### FUNCTION gst_static_pad_template_get ##### -->
<para>
</para>
@pad_template:
@Returns:
<!-- # Unused Parameters # -->
@templ:
<!-- ##### FUNCTION gst_pad_template_get_caps ##### -->
<para>
</para>
@templ:
@Returns:
<!-- ##### FUNCTION gst_pad_template_get_caps_by_name ##### -->
<para>
</para>
@templ:
@name:
@Returns:

16
docs/gst/tmpl/gstrealpad.sgml Normal file
View file

@ -0,0 +1,16 @@
<!-- ##### SECTION Title ##### -->
GstRealPad
<!-- ##### SECTION Short_Description ##### -->
Real link pads
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

77
docs/gst/tmpl/gstscheduler.sgml
View file

@ -272,13 +272,6 @@ The state of the scheduler
@sched:
<!-- ##### MACRO GST_TYPE_SCHEDULER_FACTORY ##### -->
<para>
</para>
<!-- ##### MACRO GST_SCHEDULER_DEFAULT_NAME ##### -->
<para>
@ -286,73 +279,3 @@ The state of the scheduler
<!-- ##### STRUCT GstSchedulerFactory ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_scheduler_factory_new ##### -->
<para>
</para>
@name:
@longdesc:
@type:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_destroy ##### -->
<para>
</para>
@factory:
<!-- ##### FUNCTION gst_scheduler_factory_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_create ##### -->
<para>
</para>
@factory:
@parent:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_make ##### -->
<para>
</para>
@name:
@parent:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_set_default_name ##### -->
<para>
</para>
@name:
<!-- ##### FUNCTION gst_scheduler_factory_get_default_name ##### -->
<para>
</para>
@Returns:

110
docs/gst/tmpl/gstschedulerfactory.sgml Normal file
View file

@ -0,0 +1,110 @@
<!-- ##### SECTION Title ##### -->
GstSchedulerFactory
<!-- ##### SECTION Short_Description ##### -->
Create schedulers from a factory
<!-- ##### SECTION Long_Description ##### -->
<para>
A schedulerfactory is used to create instances of a scheduler. It
can be added to a #GstPlugin as it extends #GstPluginFeature.
</para>
<para>
Use gst_scheduler_factory_new() to create a new scheduler which can be registered
to a plugin with gst_plugin_add_feature().
</para>
<para>
Use gst_scheduler_factory_find() to find the named schedulerfactory.
or use gst_scheduler_factory_get_list() to get a list of all available schedulers.
</para>
<para>
Once an schedulerfactory has been obtained use gst_scheduler_factory_create() to
instantiate a real scheduler. Optionally gst_scheduler_factory_make() to create
a scheduler from the named factory.
</para>
<para>
Use gst_scheduler_factory_destroy() to remove the factory from the global list.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstSchedulerFactory ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_SCHEDULER_FACTORY ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_scheduler_factory_new ##### -->
<para>
</para>
@name:
@longdesc:
@type:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_destroy ##### -->
<para>
</para>
@factory:
<!-- ##### FUNCTION gst_scheduler_factory_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_create ##### -->
<para>
</para>
@factory:
@parent:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_make ##### -->
<para>
</para>
@name:
@parent:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_set_default_name ##### -->
<para>
</para>
@name:
<!-- ##### FUNCTION gst_scheduler_factory_get_default_name ##### -->
<para>
</para>
@Returns:

879
docs/gst/tmpl/gsttag.sgml
View file

@ -1,879 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstTag
<!-- ##### SECTION Short_Description ##### -->
List of tags and values used to describe media metadata
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstTagMergeMode ##### -->
<para>
</para>
@GST_TAG_MERGE_UNDEFINED:
@GST_TAG_MERGE_REPLACE_ALL:
@GST_TAG_MERGE_REPLACE:
@GST_TAG_MERGE_APPEND:
@GST_TAG_MERGE_PREPEND:
@GST_TAG_MERGE_KEEP:
@GST_TAG_MERGE_KEEP_ALL:
@GST_TAG_MERGE_COUNT:
<!-- ##### ENUM GstTagFlag ##### -->
<para>
</para>
@GST_TAG_FLAG_UNDEFINED:
@GST_TAG_FLAG_META:
@GST_TAG_FLAG_ENCODED:
@GST_TAG_FLAG_DECODED:
@GST_TAG_FLAG_COUNT:
<!-- ##### TYPEDEF GstTagList ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_LIST ##### -->
<para>
</para>
@x:
<!-- ##### MACRO GST_IS_TAG_LIST ##### -->
<para>
</para>
@x:
<!-- ##### MACRO GST_TYPE_TAG_LIST ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GstTagForeachFunc ##### -->
<para>
</para>
@list:
@tag:
@user_data:
<!-- ##### USER_FUNCTION GstTagMergeFunc ##### -->
<para>
</para>
@dest:
@src:
<!-- ##### FUNCTION gst_tag_register ##### -->
<para>
</para>
@name:
@flag:
@type:
@nick:
@blurb:
@func:
<!-- ##### FUNCTION gst_tag_merge_use_first ##### -->
<para>
</para>
@dest:
@src:
<!-- ##### FUNCTION gst_tag_merge_strings_with_comma ##### -->
<para>
</para>
@dest:
@src:
<!-- ##### FUNCTION gst_tag_exists ##### -->
<para>
</para>
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_get_type ##### -->
<para>
</para>
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_get_nick ##### -->
<para>
</para>
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_get_description ##### -->
<para>
</para>
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_get_flag ##### -->
<para>
</para>
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_is_fixed ##### -->
<para>
</para>
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_list_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_is_tag_list ##### -->
<para>
</para>
@p:
@Returns:
<!-- ##### FUNCTION gst_tag_list_copy ##### -->
<para>
</para>
@list:
@Returns:
<!-- ##### FUNCTION gst_tag_list_insert ##### -->
<para>
</para>
@into:
@from:
@mode:
<!-- ##### FUNCTION gst_tag_list_merge ##### -->
<para>
</para>
@list1:
@list2:
@mode:
@Returns:
<!-- ##### FUNCTION gst_tag_list_free ##### -->
<para>
</para>
@list:
<!-- ##### FUNCTION gst_tag_list_get_tag_size ##### -->
<para>
</para>
@list:
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_list_add ##### -->
<para>
</para>
@list:
@mode:
@tag:
@Varargs:
<!-- ##### FUNCTION gst_tag_list_add_values ##### -->
<para>
</para>
@list:
@mode:
@tag:
@Varargs:
<!-- ##### FUNCTION gst_tag_list_add_valist ##### -->
<para>
</para>
@list:
@mode:
@tag:
@var_args:
<!-- ##### FUNCTION gst_tag_list_add_valist_values ##### -->
<para>
</para>
@list:
@mode:
@tag:
@var_args:
<!-- ##### FUNCTION gst_tag_list_remove_tag ##### -->
<para>
</para>
@list:
@tag:
<!-- ##### FUNCTION gst_tag_list_foreach ##### -->
<para>
</para>
@list:
@func:
@user_data:
<!-- ##### FUNCTION gst_tag_list_get_value_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@Returns:
<!-- ##### FUNCTION gst_tag_list_copy_value ##### -->
<para>
</para>
@dest:
@list:
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_char ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_char_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_uchar ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_uchar_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_boolean ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_boolean_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_int ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_int_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_uint ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_uint_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_long ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_long_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_ulong ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_ulong_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_int64 ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_int64_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_uint64 ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_uint64_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_float ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_float_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_double ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_double_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_string ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_string_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_pointer ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_pointer_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_event_new_tag ##### -->
<para>
</para>
@list:
@Returns:
<!-- ##### FUNCTION gst_event_tag_get_list ##### -->
<para>
</para>
@tag_event:
@Returns:
<!-- ##### MACRO GST_TAG_TITLE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_ARTIST ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_ALBUM ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_DATE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_GENRE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_COMMENT ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_TRACK_NUMBER ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_TRACK_COUNT ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_ALBUM_VOLUME_NUMBER ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_ALBUM_VOLUME_COUNT ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_LOCATION ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_DESCRIPTION ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_VERSION ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_ISRC ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_ORGANIZATION ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_COPYRIGHT ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_CONTACT ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_LICENSE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_PERFORMER ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_DURATION ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_CODEC ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_VIDEO_CODEC ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_AUDIO_CODEC ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_BITRATE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_NOMINAL_BITRATE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_MINIMUM_BITRATE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_MAXIMUM_BITRATE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_SERIAL ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_ENCODER ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_ENCODER_VERSION ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_TRACK_GAIN ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_TRACK_PEAK ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_ALBUM_GAIN ##### -->
<para>
</para>
<!-- ##### MACRO GST_TAG_ALBUM_PEAK ##### -->
<para>
</para>

7
docs/gst/tmpl/gsttagsetter.sgml
View file

@ -27,6 +27,13 @@ Element interface that allows setting and retrieval of media metadata
@g_iface:
<!-- ##### MACRO GST_TYPE_TAG_SETTER ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_tag_setter_merge ##### -->
<para>

7
docs/gst/tmpl/gstthread.sgml
View file

@ -36,6 +36,13 @@ A Thread can act as a toplevel bin as it has its own scheduler.
The thread priority
</para>
<!-- ##### MACRO GST_TYPE_THREAD ##### -->
<para>
</para>
<!-- ##### VARIABLE gst_thread_current ##### -->
<para>

41
docs/gst/tmpl/gsttypefind.sgml
View file

@ -44,12 +44,6 @@ typefinding subsystem
@GST_TYPE_FIND_NEARLY_CERTAIN:
@GST_TYPE_FIND_MAXIMUM:
<!-- ##### STRUCT GstTypeFindFactory ##### -->
<para>
Object that stores information about a typefind function
</para>
<!-- ##### FUNCTION gst_type_find_peek ##### -->
<para>
@ -95,38 +89,3 @@ Object that stores information about a typefind function
@Returns:
<!-- ##### FUNCTION gst_type_find_factory_get_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_type_find_factory_get_extensions ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_type_find_factory_get_caps ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_type_find_factory_call_function ##### -->
<para>
</para>
@factory:
@find:

117
docs/gst/tmpl/gsttypefindfactory.sgml Normal file
View file

@ -0,0 +1,117 @@
<!-- ##### SECTION Title ##### -->
GstTypeFindFactory
<!-- ##### SECTION Short_Description ##### -->
information about registered typefind functions
<!-- ##### SECTION Long_Description ##### -->
<para>
These functions allow querying informations about registered typefind
functions. How to create and register these functions is described in
the section <link linkend="gstreamer-Writing-typefind-functions">
"Writing typefind functions"</link>.
</para>
<example>
<title>how to write a simple typefinder</title>
<programlisting>
/* FIXME: compile this? ;) */
typedef struct {
guint8 *data;
guint size;
guint probability;
GstCaps *data;
} MyTypeFind;
static void
my_peek (gpointer data, gint64 offset, guint size)
{
MyTypeFind *find = (MyTypeFind *) data;
if (offset &gt;= 0 &amp;&amp; offset + size &lt;= find->size) {
return find->data + offset;
}
return NULL;
}
static void
my_suggest (gpointer data, guint probability, GstCaps *caps)
{
MyTypeFind *find = (MyTypeFind *) data;
if (probability &gt; find->probability) {
find->probability = probability;
gst_caps_replace (&amp;find->caps, caps);
}
}
static GstCaps *
find_type (guint8 *data, guint size)
{
GList *walk, *type_list;
MyTypeFind find = {data, size, 0, NULL};
GstTypeFind gst_find = {my_peek, my_suggest, &amp;find, };
walk = type_list = gst_type_find_factory_get_list ();
while (walk) {
GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (walk->data);
walk = g_list_next (walk)
gst_type_find_factory_call_function (factory, &amp;gst_find);
}
g_list_free (type_list);
return find.caps;
};
</programlisting>
</example>
<para>
The above example shows how to write a very simple typefinder that identifies
the given data. You can get quite a bit more complicated than that though.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<link linkend="gstreamer-Writing-typefind-functions">Writing typefind functions</link>
</para>
<!-- ##### STRUCT GstTypeFindFactory ##### -->
<para>
Object that stores information about a typefind function
</para>
<!-- ##### MACRO GST_TYPE_TYPE_FIND_FACTORY ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_type_find_factory_get_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_type_find_factory_get_extensions ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_type_find_factory_get_caps ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_type_find_factory_call_function ##### -->
<para>
</para>
@factory:
@find:

150
docs/gst/tmpl/gsturi.sgml
View file

@ -1,150 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstURIHandler
<!-- ##### SECTION Short_Description ##### -->
Plugin feature that describes URI types and the element that handles it
<!-- ##### SECTION Long_Description ##### -->
<para>
The URIHandler is a pluginfeature that can be used to locate element
and the element property that can handle a given URI.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstURIType ##### -->
<para>
</para>
@GST_URI_UNKNOWN:
@GST_URI_SINK:
@GST_URI_SRC:
<!-- ##### MACRO GST_TYPE_URI_HANDLER ##### -->
<para>
</para>
<!-- ##### STRUCT GstURIHandler ##### -->
<para>
</para>
<!-- ##### MACRO GST_URI_TYPE_IS_VALID ##### -->
<para>
</para>
@type:
<!-- ##### FUNCTION gst_uri_protocol_is_valid ##### -->
<para>
</para>
@protocol:
@Returns:
<!-- ##### FUNCTION gst_uri_is_valid ##### -->
<para>
</para>
@uri:
@Returns:
<!-- ##### FUNCTION gst_uri_get_protocol ##### -->
<para>
</para>
@uri:
@Returns:
<!-- ##### FUNCTION gst_uri_get_location ##### -->
<para>
</para>
@uri:
@Returns:
<!-- ##### FUNCTION gst_uri_construct ##### -->
<para>
</para>
@protocol:
@location:
@Returns:
<!-- ##### FUNCTION gst_element_make_from_uri ##### -->
<para>
</para>
@type:
@uri:
@elementname:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_get_uri_type ##### -->
<para>
</para>
@handler:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_get_protocols ##### -->
<para>
</para>
@handler:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_get_uri ##### -->
<para>
</para>
@handler:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_set_uri ##### -->
<para>
</para>
@handler:
@uri:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_new_uri ##### -->
<para>
</para>
@handler:
@uri:

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

@ -14,6 +14,15 @@ GstURIType
</para>
<!-- ##### ENUM GstURIType ##### -->
<para>
</para>
@GST_URI_UNKNOWN:
@GST_URI_SINK:
@GST_URI_SRC:
<!-- ##### MACRO GST_TYPE_URI ##### -->
<para>

3
docs/libs/gstreamer-libs-docs.sgml
View file

@ -16,7 +16,8 @@
]>
<book>
<bookinfo>
<title>GStreamer Library &GST_MAJORMINOR; API Reference (&GST_VERSION;)</title>
<title>GStreamer &GST_MAJORMINOR; Library API Reference</title>
<releaseinfo>for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
</bookinfo>
<chapter id="gstreamer-libs">
<title>GStreamer Libraries</title>

2
gst/gsturi.c
View file

@ -198,12 +198,14 @@ gst_uri_construct (const gchar * protocol, const gchar * location)
return g_strdup_printf ("%s://%s", protocol, location);
}
typedef struct
{
GstURIType type;
gchar *protocol;
}
SearchEntry;
static gboolean
search_by_entry (GstPluginFeature * feature, gpointer search_entry)
{