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 % version-entities SYSTEM "../version.entities">
   5 %version-entities;
   6 <!ENTITY Gst SYSTEM "xml/gst.xml">
   7 <!ENTITY Gst SYSTEM "xml/gst.xml">
   8 <!ENTITY GstAtomic SYSTEM "xml/gstatomic.xml">
   9 <!ENTITY GstBin SYSTEM "xml/gstbin.xml">
  10 <!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
  11 <!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
  12 <!ENTITY GstClock SYSTEM "xml/gstclock.xml">
  13 <!ENTITY GstConfig SYSTEM "xml/gstconfig.xml">
  14 <!ENTITY GstCpu SYSTEM "xml/gstcpu.xml">
  15 <!ENTITY GstData SYSTEM "xml/gstdata.xml">
  16 <!ENTITY GstElement SYSTEM "xml/gstelement.xml">
  17 <!ENTITY GstElementFactory SYSTEM "xml/gstelementfactory.xml">
  18 <!ENTITY GstError SYSTEM "xml/gsterror.xml">
  19 <!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
  20 <!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
  21 <!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
  22 <!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
  23 <!ENTITY GstInterface SYSTEM "xml/gstinterface.xml">
  24 <!ENTITY GstLog SYSTEM "xml/gstlog.xml">
  25 <!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml">
  26 <!ENTITY GstObject SYSTEM "xml/gstobject.xml">
  27 <!ENTITY GstPad SYSTEM "xml/gstpad.xml">
  28 <!ENTITY GstParse SYSTEM "xml/gstparse.xml">
  29 <!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
  30 <!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
  31 <!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
  32 <!ENTITY GstProbe SYSTEM "xml/gstprobe.xml">
  33 <!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
  34 <!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
  35 <!ENTITY GstRegistryPool SYSTEM "xml/gstregistrypool.xml">
  36 <!ENTITY GstScheduler SYSTEM "xml/gstscheduler.xml">
  37 <!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
  38 <!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
  39 <!ENTITY GstTag SYSTEM "xml/gsttag.xml">
  40 <!ENTITY GstTagInterface SYSTEM "xml/gsttaginterface.xml">
  41 <!ENTITY GstThread SYSTEM "xml/gstthread.xml">
  42 <!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
  43 <!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
  44 <!ENTITY GstTypeFindFactory SYSTEM "xml/gsttypefindfactory.xml">
  45 <!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
  46 <!ENTITY GstUri SYSTEM "xml/gsturi.xml">
  47 <!-- not commented properly yet
  48 <!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
  49 -->
  50 <!ENTITY GstXML SYSTEM "xml/gstxml.xml">
  51 <!-- these are elements without API docs
  52 <!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
  53 -->
  54 <!ENTITY cothreads SYSTEM "xml/cothreads.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 <!ENTITY hash "#">
  72 ]>
  73 <book>
  74   <bookinfo>
  75     <title>GStreamer &GST_MAJORMINOR; Core API Reference (&GST_VERSION;)</title>
  76   </bookinfo>
  77
  78   <chapter id="gstreamer">
  79     <title>GStreamer Core Library</title>
  80
  81     <para>libgst.la provides all the core GStreamer services,
  82 including initialization, plugin management and types, as
  83 well as the object hierarchy that defines elements and bins, along
  84 with some more specialized elements.</para>
  85
  86     &Gst;
  87     &GstBin;
  88     &GstBuffer;
  89     &GstConfig;
  90     &GstCaps;
  91     &GstClock;
  92     &GstCpu;
  93     &GstData;
  94     &GstElement;
  95     &GstElementFactory;
  96     &GstError;
  97     &GstEvent;
  98     &GstFormat;
  99     &GstIndex;
 100     &GstInfo;
 101     &GstInterface;
 102     &GstObject;
 103     &GstPad;
 104     &GstParse;
 105     &GstPipeline;
 106     &GstPlugin;
 107     &GstPluginFeature;
 108     &GstProbe;
 109     &GstQuery;
 110 <!-- no API docs
 111     &GstQueue; -->
 112     &GstRegistry;
 113     &GstRegistryPool;
 114     &GstScheduler;
 115     &GstStructure;
 116     &GstSystemClock;
 117     &GstTag;
 118     &GstTagInterface;
 119     &GstThread;
 120     &GstTypeFind;
 121     &GstTypeFindFactory;
 122     &GstUri;
 123     &GstUtils;
 124 <!-- not commented properly yet
 125     &GstValue;
 126 -->
 127     &GstXML;
 128
 129   </chapter>
 130
 131   <chapter id="gstreamer-support">
 132     <title>GStreamer Core Support</title>
 133     <para>
 134     </para>
 135
 136     &cothreads;
 137     &GstAtomic;
 138     &GstMemChunk;
 139
 140   </chapter>
 141
 142 <!--
 143   <chapter id="element-types">
 144     <title>GStreamer Standard Elements</title>
 145
 146     <para>
 147       libgstelements.la provide some basic elements like a disk source
 148       and sink. The use of these elements is strictly though the g_object_get() and
 149       g_object_set() functions and the GStreamer Core Library functions.
 150     </para>
 151
 152     &GstAggregator;
 153
 154     &GstFakeSrc;
 155     &GstFakeSink;
 156
 157     &GstFileSrc;
 158     &GstDiskSink;
 159
 160     &GstFdSrc;
 161     &GstFdSink;
 162
 163     &GstPipefilter;
 164     &GstIdentity;
 165
 166     &GstStatistics;
 167     &GstMD5Sink;
 168
 169     &GstTee;
 170   </chapter>
 171     -->
 172
 173 <!--
 174   <chapter id="gst-index">
 175     <title>Index</title>
 176
 177     <sect1>
 178       <title>Object Hierarchy</title>
 179       &gstreamer-tree-index;
 180     </sect1>
 181   </chapter>
 182 -->
 183 </book>