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_MAJORMINOR; Library Reference Manual</title>
  10     <releaseinfo>
  11       for GStreamer Base Library &GST_MAJORMINOR; (&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_MAJORMINOR;.pc</filename> and adding
  29         <filename>-lgstapp-&GST_MAJORMINOR;</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_MAJORMINOR;.pc</filename> and adding
  43         <filename>-lgstaudio-&GST_MAJORMINOR;</filename> to the library flags.
  44       </para>
  45       <xi:include href="xml/gstaudio.xml" />
  46       <xi:include href="xml/gstaudioclock.xml" />
  47       <xi:include href="xml/gstaudiofilter.xml" />
  48       <xi:include href="xml/gstaudiomixerutils.xml" />
  49       <xi:include href="xml/gstaudiosink.xml" />
  50       <xi:include href="xml/gstaudiosrc.xml" />
  51       <xi:include href="xml/gstbaseaudiosink.xml" />
  52       <xi:include href="xml/gstbaseaudiosrc.xml" />
  53       <xi:include href="xml/gstmultichannel.xml" />
  54       <xi:include href="xml/gstringbuffer.xml" />
  55       <xi:include href="xml/gstaudioiec61937.xml" />
  56     </chapter>
  57
  58     <chapter id="gstreamer-cdda">
  59       <title>CDDA Library</title>
  60       <para>
  61         This library should be linked to by getting cflags and libs from
  62         <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
  63         <filename>-lgstcdda-&GST_MAJORMINOR;</filename> to the library flags.
  64       </para>
  65       <xi:include href="xml/gstcddabasesrc.xml" />
  66     </chapter>
  67
  68     <chapter id="gstreamer-ffft">
  69       <title>FFT Library</title>
  70       <para>
  71         The gstfft library is based on
  72         <ulink role="online-location" url="http://sourceforge.net/projects/kissfft">kissfft</ulink>
  73         by Mark Borgerding.
  74       </para>
  75       <para>
  76         This library should be linked to by getting cflags and libs from
  77         <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
  78         <filename>-lgstfft-&GST_MAJORMINOR;</filename> to the library flags.
  79       </para>
  80       <xi:include href="xml/gstfft.xml" />
  81       <xi:include href="xml/gstffts16.xml" />
  82       <xi:include href="xml/gstffts32.xml" />
  83       <xi:include href="xml/gstfftf32.xml" />
  84       <xi:include href="xml/gstfftf64.xml" />
  85     </chapter>
  86
  87     <chapter id="gstreamer-floatcast">
  88       <title>FloatCast Library</title>
  89       <para>
  90         This library should be linked to by getting cflags and libs from
  91         <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
  92         <filename>-lgstfloatcase-&GST_MAJORMINOR;</filename> to the library flags.
  93       </para>
  94       <xi:include href="xml/gstfloatcast.xml" />
  95     </chapter>
  96
  97     <chapter id="gstreamer-interfaces">
  98       <title>Interfaces Library</title>
  99       <para>
 100         This library should be linked to by getting cflags and libs from
 101         <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
 102         <filename>-lgstinterfaces-&GST_MAJORMINOR;</filename> to the library flags.
 103       </para>
 104       <xi:include href="xml/gstcolorbalance.xml" />
 105       <xi:include href="xml/gstcolorbalancechannel.xml" />
 106       <xi:include href="xml/gstmixer.xml" />
 107       <xi:include href="xml/gstmixeroptions.xml" />
 108       <xi:include href="xml/gstmixertrack.xml" />
 109       <xi:include href="xml/gstnavigation.xml" />
 110       <xi:include href="xml/gstpropertyprobe.xml" />
 111       <xi:include href="xml/gststreamvolume.xml" />
 112       <xi:include href="xml/gsttuner.xml" />
 113       <xi:include href="xml/gsttunerchannel.xml" />
 114       <xi:include href="xml/gsttunernorm.xml" />
 115       <xi:include href="xml/gstvideoorientation.xml" />
 116       <xi:include href="xml/gstvideooverlay.xml" />
 117     </chapter>
 118
 119     <chapter id="gstreamer-netbuffer">
 120       <title>Network Buffer Library</title>
 121       <para>
 122         This library should be linked to by getting cflags and libs from
 123         <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
 124         <filename>-lgstnetbuffer-&GST_MAJORMINOR;</filename> to the library flags.
 125       </para>
 126       <xi:include href="xml/gstnetbuffer.xml" />
 127     </chapter>
 128
 129     <chapter id="gstreamer-riff">
 130       <title>Riff Media Library</title>
 131       <para>
 132         This library should be linked to by getting cflags and libs from
 133         <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
 134         <filename>-lgstriff-&GST_MAJORMINOR;</filename> to the library flags.
 135       </para>
 136       <xi:include href="xml/gstriff.xml" />
 137     </chapter>
 138
 139     <chapter id="gstreamer-rtp">
 140       <title>RTP Library</title>
 141       <para>
 142         This library should be linked to by getting cflags and libs from
 143         <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
 144         <filename>-lgstrtp-&GST_MAJORMINOR;</filename> to the library flags.
 145       </para>
 146       <xi:include href="xml/gstbasertpaudiopayload.xml" />
 147       <xi:include href="xml/gstbasertpdepayload.xml" />
 148       <xi:include href="xml/gstbasertppayload.xml" />
 149       <xi:include href="xml/gstrtpbuffer.xml" />
 150       <xi:include href="xml/gstrtcpbuffer.xml" />
 151       <xi:include href="xml/gstrtppayloads.xml" />
 152     </chapter>
 153
 154     <chapter id="gstreamer-rtsp">
 155       <title>RTSP Library</title>
 156       <para>
 157         This library should be linked to by getting cflags and libs from
 158         <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
 159         <filename>-lgstrtsp-&GST_MAJORMINOR;</filename> to the library flags.
 160       </para>
 161       <xi:include href="xml/gstrtspbase64.xml" />
 162       <xi:include href="xml/gstrtspconnection.xml" />
 163       <xi:include href="xml/gstrtspdefs.xml" />
 164       <xi:include href="xml/gstrtspextension.xml" />
 165       <xi:include href="xml/gstrtspmessage.xml" />
 166       <xi:include href="xml/gstrtsprange.xml" />
 167       <xi:include href="xml/gstrtsptransport.xml" />
 168       <xi:include href="xml/gstrtspurl.xml" />
 169     </chapter>
 170
 171     <chapter id="gstreamer-sdp">
 172       <title>SDP Library</title>
 173       <para>
 174         This library should be linked to by getting cflags and libs from
 175         <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
 176         <filename>-lgstsdp-&GST_MAJORMINOR;</filename> to the library flags.
 177       </para>
 178       <xi:include href="xml/gstsdpmessage.xml" />
 179     </chapter>
 180
 181     <chapter id="gstreamer-tag">
 182       <title>Tag Support Library</title>
 183       <para>
 184         This library should be linked to by getting cflags and libs from
 185         <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
 186         <filename>-lgsttag-&GST_MAJORMINOR;</filename> to the library flags.
 187       </para>
 188       <xi:include href="xml/gsttag.xml" />
 189       <xi:include href="xml/gsttagvorbis.xml" />
 190       <xi:include href="xml/gsttagid3.xml" />
 191       <xi:include href="xml/gsttagexif.xml" />
 192       <xi:include href="xml/gsttagxmp.xml" />
 193       <xi:include href="xml/gsttagxmpwriter.xml" />
 194       <xi:include href="xml/gsttagdemux.xml" />
 195       <xi:include href="xml/gsttagmux.xml" />
 196       <xi:include href="xml/gsttaglanguagecodes.xml" />
 197       <xi:include href="xml/gsttaglicenses.xml" />
 198     </chapter>
 199
 200     <chapter id="gstreamer-base-utils">
 201       <title>Base Utils Library</title>
 202       <para>
 203         This library should be linked to by getting cflags and libs from
 204         <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
 205         <filename>-lgstpbutils-&GST_MAJORMINOR;</filename> to the library
 206         flags.
 207       </para>
 208       <xi:include href="xml/gstpbutils.xml" />
 209       <xi:include href="xml/gstpluginsbaseversion.xml" />
 210       <xi:include href="xml/gstpbutilscodecutils.xml" />
 211       <xi:include href="xml/gstpbutilsdescriptions.xml" />
 212       <xi:include href="xml/gstpbutilsmissingplugins.xml" />
 213       <xi:include href="xml/gstpbutilsinstallplugins.xml" />
 214       <xi:include href="xml/gstdiscoverer.xml" />
 215       <xi:include href="xml/encoding-profile.xml" />
 216     </chapter>
 217
 218     <chapter id="gstreamer-video">
 219       <title>Video Library</title>
 220       <para>
 221         This library should be linked to by getting cflags and libs from
 222         <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
 223         <filename>-lgstvideo-&GST_MAJORMINOR;</filename> to the library flags.
 224       </para>
 225       <xi:include href="xml/gstvideo.xml" />
 226       <xi:include href="xml/gstvideofilter.xml" />
 227       <xi:include href="xml/gstvideosink.xml" />
 228     </chapter>
 229   </part>
 230
 231   <part id="gstreamer-libs-hierarchy">
 232     <title>Object Hierarchy</title>
 233     <xi:include href="xml/tree_index.sgml" />
 234   </part>
 235
 236   <index id="api-index-full">
 237     <title>Index</title>
 238     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 239   </index>
 240   <index id="api-index-deprecated" role="deprecated">
 241     <title>Index of deprecated API</title>
 242     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 243   </index>
 244
 245   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 246 </book>