docs/gst/gstreamer-docs.sgml

   1 <!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
   2
   3 <!entity Gst SYSTEM "sgml/gst.sgml">
   4 <!entity GstAutoplug SYSTEM "sgml/gstautoplug.sgml">
   5 <!entity GstAutoplugFactory SYSTEM "sgml/gstautoplugfactory.sgml">
   6 <!entity GstInfo SYSTEM "sgml/gstinfo.sgml">
   7 <!entity GstBin SYSTEM "sgml/gstbin.sgml">
   8 <!entity GstData SYSTEM "sgml/gstdata.sgml">
   9 <!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
  10 <!entity GstEvent SYSTEM "sgml/gstevent.sgml">
  11 <!entity GstBufferPool SYSTEM "sgml/gstbufferpool.sgml">
  12 <!entity GstCpu SYSTEM "sgml/gstcpu.sgml">
  13 <!entity GstElement SYSTEM "sgml/gstelement.sgml">
  14 <!entity GstElementFactory SYSTEM "sgml/gstelementfactory.sgml">
  15 <!entity GstLog SYSTEM "sgml/gstlog.sgml">
  16 <!entity GstObject SYSTEM "sgml/gstobject.sgml">
  17 <!entity GstPad SYSTEM "sgml/gstpad.sgml">
  18 <!entity GstPadTemplate SYSTEM "sgml/gstpadtemplate.sgml">
  19 <!entity GstParse SYSTEM "sgml/gstparse.sgml">
  20 <!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
  21 <!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
  22 <!entity GstPluginFeature SYSTEM "sgml/gstpluginfeature.sgml">
  23 <!entity GstThread SYSTEM "sgml/gstthread.sgml">
  24 <!entity GstScheduler SYSTEM "sgml/gstscheduler.sgml">
  25 <!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
  26 <!entity GstType SYSTEM "sgml/gsttype.sgml">
  27 <!entity GstTypeFactory SYSTEM "sgml/gsttypefactory.sgml">
  28 <!entity GstCaps SYSTEM "sgml/gstcaps.sgml">
  29 <!entity GstProps SYSTEM "sgml/gstprops.sgml">
  30 <!entity GstClock SYSTEM "sgml/gstclock.sgml">
  31 <!entity GstUtils SYSTEM "sgml/gstutils.sgml">
  32 <!entity GstXML SYSTEM "sgml/gstxml.sgml">
  33 <!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
  34 <!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
  35 <!entity GstTimeCache SYSTEM "sgml/gsttimecache.sgml">
  36 <!entity cothreads SYSTEM "sgml/cothreads.sgml">
  37
  38 <!entity GstStaticAutoplug SYSTEM "sgml/gststaticautoplug.sgml">
  39 <!entity GstStaticAutoplugRender SYSTEM "sgml/gststaticautoplugrender.sgml">
  40 <!entity GstAggregator SYSTEM "sgml/gstaggregator.sgml">
  41 <!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
  42 <!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
  43 <!entity GstFileSrc SYSTEM "sgml/gstfilesrc.sgml">
  44 <!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
  45 <!entity GstDiskSink SYSTEM "sgml/gstdisksink.sgml">
  46 <!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml">
  47 <!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
  48 <!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
  49 <!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
  50 <!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
  51 <!entity GstTee SYSTEM "sgml/gsttee.sgml">
  52
  53 <!entity gstreamer-tree-index SYSTEM "sgml/tree_index.sgml">
  54 ]>
  55
  56
  57 <book>
  58   <bookinfo>
  59     <title>GStreamer Library Reference Manual (Core)</title>
  60   </bookinfo>
  61   <chapter id="gstreamer">
  62     <title>GStreamer Core Library</title>
  63
  64     <para>libgst.la provides all the core GStreamer services,
  65 including initialization, plugin management and types, as
  66 well as the object hiarchy that defines elements and bins, along
  67 with some more specialized elements.</para>
  68
  69     &Gst;
  70     &GstAutoplug;
  71     &GstAutoplugFactory;
  72     &GstBin;
  73     &GstBuffer;
  74     &GstBufferPool;
  75     &GstCaps;
  76     &GstClock;
  77     &GstCpu;
  78     &GstData;
  79     &GstElement;
  80     &GstElementFactory;
  81     &GstEvent;
  82     &GstInfo;
  83     &GstObject;
  84     &GstPad;
  85     &GstPadTemplate;
  86     &GstParse;
  87     &GstPipeline;
  88     &GstPlugin;
  89     &GstPluginFeature;
  90     &GstProps;
  91     &GstQueue;
  92     &GstScheduler;
  93     &GstThread;
  94     &GstTimeCache;
  95     &GstType;
  96     &GstTypeFactory;
  97     &GstTypeFind;
  98     &GstUtils;
  99     &GstXML;
 100
 101     &cothreads;
 102   </chapter>
 103
 104   <chapter id="element-types">
 105     <title>GStreamer Standard Elements</title>
 106
 107     <para>
 108       libgstelements.la provide some basic elements like a disk source
 109       and sink. The use of these elements is strictly though the g_object_get() and
 110       g_object_set() functions and the GStreamer Core Library functions.
 111     </para>
 112
 113     &GstAggregator;
 114
 115     &GstFakeSrc;
 116     &GstFakeSink;
 117
 118     <!-- &GstFileSrc; -->
 119     &GstDiskSrc;
 120     &GstDiskSink;
 121
 122     &GstHttpSrc;
 123
 124     &GstFdSrc;
 125     &GstFdSink;
 126
 127     &GstPipefilter;
 128     &GstIdentity;
 129
 130     &GstTee;
 131   </chapter>
 132
 133   <chapter id="autopluggers">
 134     <title>GStreamer Autoppluggers</title>
 135
 136     <para>the autopluggers provide a way to automatically construct elements based on
 137     sink and src capabilities</para>
 138
 139     &GstStaticAutoplug;
 140     &GstStaticAutoplugRender;
 141   </chapter>
 142
 143   <chapter id="gst-index">
 144     <title>Index</title>
 145
 146     <sect1>
 147       <title>Object Hierarchy</title>
 148       &gstreamer-tree-index;
 149     </sect1>
 150   </chapter>
 151 </book>