docs/gst/gstreamer-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 Gst SYSTEM "xml/gst.xml">
   5 <!ENTITY GstAutoplug SYSTEM "xml/gstautoplug.xml">
   6 <!ENTITY GstAutoplugFactory SYSTEM "xml/gstautoplugfactory.xml">
   7 <!ENTITY GstAtomic SYSTEM "xml/gstatomic.xml">
   8 <!ENTITY GstBin SYSTEM "xml/gstbin.xml">
   9 <!ENTITY GstData SYSTEM "xml/gstdata.xml">
  10 <!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
  11 <!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
  12 <!ENTITY GstBufferPool SYSTEM "xml/gstbufferpool.xml">
  13 <!ENTITY GstCpu SYSTEM "xml/gstcpu.xml">
  14 <!ENTITY GstElement SYSTEM "xml/gstelement.xml">
  15 <!ENTITY GstElementFactory SYSTEM "xml/gstelementfactory.xml">
  16 <!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
  17 <!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
  18 <!ENTITY GstLog SYSTEM "xml/gstlog.xml">
  19 <!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml">
  20 <!ENTITY GstObject SYSTEM "xml/gstobject.xml">
  21 <!ENTITY GstPad SYSTEM "xml/gstpad.xml">
  22 <!ENTITY GstPadTemplate SYSTEM "xml/gstpadtemplate.xml">
  23 <!ENTITY GstParse SYSTEM "xml/gstparse.xml">
  24 <!ENTITY GstProbe SYSTEM "xml/gstprobe.xml">
  25 <!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
  26 <!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
  27 <!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
  28 <!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
  29 <!ENTITY GstThread SYSTEM "xml/gstthread.xml">
  30 <!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
  31 <!ENTITY GstRegistryPool SYSTEM "xml/gstregistrypool.xml">
  32 <!ENTITY GstScheduler SYSTEM "xml/gstscheduler.xml">
  33 <!ENTITY GstSchedulerFactory SYSTEM "xml/gstschedulerfactory.xml">
  34 <!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
  35 <!ENTITY GstType SYSTEM "xml/gsttype.xml">
  36 <!ENTITY GstTypeFactory SYSTEM "xml/gsttypefactory.xml">
  37 <!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
  38 <!ENTITY GstProps SYSTEM "xml/gstprops.xml">
  39 <!ENTITY GstClock SYSTEM "xml/gstclock.xml">
  40 <!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
  41 <!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
  42 <!ENTITY GstUri SYSTEM "xml/gsturi.xml">
  43 <!ENTITY GstXML SYSTEM "xml/gstxml.xml">
  44 <!-- these are elements without API docs
  45 <!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
  46 <!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
  47 -->
  48 <!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
  49 <!ENTITY GstIndexFactory SYSTEM "xml/gstindexfactory.xml">
  50 <!ENTITY cothreads SYSTEM "xml/cothreads.xml">
  51
  52 <!-- if none of the API is documented, these shouldn't go in
  53 <!ENTITY GstStaticAutoplug SYSTEM "xml/gststaticautoplug.xml">
  54 <!ENTITY GstStaticAutoplugRender SYSTEM "xml/gststaticautoplugrender.xml">
  55 -->
  56 <!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
  57 <!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
  58 <!ENTITY GstFakeSink SYSTEM "xml/gstfakesink.xml">
  59 <!ENTITY GstFileSrc SYSTEM "xml/gstfilesrc.xml">
  60 <!ENTITY GstDiskSink SYSTEM "xml/gstdisksink.xml">
  61 <!ENTITY GstFdSrc SYSTEM "xml/gstfdsrc.xml">
  62 <!ENTITY GstFdSink SYSTEM "xml/gstfdsink.xml">
  63 <!ENTITY GstIdentity SYSTEM "xml/gstidentity.xml">
  64 <!ENTITY GstPipefilter SYSTEM "xml/gstpipefilter.xml">
  65 <!ENTITY GstStatistics SYSTEM "xml/gststatistics.xml">
  66 <!ENTITY GstMD5Sink SYSTEM "xml/gstmd5sink.xml">
  67 <!ENTITY GstTee SYSTEM "xml/gsttee.xml">
  68
  69 <!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.xml">
  70 ]>
  71 <book>
  72   <bookinfo>
  73     <title>GStreamer Core Reference Manual</title>
  74   </bookinfo>
  75   <chapter id="gstreamer-support">
  76     <title>GStreamer Core Support</title>
  77     <para>
  78     </para>
  79
  80     &cothreads;
  81     &GstAtomic;
  82     &GstMemChunk;
  83
  84   </chapter>
  85   <chapter id="gstreamer">
  86     <title>GStreamer Core Library</title>
  87
  88     <para>libgst.la provides all the core GStreamer services,
  89 including initialization, plugin management and types, as
  90 well as the object hierarchy that defines elements and bins, along
  91 with some more specialized elements.</para>
  92
  93     &Gst;
  94     &GstAutoplug;
  95     &GstAutoplugFactory;
  96     &GstBin;
  97     &GstBuffer;
  98     &GstBufferPool;
  99     &GstCaps;
 100     &GstClock;
 101     &GstCpu;
 102     &GstData;
 103     &GstElement;
 104     &GstElementFactory;
 105     &GstEvent;
 106     &GstFormat;
 107     &GstIndex;
 108     &GstIndexFactory;
 109     &GstInfo;
 110     &GstObject;
 111     &GstPad;
 112     &GstPadTemplate;
 113     &GstParse;
 114     &GstPipeline;
 115     &GstPlugin;
 116     &GstPluginFeature;
 117     &GstProbe;
 118     &GstProps;
 119     &GstQuery;
 120 <!-- no API docs
 121     &GstQueue; -->
 122     &GstRegistry;
 123     &GstRegistryPool;
 124     &GstScheduler;
 125     &GstSchedulerFactory;
 126     &GstSystemClock;
 127     &GstThread;
 128     &GstType;
 129     &GstTypeFactory;
 130 <!-- no API docs
 131     &GstTypeFind; -->
 132     &GstUri;
 133     &GstUtils;
 134     &GstXML;
 135
 136   </chapter>
 137
 138   <chapter id="element-types">
 139     <title>GStreamer Standard Elements</title>
 140
 141     <para>
 142       libgstelements.la provide some basic elements like a disk source
 143       and sink. The use of these elements is strictly though the g_object_get() and
 144       g_object_set() functions and the GStreamer Core Library functions.
 145     </para>
 146
 147 <!--
 148     &GstAggregator;
 149
 150     &GstFakeSrc;
 151     &GstFakeSink;
 152
 153     &GstFileSrc;
 154     &GstDiskSink;
 155
 156     &GstFdSrc;
 157     &GstFdSink;
 158
 159     &GstPipefilter;
 160     &GstIdentity;
 161
 162     &GstStatistics;
 163     &GstMD5Sink;
 164
 165     &GstTee;
 166     -->
 167   </chapter>
 168
 169 <!-- no API is documented of these elements
 170   <chapter id="autopluggers">
 171     <title>GStreamer Autopluggers</title>
 172
 173     <para>the autopluggers provide a way to automatically construct elements based on
 174     sink and src capabilities</para>
 175
 176     &GstStaticAutoplug;
 177     &GstStaticAutoplugRender;
 178   </chapter>
 179 -->
 180
 181 <!--
 182   <chapter id="gst-index">
 183     <title>Index</title>
 184
 185     <sect1>
 186       <title>Object Hierarchy</title>
 187       &gstreamer-tree-index;
 188     </sect1>
 189   </chapter>
 190 -->
 191 </book>