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/gstrtpmeta.xml" /> 114 <xi:include href="xml/gstrtpbaseaudiopayload.xml" /> 115 <xi:include href="xml/gstrtpbasedepayload.xml" /> 116 <xi:include href="xml/gstrtpbasepayload.xml" /> 117 <xi:include href="xml/gstrtpbuffer.xml" /> 118 <xi:include href="xml/gstrtcpbuffer.xml" /> 119 <xi:include href="xml/gstrtppayloads.xml" /> 120 <xi:include href="xml/gstrtphdrext.xml" /> 121 <xi:include href="xml/gstrtpdefs.xml" /> 122 </chapter> 123 124 <chapter id="gstreamer-rtsp"> 125 <title>RTSP Library</title> 126 <para> 127 This library should be linked to by getting cflags and libs from 128 <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding 129 <filename>-lgstrtsp-&GST_API_VERSION;</filename> to the library flags. 130 </para> 131 <xi:include href="xml/gstrtspconnection.xml" /> 132 <xi:include href="xml/gstrtspdefs.xml" /> 133 <xi:include href="xml/gstrtspextension.xml" /> 134 <xi:include href="xml/gstrtspmessage.xml" /> 135 <xi:include href="xml/gstrtsprange.xml" /> 136 <xi:include href="xml/gstrtsptransport.xml" /> 137 <xi:include href="xml/gstrtspurl.xml" /> 138 </chapter> 139 140 <chapter id="gstreamer-sdp"> 141 <title>SDP Library</title> 142 <para> 143 This library should be linked to by getting cflags and libs from 144 <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding 145 <filename>-lgstsdp-&GST_API_VERSION;</filename> to the library flags. 146 </para> 147 <xi:include href="xml/gstsdpmessage.xml" /> 148 </chapter> 149 150 <chapter id="gstreamer-mikey"> 151 <title>MIKEY Library</title> 152 <para> 153 This library should be linked to by getting cflags and libs from 154 <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding 155 <filename>-lgstsdp-&GST_API_VERSION;</filename> to the library flags. 156 </para> 157 <xi:include href="xml/gstmikey.xml" /> 158 </chapter> 159 160 <chapter id="gstreamer-tag"> 161 <title>Tag Support Library</title> 162 <para> 163 This library should be linked to by getting cflags and libs from 164 <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding 165 <filename>-lgsttag-&GST_API_VERSION;</filename> to the library flags. 166 </para> 167 <xi:include href="xml/gsttag.xml" /> 168 <xi:include href="xml/gsttagvorbis.xml" /> 169 <xi:include href="xml/gsttagid3.xml" /> 170 <xi:include href="xml/gsttagexif.xml" /> 171 <xi:include href="xml/gsttagxmp.xml" /> 172 <xi:include href="xml/gsttagxmpwriter.xml" /> 173 <xi:include href="xml/gsttagdemux.xml" /> 174 <xi:include href="xml/gsttagmux.xml" /> 175 <xi:include href="xml/gsttaglanguagecodes.xml" /> 176 <xi:include href="xml/gsttaglicenses.xml" /> 177 </chapter> 178 179 <chapter id="gstreamer-base-utils"> 180 <title>Base Utils Library</title> 181 <para> 182 This library should be linked to by getting cflags and libs from 183 <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding 184 <filename>-lgstpbutils-&GST_API_VERSION;</filename> to the library 185 flags. 186 </para> 187 <xi:include href="xml/gstpbutils.xml" /> 188 <xi:include href="xml/gstpluginsbaseversion.xml" /> 189 <xi:include href="xml/gstpbutilscodecutils.xml" /> 190 <xi:include href="xml/gstpbutilsdescriptions.xml" /> 191 <xi:include href="xml/gstpbutilsmissingplugins.xml" /> 192 <xi:include href="xml/gstpbutilsinstallplugins.xml" /> 193 <xi:include href="xml/gstdiscoverer.xml" /> 194 <xi:include href="xml/encoding-profile.xml" /> 195 <xi:include href="xml/gstaudiovisualizer.xml" /> 196 </chapter> 197 198 <chapter id="gstreamer-video"> 199 <title>Video Library</title> 200 <para> 201 This library should be linked to by getting cflags and libs from 202 <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding 203 <filename>-lgstvideo-&GST_API_VERSION;</filename> to the library flags. 204 </para> 205 <xi:include href="xml/gstvideo.xml" /> 206 <xi:include href="xml/gstvideometa.xml" /> 207 <xi:include href="xml/gstvideoaffinetransformationmeta.xml" /> 208 <xi:include href="xml/gstvideoaggregator.xml" /> 209 <xi:include href="xml/gstvideoaggregatorpad.xml" /> 210 <xi:include href="xml/gstvideooverlaycomposition.xml" /> 211 <xi:include href="xml/gstvideofilter.xml" /> 212 <xi:include href="xml/gstvideodither.xml" /> 213 <xi:include href="xml/gstvideochroma.xml" /> 214 <xi:include href="xml/gstvideoresampler.xml" /> 215 <xi:include href="xml/gstvideoscaler.xml" /> 216 <xi:include href="xml/gstvideosink.xml" /> 217 <xi:include href="xml/gstcolorbalance.xml" /> 218 <xi:include href="xml/gstcolorbalancechannel.xml" /> 219 <xi:include href="xml/gstvideodirection.xml" /> 220 <xi:include href="xml/gstvideoorientation.xml" /> 221 <xi:include href="xml/gstvideooverlay.xml" /> 222 <xi:include href="xml/gstvideodecoder.xml" /> 223 <xi:include href="xml/gstvideoencoder.xml" /> 224 <xi:include href="xml/gstvideopool.xml" /> 225 <xi:include href="xml/gstvideoutils.xml" /> 226 <xi:include href="xml/gstnavigation.xml" /> 227 <xi:include href="xml/gstvideoanc.xml" /> 228 </chapter> 229 230 <chapter id="gl"> 231 <title>OpenGL Integration Library</title> 232 <para> 233 This library should be linked to by getting cflags and libs from 234 <filename>gstreamer-gl-&GST_API_VERSION;.pc</filename> 235 </para> 236 <xi:include href="xml/gstglapi.xml"/> 237 <xi:include href="xml/gstglbasefilter.xml"/> 238 <xi:include href="xml/gstglbasememory.xml"/> 239 <xi:include href="xml/gstglbuffer.xml"/> 240 <xi:include href="xml/gstglbufferpool.xml"/> 241 <xi:include href="xml/gstglcolorconvert.xml"/> 242 <xi:include href="xml/gstglcontext.xml"/> 243 <!-- Not exposed as public API 244 <xi:include href="xml/gstglcontextegl.xml"/> 245 --> 246 <xi:include href="xml/gstgldisplay.xml"/> 247 <xi:include href="xml/gstgldisplaycocoa.xml"/> 248 <xi:include href="xml/gstgldisplayegl.xml"/> 249 <xi:include href="xml/gstgldisplaywayland.xml"/> 250 <xi:include href="xml/gstgldisplayx11.xml"/> 251 <xi:include href="xml/gsteglimage.xml"/> 252 <xi:include href="xml/gstglfilter.xml"/> 253 <xi:include href="xml/gstglframebuffer.xml"/> 254 <xi:include href="xml/gstglmemory.xml"/> 255 <xi:include href="xml/gstglmemoryegl.xml"/> 256 <xi:include href="xml/gstglmemorypbo.xml"/> 257 <xi:include href="xml/gstgloverlaycompositor.xml"/> 258 <xi:include href="xml/gstglquery.xml"/> 259 <xi:include href="xml/gstglrenderbuffer.xml"/> 260 <xi:include href="xml/gstglshader.xml"/> 261 <xi:include href="xml/gstglsl.xml"/> 262 <xi:include href="xml/gstglslstage.xml"/> 263 <xi:include href="xml/gstglsyncmeta.xml"/> 264 <xi:include href="xml/gstglupload.xml"/> 265 <xi:include href="xml/gstglviewconvert.xml"/> 266 <xi:include href="xml/gstglwindow.xml"/> 267 <!-- Some utilities --> 268 <xi:include href="xml/gstgldebug.xml"/> 269 <xi:include href="xml/gstglformat.xml"/> 270 <xi:include href="xml/gstglutils.xml"/> 271 </chapter> 272 273 </part> 274 275 <part id="gstreamer-libs-hierarchy"> 276 <title>Object Hierarchy</title> 277 <xi:include href="xml/tree_index.sgml" /> 278 </part> 279 280 <index id="api-index-full"> 281 <title>Index</title> 282 <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> 283 </index> 284 <index id="api-index-deprecated" role="deprecated"> 285 <title>Index of deprecated API</title> 286 <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> 287 </index> 288 <index> 289 <title>Index of new API in 1.16</title> 290 <xi:include href="xml/api-index-1.16.xml"><xi:fallback /></xi:include> 291 </index> 292 <index> 293 <title>Index of new API in 1.14</title> 294 <xi:include href="xml/api-index-1.14.xml"><xi:fallback /></xi:include> 295 </index> 296 <index> 297 <title>Index of new API in 1.12</title> 298 <xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include> 299 </index> 300 <index> 301 <title>Index of new API in 1.10</title> 302 <xi:include href="xml/api-index-1.10.xml"><xi:fallback /></xi:include> 303 </index> 304 <index> 305 <title>Index of new API in 1.8.1</title> 306 <xi:include href="xml/api-index-1.8.1.xml"><xi:fallback /></xi:include> 307 </index> 308 <index> 309 <title>Index of new API in 1.8</title> 310 <xi:include href="xml/api-index-1.8.xml"><xi:fallback /></xi:include> 311 </index> 312 <index> 313 <title>Index of new API in 1.6.1</title> 314 <xi:include href="xml/api-index-1.6.1.xml"><xi:fallback /></xi:include> 315 </index> 316 <index> 317 <title>Index of new API in 1.6</title> 318 <xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include> 319 </index> 320 <index> 321 <title>Index of new API in 1.4</title> 322 <xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include> 323 </index> 324 <index> 325 <title>Index of new API in 1.2.2</title> 326 <xi:include href="xml/api-index-1.2.2.xml"><xi:fallback /></xi:include> 327 </index> 328 <index> 329 <title>Index of new API in 1.2.1</title> 330 <xi:include href="xml/api-index-1.2.1.xml"><xi:fallback /></xi:include> 331 </index> 332 <index> 333 <title>Index of new API in 1.2</title> 334 <xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include> 335 </index> 336 <index> 337 <title>Index of new API in 1.0.3</title> 338 <xi:include href="xml/api-index-1.0.3.xml"><xi:fallback /></xi:include> 339 </index> 340 341 <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> 342</book> 343