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 GstBin SYSTEM "xml/gstbin.xml">
   8 <!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
   9 <!ENTITY GstBus SYSTEM "xml/gstbus.xml">
  10 <!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
  11 <!ENTITY GstChildProxy SYSTEM "xml/gstchildproxy.xml">
  12 <!ENTITY GstClock SYSTEM "xml/gstclock.xml">
  13 <!--
  14 <!ENTITY GstCompat SYSTEM "xml/gstcompat.xml">
  15 -->
  16 <!ENTITY GstConfig SYSTEM "xml/gstconfig.xml">
  17 <!ENTITY GstElement SYSTEM "xml/gstelement.xml">
  18 <!ENTITY GstElementDetails SYSTEM "xml/gstelementdetails.xml">
  19 <!ENTITY GstElementFactory SYSTEM "xml/gstelementfactory.xml">
  20 <!ENTITY GstError SYSTEM "xml/gsterror.xml">
  21 <!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
  22 <!ENTITY GstFilter SYSTEM "xml/gstfilter.xml">
  23 <!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
  24 <!ENTITY GstGhostPad SYSTEM "xml/gstghostpad.xml">
  25 <!ENTITY GstImplementsInterface SYSTEM "xml/gstimplementsinterface.xml">
  26 <!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
  27 <!ENTITY GstIndexFactory SYSTEM "xml/gstindexfactory.xml">
  28 <!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
  29 <!ENTITY GstIterator SYSTEM "xml/gstiterator.xml">
  30 <!ENTITY GstMacros SYSTEM "xml/gstmacros.xml">
  31 <!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml">
  32 <!ENTITY GstMessage SYSTEM "xml/gstmessage.xml">
  33 <!ENTITY GstMiniObject SYSTEM "xml/gstminiobject.xml">
  34 <!ENTITY GstObject SYSTEM "xml/gstobject.xml">
  35 <!ENTITY GstPad SYSTEM "xml/gstpad.xml">
  36 <!ENTITY GstPadTemplate SYSTEM "xml/gstpadtemplate.xml">
  37 <!ENTITY GstParse SYSTEM "xml/gstparse.xml">
  38 <!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
  39 <!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
  40 <!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
  41 <!ENTITY GstProbe SYSTEM "xml/gstprobe.xml">
  42 <!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
  43 <!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
  44 <!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
  45 <!ENTITY GstRegistryPool SYSTEM "xml/gstregistrypool.xml">
  46 <!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
  47 <!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
  48 <!ENTITY GstTagList SYSTEM "xml/gsttaglist.xml">
  49 <!ENTITY GstTagSetter SYSTEM "xml/gsttagsetter.xml">
  50 <!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
  51 <!ENTITY GstTrashStack SYSTEM "xml/gsttrashstack.xml">
  52 <!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
  53 <!ENTITY GstTypeFindFactory SYSTEM "xml/gsttypefindfactory.xml">
  54 <!ENTITY GstTypes SYSTEM "xml/gsttypes.xml">
  55 <!ENTITY GstUriHandler SYSTEM "xml/gsturihandler.xml">
  56 <!ENTITY GstUriType SYSTEM "xml/gsturitype.xml">
  57 <!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
  58 <!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
  59 <!ENTITY GstVersion SYSTEM "xml/gstversion.xml">
  60 <!ENTITY GstXML SYSTEM "xml/gstxml.xml">
  61 <!ENTITY GstXMLRegistry SYSTEM "xml/gstxmlregistry.xml">
  62
  63 <!ENTITY GstAdapter SYSTEM "xml/gstadapter.xml">
  64 <!ENTITY GstBaseSrc SYSTEM "xml/gstbasesrc.xml">
  65 <!ENTITY GstBaseSink SYSTEM "xml/gstbasesink.xml">
  66 <!ENTITY GstBaseTransform SYSTEM "xml/gstbasetransform.xml">
  67 <!ENTITY GstCollectPads SYSTEM "xml/gstcollectpads.xml">
  68 <!ENTITY GstPushSrc SYSTEM "xml/gstpushsrc.xml">
  69
  70 <!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
  71 <!ENTITY GstFakeSink SYSTEM "xml/gstfakesink.xml">
  72 <!ENTITY GstFileSrc SYSTEM "xml/gstfilesrc.xml">
  73 <!ENTITY GstFileSink SYSTEM "xml/gstfilesink.xml">
  74 <!--
  75 <!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
  76 <!ENTITY GstFdSrc SYSTEM "xml/gstfdsrc.xml">
  77 <!ENTITY GstFdSink SYSTEM "xml/gstfdsink.xml">
  78 <!ENTITY GstIdentity SYSTEM "xml/gstidentity.xml">
  79 <!ENTITY GstPipefilter SYSTEM "xml/gstpipefilter.xml">
  80 <!ENTITY GstStatistics SYSTEM "xml/gststatistics.xml">
  81 <!ENTITY GstMD5Sink SYSTEM "xml/gstmd5sink.xml">
  82 <!ENTITY GstTee SYSTEM "xml/gsttee.xml">
  83 -->
  84
  85 <!-- generated by gtkdoc-mkdb, stupid name -->
  86 <!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.sgml">
  87
  88 <!ENTITY hash "#">
  89 ]>
  90 <book id="index">
  91   <bookinfo>
  92     <title>GStreamer &GST_MAJORMINOR; Core Reference Manual</title>
  93     <releaseinfo>for GStreamer Core &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
  94   </bookinfo>
  95
  96   <chapter id="gstreamer">
  97     <title>GStreamer Core Library</title>
  98
  99     <para>
 100       libgstreamer-&GST_MAJORMINOR;.so provides all the core GStreamer services,
 101       including initialization, plugin management and types,
 102       as well as the object hierarchy that defines elements and bins,
 103       along with some more specialized elements.
 104     </para>
 105
 106     &Gst;
 107     &GstBin;
 108     &GstBuffer;
 109     &GstBus;
 110     &GstCaps;
 111     &GstChildProxy;
 112     &GstClock;
 113     &GstConfig;
 114     &GstElement;
 115     &GstElementDetails;
 116     &GstElementFactory;
 117     &GstError;
 118     &GstEvent;
 119     &GstFilter;
 120     &GstFormat;
 121     &GstGhostPad;
 122     &GstImplementsInterface;
 123     &GstIndex;
 124     &GstIndexFactory;
 125     &GstInfo;
 126     &GstIterator;
 127     &GstMessage;
 128     &GstMiniObject;
 129     &GstObject;
 130     &GstPad;
 131     &GstPadTemplate;
 132     &GstParse;
 133     &GstPipeline;
 134     &GstPlugin;
 135     &GstPluginFeature;
 136     &GstProbe;
 137     &GstQuery;
 138     &GstQueue;
 139     &GstRegistry;
 140     &GstRegistryPool;
 141     &GstStructure;
 142     &GstSystemClock;
 143     &GstTagList;
 144     &GstTagSetter;
 145     &GstTypeFind;
 146     &GstTypeFindFactory;
 147     &GstTypes;
 148     &GstUriHandler;
 149     &GstUriType;
 150     &GstUtils;
 151     &GstValue;
 152     &GstVersion;
 153     &GstXML;
 154     &GstXMLRegistry;
 155
 156   </chapter>
 157
 158   <chapter id="gstreamer-support">
 159     <title>GStreamer Core Support</title>
 160     <para>
 161       Theses elements support the gstreamer core and applications using it.
 162     </para>
 163
 164     &GstMacros;
 165     &GstMemChunk;
 166
 167   </chapter>
 168
 169 <!--
 170   <chapter id="gstreamer-compat">
 171     <title>GStreamer Core Compatibility</title>
 172     <para>
 173       These elements are defined for compatibility with older code.
 174       They must not be used in new code!
 175     </para>
 176
 177     &GstCompat;
 178
 179   </chapter>
 180 -->
 181
 182   <chapter id="element-types">
 183     <title>GStreamer Core Elements</title>
 184
 185     <para>
 186       libgstelements.so provide some basic elements like a file source
 187       and sink. The use of these elements is strictly though the g_object_get() and
 188       g_object_set() functions and the GStreamer Core Library functions.
 189     </para>
 190
 191
 192     &GstFakeSrc;
 193     &GstFakeSink;
 194     &GstFileSrc;
 195     &GstFileSink;
 196 <!--
 197
 198     &GstAggregator;
 199
 200     &GstFdSrc;
 201     &GstFdSink;
 202
 203     &GstPipefilter;
 204     &GstIdentity;
 205
 206     &GstStatistics;
 207     &GstMD5Sink;
 208
 209     &GstTee;
 210 -->
 211   </chapter>
 212
 213   <chapter id="gstreamer-base">
 214     <title>GStreamer Base Classes</title>
 215     <para>
 216       libgstbase-&GST_MAJORMINOR;.so provides some base classes to be extended
 217       by elements.
 218     </para>
 219
 220     &GstAdapter;
 221     &GstBaseSrc;
 222     &GstBaseSink;
 223     &GstBaseTransform;
 224     &GstCollectPads;
 225     &GstPushSrc;
 226
 227   </chapter>
 228
 229
 230   <chapter id="gstreamer-hierarchy">
 231     <title>Object Hierarchy</title>
 232     &gstreamer-tree-index;
 233   </chapter>
 234
 235   <index id="api-index">
 236     <title>Index</title>
 237   </index>
 238   <index role="deprecated">
 239     <title>Index of deprecated symbols</title>
 240   </index>
 241   <index role="0.8">
 242     <title>Index of new symbols in 0.8</title>
 243   </index>
 244   <index role="0.9">
 245     <title>Index of new symbols in 0.9</title>
 246   </index>
 247
 248 </book>