gstreamer/docs/gst/gstreamer-docs.sgml
Benjamin Otte 803ce6bf48 GST_DEBUG reorganization containing loads of stuff:
Original commit message from CVS:
GST_DEBUG reorganization
This is a big diff (ca 450k), containing loads of stuff:
- gstinfo.[ch] complete rewrite
- changing of all GST_DEBUG messages to reflect that change
- reorganization of subsystem disabling
- addition of gstconfig.h.in so we can track the disablings
- <gst/gst.h> does not include <unistd.h> and <config.h> anymore
- documentation updated for gstinfo stuff (build the docs yourself to know what changed)
- bugfixes for making of the docs (files from CVS are not deleted anymore
- testsuite for debugging changes in testsuite/debug

expect breakage
2003-06-29 14:05:49 +00:00

183 lines
5.1 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 Gst SYSTEM "xml/gst.xml">
<!ENTITY GstAutoplug SYSTEM "xml/gstautoplug.xml">
<!ENTITY GstAtomic SYSTEM "xml/gstatomic.xml">
<!ENTITY GstBin SYSTEM "xml/gstbin.xml">
<!ENTITY GstConfig SYSTEM "xml/gstconfig.xml">
<!ENTITY GstData SYSTEM "xml/gstdata.xml">
<!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
<!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
<!ENTITY GstBufferPool SYSTEM "xml/gstbuffer.xml">
<!ENTITY GstCpu SYSTEM "xml/gstcpu.xml">
<!ENTITY GstElement SYSTEM "xml/gstelement.xml">
<!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
<!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
<!ENTITY GstLog SYSTEM "xml/gstlog.xml">
<!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml">
<!ENTITY GstObject SYSTEM "xml/gstobject.xml">
<!ENTITY GstPad SYSTEM "xml/gstpad.xml">
<!ENTITY GstParse SYSTEM "xml/gstparse.xml">
<!ENTITY GstProbe SYSTEM "xml/gstprobe.xml">
<!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
<!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
<!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
<!ENTITY GstThread SYSTEM "xml/gstthread.xml">
<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
<!ENTITY GstRegistryPool SYSTEM "xml/gstregistrypool.xml">
<!ENTITY GstScheduler SYSTEM "xml/gstscheduler.xml">
<!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
<!ENTITY GstType SYSTEM "xml/gsttype.xml">
<!ENTITY GstTypeFactory SYSTEM "xml/gsttype.xml">
<!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
<!ENTITY GstProps SYSTEM "xml/gstprops.xml">
<!ENTITY GstClock SYSTEM "xml/gstclock.xml">
<!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
<!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
<!ENTITY GstUri SYSTEM "xml/gsturi.xml">
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
<!-- these are elements without API docs
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
<!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
-->
<!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
<!ENTITY cothreads SYSTEM "xml/cothreads.xml">
<!-- if none of the API is documented, these shouldn't go in
<!ENTITY GstStaticAutoplug SYSTEM "xml/gststaticautoplug.xml">
<!ENTITY GstStaticAutoplugRender SYSTEM "xml/gststaticautoplugrender.xml">
-->
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
<!ENTITY GstFakeSink SYSTEM "xml/gstfakesink.xml">
<!ENTITY GstFileSrc SYSTEM "xml/gstfilesrc.xml">
<!ENTITY GstDiskSink SYSTEM "xml/gstdisksink.xml">
<!ENTITY GstFdSrc SYSTEM "xml/gstfdsrc.xml">
<!ENTITY GstFdSink SYSTEM "xml/gstfdsink.xml">
<!ENTITY GstIdentity SYSTEM "xml/gstidentity.xml">
<!ENTITY GstPipefilter SYSTEM "xml/gstpipefilter.xml">
<!ENTITY GstStatistics SYSTEM "xml/gststatistics.xml">
<!ENTITY GstMD5Sink SYSTEM "xml/gstmd5sink.xml">
<!ENTITY GstTee SYSTEM "xml/gsttee.xml">
<!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.xml">
<!ENTITY hash "#">
]>
<book>
<bookinfo>
<title>GStreamer Core Reference Manual</title>
</bookinfo>
<chapter id="gstreamer-support">
<title>GStreamer Core Support</title>
<para>
</para>
&cothreads;
&GstAtomic;
&GstMemChunk;
</chapter>
<chapter id="gstreamer">
<title>GStreamer Core Library</title>
<para>libgst.la provides all the core GStreamer services,
including initialization, plugin management and types, as
well as the object hierarchy that defines elements and bins, along
with some more specialized elements.</para>
&Gst;
&GstAutoplug;
&GstBin;
&GstBuffer;
&GstConfig;
&GstCaps;
&GstClock;
&GstCpu;
&GstData;
&GstElement;
&GstEvent;
&GstFormat;
&GstIndex;
&GstInfo;
&GstObject;
&GstPad;
&GstParse;
&GstPipeline;
&GstPlugin;
&GstPluginFeature;
&GstProbe;
&GstProps;
&GstQuery;
<!-- no API docs
&GstQueue; -->
&GstRegistry;
&GstRegistryPool;
&GstScheduler;
&GstSystemClock;
&GstThread;
&GstType;
<!-- no API docs
&GstTypeFind; -->
&GstUri;
&GstUtils;
&GstXML;
</chapter>
<chapter id="element-types">
<title>GStreamer Standard Elements</title>
<para>
libgstelements.la provide some basic elements like a disk source
and sink. The use of these elements is strictly though the g_object_get() and
g_object_set() functions and the GStreamer Core Library functions.
</para>
<!--
&GstAggregator;
&GstFakeSrc;
&GstFakeSink;
&GstFileSrc;
&GstDiskSink;
&GstFdSrc;
&GstFdSink;
&GstPipefilter;
&GstIdentity;
&GstStatistics;
&GstMD5Sink;
&GstTee;
-->
</chapter>
<!-- no API is documented of these elements
<chapter id="autopluggers">
<title>GStreamer Autopluggers</title>
<para>the autopluggers provide a way to automatically construct elements based on
sink and src capabilities</para>
&GstStaticAutoplug;
&GstStaticAutoplugRender;
</chapter>
-->
<!--
<chapter id="gst-index">
<title>Index</title>
<sect1>
<title>Object Hierarchy</title>
&gstreamer-tree-index;
</sect1>
</chapter>
-->
</book>