gstreamer/docs/libs/gst-plugins-bad-libs-docs.sgml
Matthew Waters 0dc003bf30 gl/docs: massive update
- add Since: markers where necessary.
- document structs
- add documentation headers for each module (short_description,
  see_also, etc)
- reduce the number of warnings gtk-doc outputs
- fix spelling mistakes
2016-11-03 16:16:11 +11:00

162 lines
6.4 KiB
XML

<?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/gstjpegparser.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="video">
<title>Video helpers and baseclasses</title>
<xi:include href="xml/gstvideoaggregator.xml" />
<xi:include href="xml/gstvideoaggregatorpad.xml" />
</chapter>
<chapter id="gl">
<title>OpenGL Helper 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>
<chapter id="player">
<title>Player Library</title>
<xi:include href="xml/gstplayer.xml"/>
<xi:include href="xml/gstplayer-mediainfo.xml"/>
<xi:include href="xml/gstplayer-gmaincontextsignaldispatcher.xml"/>
<xi:include href="xml/gstplayer-videooverlayvideorenderer.xml"/>
<xi:include href="xml/gstplayer-visualization.xml"/>
</chapter>
<chapter>
<title>Interfaces</title>
<xi:include href="xml/gstphotography.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>