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