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/gstaudiochannels.xml" />
  57       <xi:include href="xml/gstaudioringbuffer.xml" />
  58       <xi:include href="xml/gstaudioiec61937.xml" />
  59       <xi:include href="xml/gststreamvolume.xml" />
  60     </chapter>
  61
  62     <chapter id="gstreamer-ffft">
  63       <title>FFT Library</title>
  64       <para>
  65         The gstfft library is based on
  66         <ulink role="online-location" url="http://sourceforge.net/projects/kissfft">kissfft</ulink>
  67         by Mark Borgerding.
  68       </para>
  69       <para>
  70         This library should be linked to by getting cflags and libs from
  71         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
  72         <filename>-lgstfft-&GST_API_VERSION;</filename> to the library flags.
  73       </para>
  74       <xi:include href="xml/gstfft.xml" />
  75       <xi:include href="xml/gstffts16.xml" />
  76       <xi:include href="xml/gstffts32.xml" />
  77       <xi:include href="xml/gstfftf32.xml" />
  78       <xi:include href="xml/gstfftf64.xml" />
  79     </chapter>
  80
  81     <chapter id="gstreamer-riff">
  82       <title>Riff Media Library</title>
  83       <para>
  84         This library should be linked to by getting cflags and libs from
  85         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
  86         <filename>-lgstriff-&GST_API_VERSION;</filename> to the library flags.
  87       </para>
  88       <xi:include href="xml/gstriff.xml" />
  89     </chapter>
  90
  91     <chapter id="gstreamer-rtp">
  92       <title>RTP Library</title>
  93       <para>
  94         This library should be linked to by getting cflags and libs from
  95         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
  96         <filename>-lgstrtp-&GST_API_VERSION;</filename> to the library flags.
  97       </para>
  98       <xi:include href="xml/gstrtpbaseaudiopayload.xml" />
  99       <xi:include href="xml/gstrtpbasedepayload.xml" />
 100       <xi:include href="xml/gstrtpbasepayload.xml" />
 101       <xi:include href="xml/gstrtpbuffer.xml" />
 102       <xi:include href="xml/gstrtcpbuffer.xml" />
 103       <xi:include href="xml/gstrtppayloads.xml" />
 104       <xi:include href="xml/gstrtphdrext.xml" />
 105     </chapter>
 106
 107     <chapter id="gstreamer-rtsp">
 108       <title>RTSP 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>-lgstrtsp-&GST_API_VERSION;</filename> to the library flags.
 113       </para>
 114       <xi:include href="xml/gstrtspconnection.xml" />
 115       <xi:include href="xml/gstrtspdefs.xml" />
 116       <xi:include href="xml/gstrtspextension.xml" />
 117       <xi:include href="xml/gstrtspmessage.xml" />
 118       <xi:include href="xml/gstrtsprange.xml" />
 119       <xi:include href="xml/gstrtsptransport.xml" />
 120       <xi:include href="xml/gstrtspurl.xml" />
 121     </chapter>
 122
 123     <chapter id="gstreamer-sdp">
 124       <title>SDP Library</title>
 125       <para>
 126         This library should be linked to by getting cflags and libs from
 127         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 128         <filename>-lgstsdp-&GST_API_VERSION;</filename> to the library flags.
 129       </para>
 130       <xi:include href="xml/gstsdpmessage.xml" />
 131     </chapter>
 132
 133     <chapter id="gstreamer-tag">
 134       <title>Tag Support Library</title>
 135       <para>
 136         This library should be linked to by getting cflags and libs from
 137         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 138         <filename>-lgsttag-&GST_API_VERSION;</filename> to the library flags.
 139       </para>
 140       <xi:include href="xml/gsttag.xml" />
 141       <xi:include href="xml/gsttagvorbis.xml" />
 142       <xi:include href="xml/gsttagid3.xml" />
 143       <xi:include href="xml/gsttagexif.xml" />
 144       <xi:include href="xml/gsttagxmp.xml" />
 145       <xi:include href="xml/gsttagxmpwriter.xml" />
 146       <xi:include href="xml/gsttagdemux.xml" />
 147       <xi:include href="xml/gsttagmux.xml" />
 148       <xi:include href="xml/gsttaglanguagecodes.xml" />
 149       <xi:include href="xml/gsttaglicenses.xml" />
 150     </chapter>
 151
 152     <chapter id="gstreamer-base-utils">
 153       <title>Base Utils Library</title>
 154       <para>
 155         This library should be linked to by getting cflags and libs from
 156         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 157         <filename>-lgstpbutils-&GST_API_VERSION;</filename> to the library
 158         flags.
 159       </para>
 160       <xi:include href="xml/gstpbutils.xml" />
 161       <xi:include href="xml/gstpluginsbaseversion.xml" />
 162       <xi:include href="xml/gstpbutilscodecutils.xml" />
 163       <xi:include href="xml/gstpbutilsdescriptions.xml" />
 164       <xi:include href="xml/gstpbutilsmissingplugins.xml" />
 165       <xi:include href="xml/gstpbutilsinstallplugins.xml" />
 166       <xi:include href="xml/gstdiscoverer.xml" />
 167       <xi:include href="xml/encoding-profile.xml" />
 168     </chapter>
 169
 170     <chapter id="gstreamer-video">
 171       <title>Video Library</title>
 172       <para>
 173         This library should be linked to by getting cflags and libs from
 174         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 175         <filename>-lgstvideo-&GST_API_VERSION;</filename> to the library flags.
 176       </para>
 177       <xi:include href="xml/gstvideo.xml" />
 178       <xi:include href="xml/gstvideometa.xml" />
 179       <xi:include href="xml/gstvideooverlaycomposition.xml" />
 180       <xi:include href="xml/gstvideofilter.xml" />
 181       <xi:include href="xml/gstvideosink.xml" />
 182       <xi:include href="xml/gstcolorbalance.xml" />
 183       <xi:include href="xml/gstcolorbalancechannel.xml" />
 184       <xi:include href="xml/gstvideoorientation.xml" />
 185       <xi:include href="xml/gstvideooverlay.xml" />
 186       <xi:include href="xml/gstvideodecoder.xml" />
 187       <xi:include href="xml/gstvideoencoder.xml" />
 188       <xi:include href="xml/gstvideoutils.xml" />
 189     </chapter>
 190   </part>
 191
 192   <part id="gstreamer-libs-hierarchy">
 193     <title>Object Hierarchy</title>
 194     <xi:include href="xml/tree_index.sgml" />
 195   </part>
 196
 197   <index id="api-index-full">
 198     <title>Index</title>
 199     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 200   </index>
 201   <index id="api-index-deprecated" role="deprecated">
 202     <title>Index of deprecated API</title>
 203     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 204   </index>
 205
 206   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 207 </book>