mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-03-06 11:51:13 +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)
128 lines
4.7 KiB
XML
128 lines
4.7 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/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; Library Reference Manual</title>
|
|
<releaseinfo>
|
|
for GStreamer Library &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-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/</ulink>.
|
|
</releaseinfo>
|
|
</bookinfo>
|
|
<part id="gstreamer-libs">
|
|
<title>GStreamer Libraries</title>
|
|
|
|
<para>
|
|
To ease the creation of plugins, a library system was created. The most common
|
|
functions for a plugin can be found in a library.
|
|
</para>
|
|
<para>
|
|
GStreamer provides some standard libraries you can use to create plugins.
|
|
</para>
|
|
|
|
<chapter id="gstreamer-base">
|
|
<title>GStreamer Base and Utillity Classes</title>
|
|
<para>
|
|
libgstbase-&GST_API_VERSION;.so provides some base classes to be extended
|
|
by elements and utillity classes that are most useful for plugin developers.
|
|
</para>
|
|
|
|
<xi:include href="xml/gstbaseparse.xml" />
|
|
<xi:include href="xml/gstbasesrc.xml" />
|
|
<xi:include href="xml/gstbasesink.xml" />
|
|
<xi:include href="xml/gstbasetransform.xml" />
|
|
<xi:include href="xml/gstpushsrc.xml" />
|
|
|
|
<xi:include href="xml/gstadapter.xml" />
|
|
<xi:include href="xml/gstbitreader.xml" />
|
|
<xi:include href="xml/gstbytereader.xml" />
|
|
<xi:include href="xml/gstbytewriter.xml" />
|
|
<xi:include href="xml/gstcollectpads.xml" />
|
|
<xi:include href="xml/gstflowcombiner.xml" />
|
|
<xi:include href="xml/gsttypefindhelper.xml" />
|
|
<xi:include href="xml/gstdataqueue.xml" />
|
|
<xi:include href="xml/gstqueuearray.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-control">
|
|
<title>GStreamer Dynamic Parameter Control</title>
|
|
<para>
|
|
libgstcontroller-&GST_API_VERSION;.so provides functionality to animate
|
|
element properties over time.
|
|
</para>
|
|
|
|
<xi:include href="xml/gstargbcontrolbinding.xml" />
|
|
<xi:include href="xml/gstdirectcontrolbinding.xml" />
|
|
|
|
<xi:include href="xml/gsttimedvaluecontrolsource.xml" />
|
|
<xi:include href="xml/gstinterpolationcontrolsource.xml" />
|
|
<xi:include href="xml/gstlfocontrolsource.xml" />
|
|
<xi:include href="xml/gsttriggercontrolsource.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-net">
|
|
<title>GStreamer Network Classes</title>
|
|
<para>
|
|
libgstnet-&GST_API_VERSION;.so provides network elements and objects.
|
|
</para>
|
|
|
|
<xi:include href="xml/gstnetaddressmeta.xml" />
|
|
<xi:include href="xml/gstnetclientclock.xml" />
|
|
<xi:include href="xml/gstnettimepacket.xml" />
|
|
<xi:include href="xml/gstnettimeprovider.xml" />
|
|
<xi:include href="xml/gstptpclock.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-check">
|
|
<title>GStreamer Check Unit Testing</title>
|
|
<para>
|
|
libgstcheck-&GST_API_VERSION;.so provides functionality for writing
|
|
unit tests that use the check framework.
|
|
</para>
|
|
|
|
<xi:include href="xml/gstcheck.xml" />
|
|
<xi:include href="xml/gstcheckbufferstraw.xml" />
|
|
<xi:include href="xml/gstcheckconsistencychecker.xml" />
|
|
<xi:include href="xml/gsttestclock.xml" />
|
|
</chapter>
|
|
</part>
|
|
|
|
<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</title>
|
|
<xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
<index>
|
|
<title>Index of new API in 1.0.1</title>
|
|
<xi:include href="xml/api-index-1.0.1.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
|
|
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
|
|
|
|
</book>
|