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