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