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_API_VERSION; Library Reference Manual</title>
  12     <releaseinfo>
  13       for GStreamer Library &GST_API_VERSION; (&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_API_VERSION;.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/gstaggregator.xml" />
  37       <xi:include href="xml/gstaggregatorpad.xml" />
  38
  39       <xi:include href="xml/gstbaseparse.xml" />
  40       <xi:include href="xml/gstbasesrc.xml" />
  41       <xi:include href="xml/gstbasesink.xml" />
  42       <xi:include href="xml/gstbasetransform.xml" />
  43       <xi:include href="xml/gstpushsrc.xml" />
  44
  45       <xi:include href="xml/gstadapter.xml" />
  46       <xi:include href="xml/gstbitreader.xml" />
  47       <xi:include href="xml/gstbytereader.xml" />
  48       <xi:include href="xml/gstbytewriter.xml" />
  49       <xi:include href="xml/gstcollectpads.xml" />
  50       <xi:include href="xml/gstflowcombiner.xml" />
  51       <xi:include href="xml/gsttypefindhelper.xml" />
  52       <xi:include href="xml/gstdataqueue.xml" />
  53       <xi:include href="xml/gstqueuearray.xml" />
  54     </chapter>
  55
  56     <chapter id="gstreamer-control">
  57       <title>GStreamer Dynamic Parameter Control</title>
  58       <para>
  59         libgstcontroller-&GST_API_VERSION;.so provides functionality to animate
  60         element properties over time.
  61       </para>
  62
  63                         <xi:include href="xml/gstargbcontrolbinding.xml" />
  64                         <xi:include href="xml/gstdirectcontrolbinding.xml" />
  65                         <xi:include href="xml/gstproxycontrolbinding.xml" />
  66
  67       <xi:include href="xml/gsttimedvaluecontrolsource.xml" />
  68       <xi:include href="xml/gstinterpolationcontrolsource.xml" />
  69       <xi:include href="xml/gstlfocontrolsource.xml" />
  70       <xi:include href="xml/gsttriggercontrolsource.xml" />
  71     </chapter>
  72
  73     <chapter id="gstreamer-net">
  74       <title>GStreamer Network Classes</title>
  75       <para>
  76         libgstnet-&GST_API_VERSION;.so provides network elements and objects.
  77       </para>
  78
  79       <xi:include href="xml/gstnetaddressmeta.xml" />
  80       <xi:include href="xml/gstnetclientclock.xml" />
  81       <xi:include href="xml/gstnetcontrolmessagemeta.xml" />
  82       <xi:include href="xml/gstnettimepacket.xml" />
  83       <xi:include href="xml/gstnettimeprovider.xml" />
  84       <xi:include href="xml/gstptpclock.xml" />
  85     </chapter>
  86
  87     <chapter id="gstreamer-check">
  88       <title>GStreamer Check Unit Testing</title>
  89       <para>
  90         libgstcheck-&GST_API_VERSION;.so provides functionality for writing
  91         unit tests that use the check framework.
  92       </para>
  93
  94       <xi:include href="xml/gstcheck.xml" />
  95       <xi:include href="xml/gstcheckbufferstraw.xml" />
  96       <xi:include href="xml/gstcheckconsistencychecker.xml" />
  97       <xi:include href="xml/gstharness.xml" />
  98       <xi:include href="xml/gsttestclock.xml" />
  99     </chapter>
 100   </part>
 101
 102   <chapter id="gstreamer-hierarchy">
 103     <title>Object Hierarchy</title>
 104     <xi:include href="xml/tree_index.sgml"/>
 105   </chapter>
 106
 107   <index>
 108     <title>API Index</title>
 109     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 110   </index>
 111   <index role="deprecated">
 112     <title>Index of deprecated API</title>
 113     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 114   </index>
 115   <index>
 116     <title>Index of new API in 1.14</title>
 117     <xi:include href="xml/api-index-1.14.xml"><xi:fallback /></xi:include>
 118   </index>
 119   <index>
 120     <title>Index of new API in 1.12.1</title>
 121     <xi:include href="xml/api-index-1.12.1.xml"><xi:fallback /></xi:include>
 122   </index>
 123   <index>
 124     <title>Index of new API in 1.12</title>
 125     <xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include>
 126   </index>
 127   <index>
 128     <title>Index of new API in 1.10</title>
 129     <xi:include href="xml/api-index-1.10.xml"><xi:fallback /></xi:include>
 130   </index>
 131   <index>
 132     <title>Index of new API in 1.8</title>
 133     <xi:include href="xml/api-index-1.8.xml"><xi:fallback /></xi:include>
 134   </index>
 135   <index>
 136     <title>Index of new API in 1.6</title>
 137     <xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include>
 138   </index>
 139   <index>
 140     <title>Index of new API in 1.4</title>
 141     <xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include>
 142   </index>
 143   <index>
 144     <title>Index of new API in 1.2</title>
 145     <xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
 146   </index>
 147   <index>
 148     <title>Index of new API in 1.0.1</title>
 149     <xi:include href="xml/api-index-1.0.1.xml"><xi:fallback /></xi:include>
 150   </index>
 151
 152   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 153
 154 </book>