summaryrefslogtreecommitdiff
path: root/docs/libs/gst-plugins-bad-libs-docs.sgml
blob: 7ef65da68f58f65f77104d2de2b7ef138e2effdb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>GStreamer Bad Plugins &GST_API_VERSION; Library Reference Manual</title>
    <releaseinfo>
      for GStreamer Bad Library &GST_API_VERSION; (&GST_VERSION;)
      <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>.
    </releaseinfo>
  </bookinfo>

  <part id="gstreamer-plugins-bad">
    <title>GStreamer Bad Plugins Libraries</title>
    <para>
      This manual describes the libraries provided by the GStreamer Bad Plugins
      package.
    </para>
    <xi:include href="compiling.sgml" />

    <chapter id="codecparsers">
      <title>Bitstream parsing Library</title>
      <para>
        This library should be linked to by getting cflags and libs from
        <filename>gstreamer-plugins-bad-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstcodeparsers-&GST_API_VERSION;</filename> to the library flags.
      </para>
      <xi:include href="xml/gsth264parser.xml" />
      <xi:include href="xml/gstmpegvideoparser.xml" />
      <xi:include href="xml/gstmpeg4parser.xml" />
      <xi:include href="xml/gstvc1parser.xml" />
      <xi:include href="xml/gstmpegvideometa.xml" />
    </chapter>

    <chapter id="mpegts">
      <title>Mpeg TS helper library</title>
      <para>
        This library should be linked to by getting cflags and libs from
        <filename>gstreamer-plugins-bad-&GST_API_VERSION;.pc</filename> and adding
        <filename>-lgstmpegts-&GST_API_VERSION;</filename> to the library flags.
      </para>
      <xi:include href="xml/gstmpegts.xml" />
      <xi:include href="xml/gstmpegtssection.xml" />
      <xi:include href="xml/gstmpegtsdescriptor.xml" />
      <xi:include href="xml/gst-atsc-section.xml" />
      <xi:include href="xml/gst-dvb-section.xml" />
      <xi:include href="xml/gst-atsc-descriptor.xml" />
      <xi:include href="xml/gst-dvb-descriptor.xml" />
      <xi:include href="xml/gst-isdb-descriptor.xml" />
    </chapter>

    <chapter id="tools">
      <title>Useful elements</title>
      <xi:include href="xml/gstinsertbin.xml" />
    </chapter>

    <chapter id="base">
      <title>GStreamer Base classes from gst-plugins-bad</title>
      <xi:include href="xml/gstaggregator.xml" />
      <xi:include href="xml/gstaggregatorpad.xml" />
    </chapter>

    <chapter id="gl">
      <title>OpenGL Helper Library</title>
      <xi:include href="xml/gstglapi.xml"/>
      <xi:include href="xml/gstglbufferpool.xml"/>
      <xi:include href="xml/gstglcolorconvert.xml"/>
      <xi:include href="xml/gstglcontext.xml"/>
      <xi:include href="xml/gstglcontextcocoa.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"/>
      <xi:include href="xml/gstgldownload.xml"/>
      <xi:include href="xml/gsteglimagememory.xml"/>
      <xi:include href="xml/gstglfilter.xml"/>
      <xi:include href="xml/gstglframebuffer.xml"/>
      <xi:include href="xml/gstglmemory.xml"/>
      <xi:include href="xml/gstglmixer.xml"/>
      <xi:include href="xml/gstglshader.xml"/>
      <xi:include href="xml/gstglupload.xml"/>
      <xi:include href="xml/gstgluploadmeta.xml"/>
      <xi:include href="xml/gstglutils.xml"/>
      <xi:include href="xml/gstglwindow.xml"/>
      <xi:include href="xml/gstglwindowandroid.xml"/>
      <xi:include href="xml/gstglwindowcocoa.xml"/>
      <xi:include href="xml/gstglwindowdispmanx.xml"/>
      <xi:include href="xml/gstglwindowwayland.xml"/>
      <xi:include href="xml/gstglwindowwin32.xml"/>
      <xi:include href="xml/gstglwindowx11.xml"/>
    </chapter>
  </part>

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

  <index id="api-index-full">
    <title>Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>
  <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>
</book>