docs/libs/gstreamer-libs-docs.sgml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY % version-entities SYSTEM "version.entities">
   5 %version-entities;
   6 <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
   7 <!ENTITY hash "#">
   8 ]>
   9 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  10   <bookinfo>
  11     <title>GStreamer &GST_MAJORMINOR; Library Reference Manual</title>
  12     <releaseinfo>
  13       for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)
  14       The latest version of this documentation can be found on-line at
  15       <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>.
  16     </releaseinfo>
  17   </bookinfo>
  18   <part id="gstreamer-libs">
  19     <title>GStreamer Libraries</title>
  20
  21     <para>
  22       To ease the creation of plugins, a library system was created. The most common
  23       functions for a plugin can be found in a library.
  24     </para>
  25     <para>
  26       GStreamer provides some standard libraries you can use to create plugins.
  27     </para>
  28
  29     <chapter id="gstreamer-base">
  30       <title>GStreamer Base and Utillity Classes</title>
  31       <para>
  32         libgstbase-&GST_MAJORMINOR;.so provides some base classes to be extended
  33         by elements and utillity classes that are most useful for plugin developers.
  34       </para>
  35
  36       <xi:include href="xml/gstbaseparse.xml" />
  37       <xi:include href="xml/gstbasesrc.xml" />
  38       <xi:include href="xml/gstbasesink.xml" />
  39       <xi:include href="xml/gstbasetransform.xml" />
  40       <xi:include href="xml/gstpushsrc.xml" />
  41
  42       <xi:include href="xml/gstadapter.xml" />
  43       <xi:include href="xml/gstbitreader.xml" />
  44       <xi:include href="xml/gstbytereader.xml" />
  45       <xi:include href="xml/gstbytewriter.xml" />
  46       <xi:include href="xml/gstcollectpads.xml" />
  47       <xi:include href="xml/gstcollectpads2.xml" />
  48       <xi:include href="xml/gsttypefindhelper.xml" />
  49     </chapter>
  50
  51     <chapter id="gstreamer-control">
  52       <title>GStreamer Dynamic Parameter Control</title>
  53       <para>
  54         libgstcontroller-&GST_MAJORMINOR;.so provides functionality to animate
  55         element properties over time.
  56       </para>
  57
  58       <xi:include href="xml/gstinterpolationcontrolsource.xml" />
  59       <xi:include href="xml/gstlfocontrolsource.xml" />
  60     </chapter>
  61
  62     <chapter id="gstreamer-dataprotocol">
  63       <title>GStreamer Data Protocol</title>
  64       <xi:include href="xml/gstdataprotocol.xml" />
  65     </chapter>
  66
  67     <chapter id="gstreamer-net">
  68       <title>GStreamer Network Classes</title>
  69       <para>
  70         libgstnet-&GST_MAJORMINOR;.so provides network elements and objects.
  71       </para>
  72
  73       <xi:include href="xml/gstnetclientclock.xml" />
  74       <xi:include href="xml/gstnettimepacket.xml" />
  75       <xi:include href="xml/gstnettimeprovider.xml" />
  76     </chapter>
  77
  78     <chapter id="gstreamer-check">
  79       <title>GStreamer Check Unit Testing</title>
  80       <para>
  81         libgstcheck-&GST_MAJORMINOR;.so provides functionality for writing
  82         unit tests that use the check framework.
  83       </para>
  84
  85       <xi:include href="xml/gstcheck.xml" />
  86       <xi:include href="xml/gstcheckbufferstraw.xml" />
  87       <xi:include href="xml/gstcheckconsistencychecker.xml" />
  88     </chapter>
  89   </part>
  90
  91   <chapter id="gstreamer-hierarchy">
  92     <title>Object Hierarchy</title>
  93     <xi:include href="xml/tree_index.sgml"/>
  94   </chapter>
  95
  96   <index id="api-index-full">
  97     <title>API Index</title>
  98     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  99   </index>
 100   <index id="api-index-deprecated" role="deprecated">
 101     <title>Index of deprecated API</title>
 102     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 103   </index>
 104
 105   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 106
 107 </book>