530af2b4dabe01dfeef254961b8446dff819d5e5
[platform/upstream/gst-plugins-bad.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/gstjpegparser.xml" />
33       <xi:include href="xml/gstmpegvideoparser.xml" />
34       <xi:include href="xml/gstmpeg4parser.xml" />
35       <xi:include href="xml/gstvc1parser.xml" />
36       <xi:include href="xml/gstmpegvideometa.xml" />
37     </chapter>
38
39     <chapter id="mpegts">
40       <title>Mpeg TS helper library</title>
41       <para>
42         This library should be linked to by getting cflags and libs from
43         <filename>gstreamer-plugins-bad-&GST_API_VERSION;.pc</filename> and adding
44         <filename>-lgstmpegts-&GST_API_VERSION;</filename> to the library flags.
45       </para>
46       <xi:include href="xml/gstmpegts.xml" />
47       <xi:include href="xml/gstmpegtssection.xml" />
48       <xi:include href="xml/gstmpegtsdescriptor.xml" />
49       <xi:include href="xml/gst-atsc-section.xml" />
50       <xi:include href="xml/gst-dvb-section.xml" />
51       <xi:include href="xml/gst-atsc-descriptor.xml" />
52       <xi:include href="xml/gst-dvb-descriptor.xml" />
53       <xi:include href="xml/gst-isdb-descriptor.xml" />
54     </chapter>
55
56     <chapter id="tools">
57       <title>Useful elements</title>
58       <xi:include href="xml/gstinsertbin.xml" />
59     </chapter>
60
61     <chapter id="video">
62       <title>Video helpers and baseclasses</title>
63       <xi:include href="xml/gstvideoaggregator.xml" />
64       <xi:include href="xml/gstvideoaggregatorpad.xml" />
65     </chapter>
66
67     <chapter id="player">
68       <title>Player Library</title>
69       <xi:include href="xml/gstplayer.xml"/>
70       <xi:include href="xml/gstplayer-mediainfo.xml"/>
71       <xi:include href="xml/gstplayer-gmaincontextsignaldispatcher.xml"/>
72       <xi:include href="xml/gstplayer-videooverlayvideorenderer.xml"/>
73       <xi:include href="xml/gstplayer-visualization.xml"/>
74     </chapter>
75
76     <chapter>
77       <title>Interfaces</title>
78       <xi:include href="xml/gstphotography.xml" />
79     </chapter>
80   </part>
81
82   <part id="gstreamer-libs-hierarchy">
83     <title>Object Hierarchy</title>
84     <xi:include href="xml/tree_index.sgml" />
85   </part>
86
87   <index id="api-index-full">
88     <title>Index</title>
89     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
90   </index>
91   <index id="api-index-deprecated" role="deprecated">
92     <title>Index of deprecated API</title>
93     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
94   </index>
95
96   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
97 </book>
98