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