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-allocators">
  25       <title>Allocators 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>-lgstallocators-&GST_API_VERSION;</filename> to the library flags.
  30       </para>
  31       <xi:include href="xml/gstdmabuf.xml" />
  32       <xi:include href="xml/gstfdmemory.xml" />
  33       <xi:include href="xml/gstphysmemoryallocator.xml" />
  34     </chapter>
  35
  36     <chapter id="gstreamer-app">
  37       <title>App Library</title>
  38       <para>
  39         This library should be linked to by getting cflags and libs from
  40         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
  41         <filename>-lgstapp-&GST_API_VERSION;</filename> to the library flags.
  42       </para>
  43       <para>
  44       To use it the functionality, insert an appsrc or appsink element into a pipeline and call the appropriate functions on the element.
  45       </para>
  46       <xi:include href="xml/gstappsrc.xml" />
  47       <xi:include href="xml/gstappsink.xml" />
  48     </chapter>
  49
  50     <chapter id="gstreamer-audio">
  51       <title>Audio Library</title>
  52       <para>
  53         This library should be linked to by getting cflags and libs from
  54         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
  55         <filename>-lgstaudio-&GST_API_VERSION;</filename> to the library flags.
  56       </para>
  57       <xi:include href="xml/gstaudio.xml" />
  58       <xi:include href="xml/gstaudiometa.xml" />
  59       <xi:include href="xml/gstaudioaggregator.xml" />
  60       <xi:include href="xml/gstaudiocdsrc.xml" />
  61       <xi:include href="xml/gstaudioclock.xml" />
  62       <xi:include href="xml/gstaudiodecoder.xml" />
  63       <xi:include href="xml/gstaudioencoder.xml" />
  64       <xi:include href="xml/gstaudiofilter.xml" />
  65       <xi:include href="xml/gstaudiosink.xml" />
  66       <xi:include href="xml/gstaudiosrc.xml" />
  67       <xi:include href="xml/gstaudiobasesink.xml" />
  68       <xi:include href="xml/gstaudiobasesrc.xml" />
  69       <xi:include href="xml/gstaudiochannels.xml" />
  70       <xi:include href="xml/gstaudioconverter.xml" />
  71       <xi:include href="xml/gstaudioquantize.xml" />
  72       <xi:include href="xml/gstaudioringbuffer.xml" />
  73       <xi:include href="xml/gstaudioiec61937.xml" />
  74       <xi:include href="xml/gststreamvolume.xml" />
  75     </chapter>
  76
  77     <chapter id="gstreamer-ffft">
  78       <title>FFT Library</title>
  79       <para>
  80         The gstfft library is based on
  81         <ulink role="online-location" url="http://sourceforge.net/projects/kissfft">kissfft</ulink>
  82         by Mark Borgerding.
  83       </para>
  84       <para>
  85         This library should be linked to by getting cflags and libs from
  86         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
  87         <filename>-lgstfft-&GST_API_VERSION;</filename> to the library flags.
  88       </para>
  89       <xi:include href="xml/gstfft.xml" />
  90       <xi:include href="xml/gstffts16.xml" />
  91       <xi:include href="xml/gstffts32.xml" />
  92       <xi:include href="xml/gstfftf32.xml" />
  93       <xi:include href="xml/gstfftf64.xml" />
  94     </chapter>
  95
  96     <chapter id="gstreamer-riff">
  97       <title>Riff Media Library</title>
  98       <para>
  99         This library should be linked to by getting cflags and libs from
 100         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 101         <filename>-lgstriff-&GST_API_VERSION;</filename> to the library flags.
 102       </para>
 103       <xi:include href="xml/gstriff.xml" />
 104     </chapter>
 105
 106     <chapter id="gstreamer-rtp">
 107       <title>RTP Library</title>
 108       <para>
 109         This library should be linked to by getting cflags and libs from
 110         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 111         <filename>-lgstrtp-&GST_API_VERSION;</filename> to the library flags.
 112       </para>
 113       <xi:include href="xml/gstrtpbaseaudiopayload.xml" />
 114       <xi:include href="xml/gstrtpbasedepayload.xml" />
 115       <xi:include href="xml/gstrtpbasepayload.xml" />
 116       <xi:include href="xml/gstrtpbuffer.xml" />
 117       <xi:include href="xml/gstrtcpbuffer.xml" />
 118       <xi:include href="xml/gstrtppayloads.xml" />
 119       <xi:include href="xml/gstrtphdrext.xml" />
 120       <xi:include href="xml/gstrtpdefs.xml" />
 121     </chapter>
 122
 123     <chapter id="gstreamer-rtsp">
 124       <title>RTSP 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>-lgstrtsp-&GST_API_VERSION;</filename> to the library flags.
 129       </para>
 130       <xi:include href="xml/gstrtspconnection.xml" />
 131       <xi:include href="xml/gstrtspdefs.xml" />
 132       <xi:include href="xml/gstrtspextension.xml" />
 133       <xi:include href="xml/gstrtspmessage.xml" />
 134       <xi:include href="xml/gstrtsprange.xml" />
 135       <xi:include href="xml/gstrtsptransport.xml" />
 136       <xi:include href="xml/gstrtspurl.xml" />
 137     </chapter>
 138
 139     <chapter id="gstreamer-sdp">
 140       <title>SDP Library</title>
 141       <para>
 142         This library should be linked to by getting cflags and libs from
 143         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 144         <filename>-lgstsdp-&GST_API_VERSION;</filename> to the library flags.
 145       </para>
 146       <xi:include href="xml/gstsdpmessage.xml" />
 147     </chapter>
 148
 149     <chapter id="gstreamer-mikey">
 150       <title>MIKEY Library</title>
 151       <para>
 152         This library should be linked to by getting cflags and libs from
 153         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 154         <filename>-lgstsdp-&GST_API_VERSION;</filename> to the library flags.
 155       </para>
 156       <xi:include href="xml/gstmikey.xml" />
 157     </chapter>
 158
 159     <chapter id="gstreamer-tag">
 160       <title>Tag Support Library</title>
 161       <para>
 162         This library should be linked to by getting cflags and libs from
 163         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 164         <filename>-lgsttag-&GST_API_VERSION;</filename> to the library flags.
 165       </para>
 166       <xi:include href="xml/gsttag.xml" />
 167       <xi:include href="xml/gsttagvorbis.xml" />
 168       <xi:include href="xml/gsttagid3.xml" />
 169       <xi:include href="xml/gsttagexif.xml" />
 170       <xi:include href="xml/gsttagxmp.xml" />
 171       <xi:include href="xml/gsttagxmpwriter.xml" />
 172       <xi:include href="xml/gsttagdemux.xml" />
 173       <xi:include href="xml/gsttagmux.xml" />
 174       <xi:include href="xml/gsttaglanguagecodes.xml" />
 175       <xi:include href="xml/gsttaglicenses.xml" />
 176     </chapter>
 177
 178     <chapter id="gstreamer-base-utils">
 179       <title>Base Utils Library</title>
 180       <para>
 181         This library should be linked to by getting cflags and libs from
 182         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 183         <filename>-lgstpbutils-&GST_API_VERSION;</filename> to the library
 184         flags.
 185       </para>
 186       <xi:include href="xml/gstpbutils.xml" />
 187       <xi:include href="xml/gstpluginsbaseversion.xml" />
 188       <xi:include href="xml/gstpbutilscodecutils.xml" />
 189       <xi:include href="xml/gstpbutilsdescriptions.xml" />
 190       <xi:include href="xml/gstpbutilsmissingplugins.xml" />
 191       <xi:include href="xml/gstpbutilsinstallplugins.xml" />
 192       <xi:include href="xml/gstdiscoverer.xml" />
 193       <xi:include href="xml/encoding-profile.xml" />
 194       <xi:include href="xml/gstaudiovisualizer.xml" />
 195     </chapter>
 196
 197     <chapter id="gstreamer-video">
 198       <title>Video Library</title>
 199       <para>
 200         This library should be linked to by getting cflags and libs from
 201         <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
 202         <filename>-lgstvideo-&GST_API_VERSION;</filename> to the library flags.
 203       </para>
 204       <xi:include href="xml/gstvideo.xml" />
 205       <xi:include href="xml/gstvideometa.xml" />
 206       <xi:include href="xml/gstvideoaffinetransformationmeta.xml" />
 207       <xi:include href="xml/gstvideooverlaycomposition.xml" />
 208       <xi:include href="xml/gstvideofilter.xml" />
 209       <xi:include href="xml/gstvideodither.xml" />
 210       <xi:include href="xml/gstvideochroma.xml" />
 211       <xi:include href="xml/gstvideoresampler.xml" />
 212       <xi:include href="xml/gstvideoscaler.xml" />
 213       <xi:include href="xml/gstvideosink.xml" />
 214       <xi:include href="xml/gstcolorbalance.xml" />
 215       <xi:include href="xml/gstcolorbalancechannel.xml" />
 216       <xi:include href="xml/gstvideodirection.xml" />
 217       <xi:include href="xml/gstvideoorientation.xml" />
 218       <xi:include href="xml/gstvideooverlay.xml" />
 219       <xi:include href="xml/gstvideodecoder.xml" />
 220       <xi:include href="xml/gstvideoencoder.xml" />
 221       <xi:include href="xml/gstvideopool.xml" />
 222       <xi:include href="xml/gstvideoutils.xml" />
 223       <xi:include href="xml/gstnavigation.xml" />
 224       <xi:include href="xml/gstvideoanc.xml" />
 225     </chapter>
 226
 227     <chapter id="gl">
 228       <title>OpenGL Integration Library</title>
 229       <para>
 230         This library should be linked to by getting cflags and libs from
 231         <filename>gstreamer-gl-&GST_API_VERSION;.pc</filename>
 232       </para>
 233       <xi:include href="xml/gstglapi.xml"/>
 234       <xi:include href="xml/gstglbasefilter.xml"/>
 235       <xi:include href="xml/gstglbasememory.xml"/>
 236       <xi:include href="xml/gstglbuffer.xml"/>
 237       <xi:include href="xml/gstglbufferpool.xml"/>
 238       <xi:include href="xml/gstglcolorconvert.xml"/>
 239       <xi:include href="xml/gstglcontext.xml"/>
 240       <!-- Not exposed as public API
 241       <xi:include href="xml/gstglcontextegl.xml"/>
 242       -->
 243       <xi:include href="xml/gstgldisplay.xml"/>
 244       <xi:include href="xml/gstgldisplaycocoa.xml"/>
 245       <xi:include href="xml/gstgldisplayegl.xml"/>
 246       <xi:include href="xml/gstgldisplaywayland.xml"/>
 247       <xi:include href="xml/gstgldisplayx11.xml"/>
 248       <xi:include href="xml/gsteglimage.xml"/>
 249       <xi:include href="xml/gstglfilter.xml"/>
 250       <xi:include href="xml/gstglframebuffer.xml"/>
 251       <xi:include href="xml/gstglmemory.xml"/>
 252       <xi:include href="xml/gstglmemoryegl.xml"/>
 253       <xi:include href="xml/gstglmemorypbo.xml"/>
 254       <xi:include href="xml/gstgloverlaycompositor.xml"/>
 255       <xi:include href="xml/gstglquery.xml"/>
 256       <xi:include href="xml/gstglrenderbuffer.xml"/>
 257       <xi:include href="xml/gstglshader.xml"/>
 258       <xi:include href="xml/gstglsl.xml"/>
 259       <xi:include href="xml/gstglslstage.xml"/>
 260       <xi:include href="xml/gstglsyncmeta.xml"/>
 261       <xi:include href="xml/gstglupload.xml"/>
 262       <xi:include href="xml/gstglviewconvert.xml"/>
 263       <xi:include href="xml/gstglwindow.xml"/>
 264       <!-- Some utilities -->
 265       <xi:include href="xml/gstgldebug.xml"/>
 266       <xi:include href="xml/gstglformat.xml"/>
 267       <xi:include href="xml/gstglutils.xml"/>
 268     </chapter>
 269
 270   </part>
 271
 272   <part id="gstreamer-libs-hierarchy">
 273     <title>Object Hierarchy</title>
 274     <xi:include href="xml/tree_index.sgml" />
 275   </part>
 276
 277   <index id="api-index-full">
 278     <title>Index</title>
 279     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 280   </index>
 281   <index id="api-index-deprecated" role="deprecated">
 282     <title>Index of deprecated API</title>
 283     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 284   </index>
 285   <index>
 286     <title>Index of new API in 1.16</title>
 287     <xi:include href="xml/api-index-1.16.xml"><xi:fallback /></xi:include>
 288   </index>
 289   <index>
 290     <title>Index of new API in 1.14</title>
 291     <xi:include href="xml/api-index-1.14.xml"><xi:fallback /></xi:include>
 292   </index>
 293   <index>
 294     <title>Index of new API in 1.12</title>
 295     <xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include>
 296   </index>
 297   <index>
 298     <title>Index of new API in 1.10</title>
 299     <xi:include href="xml/api-index-1.10.xml"><xi:fallback /></xi:include>
 300   </index>
 301   <index>
 302     <title>Index of new API in 1.8.1</title>
 303     <xi:include href="xml/api-index-1.8.1.xml"><xi:fallback /></xi:include>
 304   </index>
 305   <index>
 306     <title>Index of new API in 1.8</title>
 307     <xi:include href="xml/api-index-1.8.xml"><xi:fallback /></xi:include>
 308   </index>
 309   <index>
 310     <title>Index of new API in 1.6.1</title>
 311     <xi:include href="xml/api-index-1.6.1.xml"><xi:fallback /></xi:include>
 312   </index>
 313   <index>
 314     <title>Index of new API in 1.6</title>
 315     <xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include>
 316   </index>
 317   <index>
 318     <title>Index of new API in 1.4</title>
 319     <xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include>
 320   </index>
 321   <index>
 322     <title>Index of new API in 1.2.2</title>
 323     <xi:include href="xml/api-index-1.2.2.xml"><xi:fallback /></xi:include>
 324   </index>
 325   <index>
 326     <title>Index of new API in 1.2.1</title>
 327     <xi:include href="xml/api-index-1.2.1.xml"><xi:fallback /></xi:include>
 328   </index>
 329   <index>
 330     <title>Index of new API in 1.2</title>
 331     <xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
 332   </index>
 333   <index>
 334     <title>Index of new API in 1.0.3</title>
 335     <xi:include href="xml/api-index-1.0.3.xml"><xi:fallback /></xi:include>
 336   </index>
 337
 338   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 339 </book>