gstreamer/docs/libs/gstreamer-libs-docs.sgml
Tim-Philipp Müller 434e7042d8 base: make GstDataQueue private API for multiqueue
There's no code that uses it other than multiqueue, so make it private
to multiqueue for now. That way we can also do optimisations that
require API/ABI breaks. If anyone ever wants to use it, we can still
make it public again.
2011-10-07 13:54:37 +01:00

109 lines
4 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_MAJORMINOR; Library Reference Manual</title>
<releaseinfo>
for GStreamer Library &GST_MAJORMINOR; (&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_MAJORMINOR;.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/gsttypefindhelper.xml" />
</chapter>
<chapter id="gstreamer-control">
<title>GStreamer Dynamic Parameter Control</title>
<para>
libgstcontroller-&GST_MAJORMINOR;.so provides functionality to animate
element properties over time.
</para>
<xi:include href="xml/gstcontroller.xml" />
<xi:include href="xml/gstcontrolsource.xml" />
<xi:include href="xml/gstinterpolationcontrolsource.xml" />
<xi:include href="xml/gstlfocontrolsource.xml" />
<xi:include href="xml/gstcontrollergobject.xml" />
</chapter>
<chapter id="gstreamer-dataprotocol">
<title>GStreamer Data Protocol</title>
<xi:include href="xml/gstdataprotocol.xml" />
</chapter>
<chapter id="gstreamer-net">
<title>GStreamer Network Classes</title>
<para>
libgstnet-&GST_MAJORMINOR;.so provides network elements and objects.
</para>
<xi:include href="xml/gstnetclientclock.xml" />
<xi:include href="xml/gstnettimepacket.xml" />
<xi:include href="xml/gstnettimeprovider.xml" />
</chapter>
<chapter id="gstreamer-check">
<title>GStreamer Check Unit Testing</title>
<para>
libgstcheck-&GST_MAJORMINOR;.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" />
</chapter>
</part>
<chapter id="gstreamer-hierarchy">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-deprecated" role="deprecated">
<title>Index of deprecated API</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>