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