gst-plugins-base-libs-docs.sgml 12.6 KB
Newer Older
1
<?xml version="1.0"?>
2
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
4
5
6
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
]>
7
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
8
  <bookinfo>
Sebastian Dröge's avatar
Sebastian Dröge committed
9
    <title>GStreamer Base Plugins &GST_API_VERSION; Library Reference Manual</title>
10
    <releaseinfo>
Sebastian Dröge's avatar
Sebastian Dröge committed
11
      for GStreamer Base Library &GST_API_VERSION; (&GST_VERSION;)
12
13
      <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>.
    </releaseinfo>
14
15
  </bookinfo>

16
  <part id="gstreamer-plugins-base">
17
18
    <title>GStreamer Base Plugins Libraries</title>
    <para>
19
20
      This manual describes the libraries provided by the GStreamer Base Plugins
      package.
21
    </para>
Stefan Kost's avatar
Stefan Kost committed
22
    <xi:include href="compiling.sgml" />
23

24
25
26
27
28
29
30
31
    <chapter id="gstreamer-allocators">
      <title>Allocators Library</title>
      <para>
        This library should be linked to by getting cflags and libs from
        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstallocators-&GST_API_VERSION;</filename> to the library flags.
      </para>
      <xi:include href="xml/gstdmabuf.xml" />
Stefan Sauer's avatar
Stefan Sauer committed
32
      <xi:include href="xml/gstfdmemory.xml" />
33
34
    </chapter>

35
36
37
38
    <chapter id="gstreamer-app">
      <title>App Library</title>
      <para>
        This library should be linked to by getting cflags and libs from
Sebastian Dröge's avatar
Sebastian Dröge committed
39
40
        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstapp-&GST_API_VERSION;</filename> to the library flags.
41
42
43
44
      </para>
      <para>
      To use it the functionality, insert an appsrc or appsink element into a pipeline and call the appropriate functions on the element.
      </para>
45
46
      <xi:include href="xml/gstappsrc.xml" />
      <xi:include href="xml/gstappsink.xml" />
47
48
    </chapter>

49
50
51
52
    <chapter id="gstreamer-audio">
      <title>Audio Library</title>
      <para>
        This library should be linked to by getting cflags and libs from
Sebastian Dröge's avatar
Sebastian Dröge committed
53
54
        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstaudio-&GST_API_VERSION;</filename> to the library flags.
55
      </para>
56
      <xi:include href="xml/gstaudio.xml" />
57
      <xi:include href="xml/gstaudiometa.xml" />
58
      <xi:include href="xml/gstaudioaggregator.xml" />
59
      <xi:include href="xml/gstaudiocdsrc.xml" />
60
      <xi:include href="xml/gstaudioclock.xml" />
61
62
      <xi:include href="xml/gstaudiodecoder.xml" />
      <xi:include href="xml/gstaudioencoder.xml" />
63
64
65
      <xi:include href="xml/gstaudiofilter.xml" />
      <xi:include href="xml/gstaudiosink.xml" />
      <xi:include href="xml/gstaudiosrc.xml" />
66
67
      <xi:include href="xml/gstaudiobasesink.xml" />
      <xi:include href="xml/gstaudiobasesrc.xml" />
68
      <xi:include href="xml/gstaudiochannels.xml" />
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
69
70
      <xi:include href="xml/gstaudioconverter.xml" />
      <xi:include href="xml/gstaudioquantize.xml" />
71
      <xi:include href="xml/gstaudioringbuffer.xml" />
72
      <xi:include href="xml/gstaudioiec61937.xml" />
73
      <xi:include href="xml/gststreamvolume.xml" />
74
    </chapter>
75

76
77
    <chapter id="gstreamer-ffft">
      <title>FFT Library</title>
78
79
80
81
82
      <para>
        The gstfft library is based on
        <ulink role="online-location" url="http://sourceforge.net/projects/kissfft">kissfft</ulink>
        by Mark Borgerding.
      </para>
83
84
      <para>
        This library should be linked to by getting cflags and libs from
Sebastian Dröge's avatar
Sebastian Dröge committed
85
86
        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstfft-&GST_API_VERSION;</filename> to the library flags.
87
      </para>
88
89
90
91
92
      <xi:include href="xml/gstfft.xml" />
      <xi:include href="xml/gstffts16.xml" />
      <xi:include href="xml/gstffts32.xml" />
      <xi:include href="xml/gstfftf32.xml" />
      <xi:include href="xml/gstfftf64.xml" />
93
94
    </chapter>

95
96
97
98
    <chapter id="gstreamer-riff">
      <title>Riff Media Library</title>
      <para>
        This library should be linked to by getting cflags and libs from
Sebastian Dröge's avatar
Sebastian Dröge committed
99
100
        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstriff-&GST_API_VERSION;</filename> to the library flags.
101
      </para>
102
      <xi:include href="xml/gstriff.xml" />
103
104
105
    </chapter>

    <chapter id="gstreamer-rtp">
Wim Taymans's avatar
Wim Taymans committed
106
      <title>RTP Library</title>
