7ef65da68f58f65f77104d2de2b7ef138e2effdb
[platform/upstream/gstreamer.git] / docs / libs / gst-plugins-bad-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 Bad Plugins &GST_API_VERSION; Library Reference Manual</title>
10     <releaseinfo>
11       for GStreamer Bad Library &GST_API_VERSION; (&GST_VERSION;)
12       <ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-bad-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-bad-libs/html/</ulink>.
13     </releaseinfo>
14   </bookinfo>
15
16   <part id="gstreamer-plugins-bad">
17     <title>GStreamer Bad Plugins Libraries</title>
18     <para>
19       This manual describes the libraries provided by the GStreamer Bad Plugins
20       package.
21     </para>
22     <xi:include href="compiling.sgml" />
23
24     <chapter id="codecparsers">
25       <title>Bitstream parsing Library</title>
26       <para>
27         This library should be linked to by getting cflags and libs from
28         <filename>gstreamer-plugins-bad-&GST_API_VERSION;.pc</filename> and adding
29         <filename>-lgstcodeparsers-&GST_API_VERSION;</filename> to the library flags.
30       </para>
31       <xi:include href="xml/gsth264parser.xml" />
32       <xi:include href="xml/gstmpegvideoparser.xml" />
33       <xi:include href="xml/gstmpeg4parser.xml" />
34       <xi:include href="xml/gstvc1parser.xml" />
35       <xi:include href="xml/gstmpegvideometa.xml" />
36     </chapter>
37
38     <chapter id="mpegts">
39       <title>Mpeg TS helper library</title>
40       <para>
41         This library should be linked to by getting cflags and libs from
42         <filename>gstreamer-plugins-bad-&GST_API_VERSION;.pc</filename> and adding
43         <filename>-lgstmpegts-&GST_API_VERSION;</filename> to the library flags.
44       </para>
45       <xi:include href="xml/gstmpegts.xml" />
46       <xi:include href="xml/gstmpegtssection.xml" />
47       <xi:include href="xml/gstmpegtsdescriptor.xml" />
48       <xi:include href="xml/gst-atsc-section.xml" />
49       <xi:include href="xml/gst-dvb-section.xml" />
50       <xi:include href="xml/gst-atsc-descriptor.xml" />
51       <xi:include href="xml/gst-dvb-descriptor.xml" />
52       <xi:include href="xml/gst-isdb-descriptor.xml" />
53     </chapter>
54
55     <chapter id="tools">
56       <title>Useful elements</title>
57       <xi:include href="xml/gstinsertbin.xml" />
58     </chapter>
59
60     <chapter id="base">
61       <title>GStreamer Base classes from gst-plugins-bad</title>
62       <xi:include href="xml/gstaggregator.xml" />
63       <xi:include href="xml/gstaggregatorpad.xml" />
64     </chapter>
65
66     <chapter id="gl">
67       <title>OpenGL Helper Library</title>
68       <xi:include href="xml/gstglapi.xml"/>
69       <xi:include href="xml/gstglbufferpool.xml"/>
70       <xi:include href="xml/gstglcolorconvert.xml"/>
71       <xi:include href="xml/gstglcontext.xml"/>
72       <xi:include href="xml/gstglcontextcocoa.xml"/>
73       <xi:include href="xml/gstglcontextegl.xml"/>
74       <xi:include href="xml/gstglcontextglx.xml"/>
75       <xi:include href="xml/gstglcontextwgl.xml"/>
76       <xi:include href="xml/gstgldisplay.xml"/>
77       <xi:include href="xml/gstgldownload.xml"/>
78       <xi:include href="xml/gsteglimagememory.xml"/>
79       <xi:include href="xml/gstglfilter.xml"/>
80       <xi:include href="xml/gstglframebuffer.xml"/>
81       <xi:include href="xml/gstglmemory.xml"/>
82       <xi:include href="xml/gstglmixer.xml"/>
83       <xi:include href="xml/gstglshader.xml"/>
84       <xi:include href="xml/gstglupload.xml"/>
85       <xi:include href="xml/gstgluploadmeta.xml"/>
86       <xi:include href="xml/gstglutils.xml"/>
87       <xi:include href="xml/gstglwindow.xml"/>
88       <xi:include href="xml/gstglwindowandroid.xml"/>
89       <xi:include href="xml/gstglwindowcocoa.xml"/>
90       <xi:include href="xml/gstglwindowdispmanx.xml"/>
91       <xi:include href="xml/gstglwindowwayland.xml"/>
92       <xi:include href="xml/gstglwindowwin32.xml"/>
93       <xi:include href="xml/gstglwindowx11.xml"/>
94     </chapter>
95   </part>
96
97   <part id="gstreamer-libs-hierarchy">
98     <title>Object Hierarchy</title>
99     <xi:include href="xml/tree_index.sgml" />
100   </part>
101
102   <index id="api-index-full">
103     <title>Index</title>
104     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
105   </index>
106   <index id="api-index-deprecated" role="deprecated">
107     <title>Index of deprecated API</title>
108     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
109   </index>
110
111   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
112 </book>
113