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