107
108
      <para>
        This library should be linked to by getting cflags and libs from
Sebastian Dröge's avatar
Sebastian Dröge committed
109
110
        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstrtp-&GST_API_VERSION;</filename> to the library flags.
111
      </para>
112
113
114
      <xi:include href="xml/gstrtpbaseaudiopayload.xml" />
      <xi:include href="xml/gstrtpbasedepayload.xml" />
      <xi:include href="xml/gstrtpbasepayload.xml" />
115
116
117
      <xi:include href="xml/gstrtpbuffer.xml" />
      <xi:include href="xml/gstrtcpbuffer.xml" />
      <xi:include href="xml/gstrtppayloads.xml" />
118
      <xi:include href="xml/gstrtphdrext.xml" />
119
120
    </chapter>

121
122
123
124
    <chapter id="gstreamer-rtsp">
      <title>RTSP Library</title>
      <para>
        This library should be linked to by getting cflags and libs from
Sebastian Dröge's avatar
Sebastian Dröge committed
125
126
        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstrtsp-&GST_API_VERSION;</filename> to the library flags.
127
      </para>
128
129
      <xi:include href="xml/gstrtspconnection.xml" />
      <xi:include href="xml/gstrtspdefs.xml" />
130
      <xi:include href="xml/gstrtspextension.xml" />
131
132
133
134
      <xi:include href="xml/gstrtspmessage.xml" />
      <xi:include href="xml/gstrtsprange.xml" />
      <xi:include href="xml/gstrtsptransport.xml" />
      <xi:include href="xml/gstrtspurl.xml" />
135
136
137
    </chapter>

    <chapter id="gstreamer-sdp">
Wim Taymans's avatar
Wim Taymans committed
138
139
140
      <title>SDP Library</title>
      <para>
        This library should be linked to by getting cflags and libs from
Sebastian Dröge's avatar
Sebastian Dröge committed
141
142
        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstsdp-&GST_API_VERSION;</filename> to the library flags.
Wim Taymans's avatar
Wim Taymans committed
143
      </para>
144
      <xi:include href="xml/gstsdpmessage.xml" />
Wim Taymans's avatar
Wim Taymans committed
145
146
    </chapter>

Wim Taymans's avatar
Wim Taymans committed
147
148
149
150
151
152
153
154
155
156
    <chapter id="gstreamer-mikey">
      <title>MIKEY Library</title>
      <para>
        This library should be linked to by getting cflags and libs from
        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstsdp-&GST_API_VERSION;</filename> to the library flags.
      </para>
      <xi:include href="xml/gstmikey.xml" />
    </chapter>

157
158
159
160
    <chapter id="gstreamer-tag">
      <title>Tag Support Library</title>
      <para>
        This library should be linked to by getting cflags and libs from
Sebastian Dröge's avatar
Sebastian Dröge committed
161
162
        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgsttag-&GST_API_VERSION;</filename> to the library flags.
163
      </para>
164
165
166
      <xi:include href="xml/gsttag.xml" />
      <xi:include href="xml/gsttagvorbis.xml" />
      <xi:include href="xml/gsttagid3.xml" />
167
      <xi:include href="xml/gsttagexif.xml" />
168
      <xi:include href="xml/gsttagxmp.xml" />
Stefan Kost's avatar
Stefan Kost committed
169
      <xi:include href="xml/gsttagxmpwriter.xml" />
170
      <xi:include href="xml/gsttagdemux.xml" />
171
      <xi:include href="xml/gsttagmux.xml" />
172
      <xi:include href="xml/gsttaglanguagecodes.xml" />
173
      <xi:include href="xml/gsttaglicenses.xml" />
174
    </chapter>
175

176
177
178
179
    <chapter id="gstreamer-base-utils">
      <title>Base Utils Library</title>
      <para>
        This library should be linked to by getting cflags and libs from
Sebastian Dröge's avatar
Sebastian Dröge committed
180
181
        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstpbutils-&GST_API_VERSION;</filename> to the library
182
183
        flags.
      </para>
184
      <xi:include href="xml/gstpbutils.xml" />
185
      <xi:include href="xml/gstpluginsbaseversion.xml" />
186
      <xi:include href="xml/gstpbutilscodecutils.xml" />
187
188
189
      <xi:include href="xml/gstpbutilsdescriptions.xml" />
      <xi:include href="xml/gstpbutilsmissingplugins.xml" />
      <xi:include href="xml/gstpbutilsinstallplugins.xml" />
190
      <xi:include href="xml/gstdiscoverer.xml" />
Edward Hervey's avatar
Edward Hervey committed
191
      <xi:include href="xml/encoding-profile.xml" />
192
193
    </chapter>

194
195
196
197
    <chapter id="gstreamer-video">
      <title>Video Library</title>
      <para>
        This library should be linked to by getting cflags and libs from
Sebastian Dröge's avatar
Sebastian Dröge committed
198
199
        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstvideo-&GST_API_VERSION;</filename> to the library flags.
200
      </para>
201
      <xi:include href="xml/gstvideo.xml" />
202
      <xi:include href="xml/gstvideometa.xml" />
