gstreamer/docs/libs/gst-plugins-bad-libs-docs.sgml
Edward Hervey f24c0b62e3 mpegts: Improve documentation
* Add a base page for the library
* Add pages for the base MPEG-TS section and descriptors
* Add pages for the known variants
* Add documentation on more fields/sections/types
* Remove some fixmes that were ... fixed
2013-07-04 08:45:33 +02:00

77 lines
3 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/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>
</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>