mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-15 13:53:19 +00:00
cbb9529b85
One of the nice feature in GTK doc is that it generate indexes of added APIs base on the since marker. Include that in our doc while fixing the issue of duplicate ID (produce xml contains that id it seems)
179 lines
6.6 KiB
XML
179 lines
6.6 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
|
<!ENTITY % version-entities SYSTEM "version.entities">
|
|
%version-entities;
|
|
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
|
|
<!ENTITY hash "#">
|
|
]>
|
|
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
|
<bookinfo>
|
|
<title>GStreamer &GST_API_VERSION; Core Reference Manual</title>
|
|
<releaseinfo>
|
|
for GStreamer Core &GST_API_VERSION; (&GST_VERSION;)
|
|
The latest version of this documentation can be found on-line at
|
|
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/</ulink>.
|
|
</releaseinfo>
|
|
</bookinfo>
|
|
|
|
<chapter id="gstreamer">
|
|
|
|
<title>GStreamer Overview</title>
|
|
<para>
|
|
GStreamer is a streaming media framework.
|
|
It uses graphs of elements which operate on data.
|
|
The functionality to process media is provided by plug-ins which provide
|
|
features like elements, typefinding, and so on.
|
|
This allows new functionality to be added simply by installing new plug-ins.
|
|
</para>
|
|
|
|
<para>
|
|
GStreamer is cross-platform and works on most UNIX-like platforms as well as
|
|
Windows. It is released under the GNU Library General Public License
|
|
(GNU LGPL).
|
|
</para>
|
|
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="gst-universe.svg" format="SVG"/>
|
|
</imageobject>
|
|
<caption>
|
|
<para>Relation between gstreamer core objects.</para>
|
|
</caption>
|
|
</mediaobject>
|
|
|
|
<xi:include href="building.xml" />
|
|
<xi:include href="running.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="libgstreamer">
|
|
<title>GStreamer Core Library</title>
|
|
|
|
<para>
|
|
libgstreamer-&GST_API_VERSION;.so provides all the core GStreamer services,
|
|
including initialization, plugin management and types,
|
|
as well as the object hierarchy that defines elements and bins,
|
|
along with some more specialized elements.
|
|
</para>
|
|
|
|
<xi:include href="xml/gst.xml" />
|
|
<xi:include href="xml/gstallocator.xml" />
|
|
<xi:include href="xml/gstatomicqueue.xml" />
|
|
<xi:include href="xml/gstbin.xml" />
|
|
<xi:include href="xml/gstbuffer.xml" />
|
|
<xi:include href="xml/gstbufferlist.xml" />
|
|
<xi:include href="xml/gstbufferpool.xml" />
|
|
<xi:include href="xml/gstbus.xml" />
|
|
<xi:include href="xml/gstcaps.xml" />
|
|
<xi:include href="xml/gstcapsfeatures.xml" />
|
|
<xi:include href="xml/gstsample.xml" />
|
|
<xi:include href="xml/gstchildproxy.xml" />
|
|
<xi:include href="xml/gstclock.xml" />
|
|
<xi:include href="xml/gstconfig.xml" />
|
|
<xi:include href="xml/gstcontext.xml" />
|
|
<xi:include href="xml/gstcontrolbinding.xml" />
|
|
<xi:include href="xml/gstcontrolsource.xml" />
|
|
<xi:include href="xml/gstdatetime.xml" />
|
|
<xi:include href="xml/gstelement.xml" />
|
|
<xi:include href="xml/gstelementfactory.xml" />
|
|
<xi:include href="xml/gsterror.xml" />
|
|
<xi:include href="xml/gstevent.xml" />
|
|
<xi:include href="xml/gstformat.xml" />
|
|
<xi:include href="xml/gstghostpad.xml" />
|
|
<xi:include href="xml/gstiterator.xml" />
|
|
<xi:include href="xml/gstmemory.xml" />
|
|
<xi:include href="xml/gstmessage.xml" />
|
|
<xi:include href="xml/gstmeta.xml" />
|
|
<xi:include href="xml/gstminiobject.xml" />
|
|
<xi:include href="xml/gstobject.xml" />
|
|
<xi:include href="xml/gstpad.xml" />
|
|
<xi:include href="xml/gstpadtemplate.xml" />
|
|
<xi:include href="xml/gstparamspec.xml" />
|
|
<xi:include href="xml/gstparse.xml" />
|
|
<xi:include href="xml/gstpipeline.xml" />
|
|
<xi:include href="xml/gstplugin.xml" />
|
|
<xi:include href="xml/gstpluginfeature.xml" />
|
|
<xi:include href="xml/gstpoll.xml" />
|
|
<xi:include href="xml/gstpreset.xml" />
|
|
<xi:include href="xml/gstprotection.xml" />
|
|
<xi:include href="xml/gstquery.xml" />
|
|
<xi:include href="xml/gstregistry.xml" />
|
|
<xi:include href="xml/gstsegment.xml" />
|
|
<xi:include href="xml/gststructure.xml" />
|
|
<xi:include href="xml/gstsystemclock.xml" />
|
|
<xi:include href="xml/gsttaglist.xml" />
|
|
<xi:include href="xml/gsttagsetter.xml" />
|
|
<xi:include href="xml/gsttask.xml" />
|
|
<xi:include href="xml/gsttaskpool.xml" />
|
|
<xi:include href="xml/gsttoc.xml" />
|
|
<xi:include href="xml/gsttocsetter.xml" />
|
|
<xi:include href="xml/gsttypefind.xml" />
|
|
<xi:include href="xml/gsttypefindfactory.xml" />
|
|
<xi:include href="xml/gsturi.xml" />
|
|
<xi:include href="xml/gsturihandler.xml" />
|
|
<xi:include href="xml/gstutils.xml" />
|
|
<xi:include href="xml/gstvalue.xml" />
|
|
<xi:include href="xml/gstversion.xml" />
|
|
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-device-probing">
|
|
<title>GStreamer Device Discovery and Device Probing</title>
|
|
<xi:include href="xml/gstdevicemonitor.xml" />
|
|
<xi:include href="xml/gstdevice.xml" />
|
|
<xi:include href="xml/gstdeviceprovider.xml" />
|
|
<xi:include href="xml/gstdeviceproviderfactory.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-support">
|
|
<title>GStreamer Core Support</title>
|
|
<para>
|
|
Theses modules support the gstreamer core and plugin development.
|
|
Application developers will rarely need to know about it.
|
|
</para>
|
|
|
|
<xi:include href="xml/gstinfo.xml" />
|
|
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-hierarchy">
|
|
<title>Object Hierarchy</title>
|
|
<xi:include href="xml/tree_index.sgml"/>
|
|
</chapter>
|
|
|
|
<index>
|
|
<title>API Index</title>
|
|
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
<index role="deprecated">
|
|
<title>Index of deprecated API</title>
|
|
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
<index>
|
|
<title>Index of new API in 1.6</title>
|
|
<xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
<index>
|
|
<title>Index of new API in 1.4</title>
|
|
<xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
<index>
|
|
<title>Index of new API in 1.2.3</title>
|
|
<xi:include href="xml/api-index-1.2.3.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
<index>
|
|
<title>Index of new API in 1.2</title>
|
|
<xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
<index>
|
|
<title>Index of new API in 1.0.10</title>
|
|
<xi:include href="xml/api-index-1.0.10.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
<index>
|
|
<title>Index of new API in 1.0.5</title>
|
|
<xi:include href="xml/api-index-1.0.5.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
|
|
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
|
|
|
|
</book>
|