203
      <xi:include href="xml/gstvideoaffinetransformationmeta.xml" />
204
      <xi:include href="xml/gstvideooverlaycomposition.xml" />
205
      <xi:include href="xml/gstvideofilter.xml" />
206
207
208
209
      <xi:include href="xml/gstvideodither.xml" />
      <xi:include href="xml/gstvideochroma.xml" />
      <xi:include href="xml/gstvideoresampler.xml" />
      <xi:include href="xml/gstvideoscaler.xml" />
210
      <xi:include href="xml/gstvideosink.xml" />
211
212
      <xi:include href="xml/gstcolorbalance.xml" />
      <xi:include href="xml/gstcolorbalancechannel.xml" />
213
      <xi:include href="xml/gstvideodirection.xml" />
214
215
      <xi:include href="xml/gstvideoorientation.xml" />
      <xi:include href="xml/gstvideooverlay.xml" />
216
217
      <xi:include href="xml/gstvideodecoder.xml" />
      <xi:include href="xml/gstvideoencoder.xml" />
218
      <xi:include href="xml/gstvideopool.xml" />
219
      <xi:include href="xml/gstvideoutils.xml" />
220
      <xi:include href="xml/gstnavigation.xml" />
221
    </chapter>
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280

    <chapter id="gl">
      <title>OpenGL Integration Library</title>
      <para>
        This library should be linked to by getting cflags and libs from
        <filename>gstreamer-gl-&GST_API_VERSION;.pc</filename>
      </para>
      <xi:include href="xml/gstglapi.xml"/>
      <xi:include href="xml/gstglbasefilter.xml"/>
      <xi:include href="xml/gstglbasememory.xml"/>
      <xi:include href="xml/gstglbuffer.xml"/>
      <xi:include href="xml/gstglbufferpool.xml"/>
      <xi:include href="xml/gstglcolorconvert.xml"/>
      <xi:include href="xml/gstglcontext.xml"/>
      <!-- Not exposed as public API
      <xi:include href="xml/gstglcontextcocoa.xml"/>
      <xi:include href="xml/gstglcontexteagl.xml"/>
      <xi:include href="xml/gstglcontextegl.xml"/>
      <xi:include href="xml/gstglcontextglx.xml"/>
      <xi:include href="xml/gstglcontextwgl.xml"/>
      -->
      <xi:include href="xml/gstgldisplay.xml"/>
      <!-- Not exposed as public API
      <xi:include href="xml/gstgldisplaycocoa.xml"/>
      <xi:include href="xml/gstgldisplayegl.xml"/>
      -->
      <xi:include href="xml/gstgldisplaywayland.xml"/>
      <xi:include href="xml/gstgldisplayx11.xml"/>
      <xi:include href="xml/gsteglimage.xml"/>
      <xi:include href="xml/gstglfilter.xml"/>
      <xi:include href="xml/gstglframebuffer.xml"/>
      <xi:include href="xml/gstglmemory.xml"/>
      <xi:include href="xml/gstglmemoryegl.xml"/>
      <xi:include href="xml/gstglmemorypbo.xml"/>
      <xi:include href="xml/gstgloverlaycompositor.xml"/>
      <xi:include href="xml/gstglquery.xml"/>
      <xi:include href="xml/gstglrenderbuffer.xml"/>
      <xi:include href="xml/gstglshader.xml"/>
      <xi:include href="xml/gstglsl.xml"/>
      <xi:include href="xml/gstglslstage.xml"/>
      <xi:include href="xml/gstglsyncmeta.xml"/>
      <xi:include href="xml/gstglupload.xml"/>
      <xi:include href="xml/gstglviewconvert.xml"/>
      <xi:include href="xml/gstglwindow.xml"/>
      <!-- Not exposed as public API
      <xi:include href="xml/gstglwindowandroid.xml"/>
      <xi:include href="xml/gstglwindowcocoa.xml"/>
      <xi:include href="xml/gstglwindowdispmanx.xml"/>
      <xi:include href="xml/gstglwindoweagl.xml"/>
      <xi:include href="xml/gstglwindowwayland.xml"/>
      <xi:include href="xml/gstglwindowwin32.xml"/>
      <xi:include href="xml/gstglwindowx11.xml"/>
      -->
      <!-- Some utilities -->
      <xi:include href="xml/gstgldebug.xml"/>
      <xi:include href="xml/gstglformat.xml"/>
      <xi:include href="xml/gstglutils.xml"/>
    </chapter>

281
  </part>
282

283
284
  <part id="gstreamer-libs-hierarchy">
    <title>Object Hierarchy</title>
285
    <xi:include href="xml/tree_index.sgml" />
286
  </part>
287

Stefan Kost's avatar
Stefan Kost committed
288
  <index id="api-index-full">
289
    <title>Index</title>
Stefan Kost's avatar
Stefan Kost committed
290
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
291
  </index>
Stefan Kost's avatar
Stefan Kost committed
292
293
294
295
296
297
  <index id="api-index-deprecated" role="deprecated">
    <title>Index of deprecated API</title>
    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
  </index>

  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
298
</book>