docs/libs/gst-plugins-base-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 ]>
   7 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   8   <bookinfo>
   9     <title>GStreamer Base Plugins &GST_API_VERSION; Library Reference Manual</title>
  10     <releaseinfo>
  11       for GStreamer Base Library &GST_API_VERSION; (&GST_VERSION;)
  12       <ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/</ulink>.
  13     </releaseinfo>
  14   </bookinfo>
  15
  16   <part id="gstreamer-plugins-base">
  17     <title>GStreamer Base Plugins Libraries</title>
  18     <para>
  19       This manual describes the libraries provided by the GStreamer Base Plugins
  20       package.
  21     </para>
  22     <xi:include href="compiling.sgml" />
  23
  24     <chapter id="gstreamer-app">
  25       <title>App Library</title>
  26       <para>
  27         This library should be linked to by getting cflags and libs from
  28         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
  29         <filename>-lgstapp-&GST_API_VERSION;</filename> to the library flags.
  30       </para>
  31       <para>
  32       To use it the functionality, insert an appsrc or appsink element into a pipeline and call the appropriate functions on the element.
  33       </para>
  34       <xi:include href="xml/gstappsrc.xml" />
  35       <xi:include href="xml/gstappsink.xml" />
  36     </chapter>
  37
  38     <chapter id="gstreamer-audio">
  39       <title>Audio Library</title>
  40       <para>
  41         This library should be linked to by getting cflags and libs from
  42         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
  43         <filename>-lgstaudio-&GST_API_VERSION;</filename> to the library flags.
  44       </para>
  45       <xi:include href="xml/gstaudio.xml" />
  46       <xi:include href="xml/gstaudiocdsrc.xml" />
  47       <xi:include href="xml/gstaudioclock.xml" />
  48       <xi:include href="xml/gstaudiodecoder.xml" />
  49       <xi:include href="xml/gstaudioencoder.xml" />
  50       <xi:include href="xml/gstaudiofilter.xml" />
  51       <xi:include href="xml/gstaudiomixerutils.xml" />
  52       <xi:include href="xml/gstaudiosink.xml" />
  53       <xi:include href="xml/gstaudiosrc.xml" />
  54       <xi:include href="xml/gstaudiobasesink.xml" />
  55       <xi:include href="xml/gstaudiobasesrc.xml" />
  56       <xi:include href="xml/gstmultichannel.xml" />
  57       <xi:include href="xml/gstaudioringbuffer.xml" />
  58       <xi:include href="xml/gstaudioiec61937.xml" />
  59       <xi:include href="xml/gststreamvolume.xml" />
  60       <xi:include href="xml/gstmixer.xml" />
  61       <xi:include href="xml/gstmixeroptions.xml" />
  62       <xi:include href="xml/gstmixertrack.xml" />
  63     </chapter>
  64
  65     <chapter id="gstreamer-ffft">
  66       <title>FFT Library</title>
  67       <para>
  68         The gstfft library is based on
  69         <ulink role="online-location" url="http://sourceforge.net/projects/kissfft">kissfft</ulink>
  70         by Mark Borgerding.
  71       </para>
  72       <para>
  73         This library should be linked to by getting cflags and libs from
  74         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
  75         <filename>-lgstfft-&GST_API_VERSION;</filename> to the library flags.
  76       </para>
  77       <xi:include href="xml/gstfft.xml" />
  78       <xi:include href="xml/gstffts16.xml" />
  79       <xi:include href="xml/gstffts32.xml" />
  80       <xi:include href="xml/gstfftf32.xml" />
  81       <xi:include href="xml/gstfftf64.xml" />
  82     </chapter>
  83
  84     <chapter id="gstreamer-interfaces">
  85       <title>Interfaces Library</title>
  86       <para>
  87         This library should be linked to by getting cflags and libs from
  88         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
  89         <filename>-lgstinterfaces-&GST_API_VERSION;</filename> to the library flags.
  90       </para>
  91       <xi:include href="xml/gstnavigation.xml" />
  92       <xi:include href="xml/gsttuner.xml" />
  93       <xi:include href="xml/gsttunerchannel.xml" />
  94       <xi:include href="xml/gsttunernorm.xml" />
  95     </chapter>
  96
  97     <chapter id="gstreamer-riff">
  98       <title>Riff Media Library</title>
  99       <para>
 100         This library should be linked to by getting cflags and libs from
 101         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 102         <filename>-lgstriff-&GST_API_VERSION;</filename> to the library flags.
 103       </para>
 104       <xi:include href="xml/gstriff.xml" />
 105     </chapter>
 106
 107     <chapter id="gstreamer-rtp">
 108       <title>RTP Library</title>
 109       <para>
 110         This library should be linked to by getting cflags and libs from
 111         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 112         <filename>-lgstrtp-&GST_API_VERSION;</filename> to the library flags.
 113       </para>
 114       <xi:include href="xml/gstrtpbaseaudiopayload.xml" />
 115       <xi:include href="xml/gstrtpbasedepayload.xml" />
 116       <xi:include href="xml/gstrtpbasepayload.xml" />
 117       <xi:include href="xml/gstrtpbuffer.xml" />
 118       <xi:include href="xml/gstrtcpbuffer.xml" />
 119       <xi:include href="xml/gstrtppayloads.xml" />
 120     </chapter>
 121
 122     <chapter id="gstreamer-rtsp">
 123       <title>RTSP Library</title>
 124       <para>
 125         This library should be linked to by getting cflags and libs from
 126         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 127         <filename>-lgstrtsp-&GST_API_VERSION;</filename> to the library flags.
 128       </para>
 129       <xi:include href="xml/gstrtspconnection.xml" />
 130       <xi:include href="xml/gstrtspdefs.xml" />
 131       <xi:include href="xml/gstrtspextension.xml" />
 132       <xi:include href="xml/gstrtspmessage.xml" />
 133       <xi:include href="xml/gstrtsprange.xml" />
 134       <xi:include href="xml/gstrtsptransport.xml" />
 135       <xi:include href="xml/gstrtspurl.xml" />
 136     </chapter>
 137
 138     <chapter id="gstreamer-sdp">
 139       <title>SDP Library</title>
 140       <para>
 141         This library should be linked to by getting cflags and libs from
 142         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 143         <filename>-lgstsdp-&GST_API_VERSION;</filename> to the library flags.
 144       </para>
 145       <xi:include href="xml/gstsdpmessage.xml" />
 146     </chapter>
 147
 148     <chapter id="gstreamer-tag">
 149       <title>Tag Support Library</title>
 150       <para>
 151         This library should be linked to by getting cflags and libs from
 152         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 153         <filename>-lgsttag-&GST_API_VERSION;</filename> to the library flags.
 154       </para>
 155       <xi:include href="xml/gsttag.xml" />
 156       <xi:include href="xml/gsttagvorbis.xml" />
 157       <xi:include href="xml/gsttagid3.xml" />
 158       <xi:include href="xml/gsttagexif.xml" />
 159       <xi:include href="xml/gsttagxmp.xml" />
 160       <xi:include href="xml/gsttagxmpwriter.xml" />
 161       <xi:include href="xml/gsttagdemux.xml" />
 162       <xi:include href="xml/gsttagmux.xml" />
 163       <xi:include href="xml/gsttaglanguagecodes.xml" />
 164       <xi:include href="xml/gsttaglicenses.xml" />
 165     </chapter>
 166
 167     <chapter id="gstreamer-base-utils">
 168       <title>Base Utils Library</title>
 169       <para>
 170         This library should be linked to by getting cflags and libs from
 171         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 172         <filename>-lgstpbutils-&GST_API_VERSION;</filename> to the library
 173         flags.
 174       </para>
 175       <xi:include href="xml/gstpbutils.xml" />
 176       <xi:include href="xml/gstpluginsbaseversion.xml" />
 177       <xi:include href="xml/gstpbutilscodecutils.xml" />
 178       <xi:include href="xml/gstpbutilsdescriptions.xml" />
 179       <xi:include href="xml/gstpbutilsmissingplugins.xml" />
 180       <xi:include href="xml/gstpbutilsinstallplugins.xml" />
 181       <xi:include href="xml/gstdiscoverer.xml" />
 182       <xi:include href="xml/encoding-profile.xml" />
 183     </chapter>
 184
 185     <chapter id="gstreamer-video">
 186       <title>Video Library</title>
 187       <para>
 188         This library should be linked to by getting cflags and libs from
 189         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 190         <filename>-lgstvideo-&GST_API_VERSION;</filename> to the library flags.
 191       </para>
 192       <xi:include href="xml/gstvideo.xml" />
 193       <xi:include href="xml/gstvideooverlaycomposition.xml" />
 194       <xi:include href="xml/gstvideofilter.xml" />
 195       <xi:include href="xml/gstvideosink.xml" />
 196       <xi:include href="xml/gstcolorbalance.xml" />
 197       <xi:include href="xml/gstcolorbalancechannel.xml" />
 198       <xi:include href="xml/gstvideoorientation.xml" />
 199       <xi:include href="xml/gstvideooverlay.xml" />
 200     </chapter>
 201   </part>
 202
 203   <part id="gstreamer-libs-hierarchy">
 204     <title>Object Hierarchy</title>
 205     <xi:include href="xml/tree_index.sgml" />
 206   </part>
 207
 208   <index id="api-index-full">
 209     <title>Index</title>
 210     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 211   </index>
 212   <index id="api-index-deprecated" role="deprecated">
 213     <title>Index of deprecated API</title>
 214     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 215   </index>
 216
 217   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 218 </book>