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 GstElementFactory SYSTEM "xml/gstelementfactory.xml">
  19 <!ENTITY GstError SYSTEM "xml/gsterror.xml">
  20 <!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
  21 <!ENTITY GstFilter SYSTEM "xml/gstfilter.xml">
  22 <!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
  23 <!ENTITY GstGhostPad SYSTEM "xml/gstghostpad.xml">
  24 <!ENTITY GstImplementsInterface SYSTEM "xml/gstimplementsinterface.xml">
  25 <!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
  26 <!ENTITY GstIndexFactory SYSTEM "xml/gstindexfactory.xml">
  27 <!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
  28 <!ENTITY GstIterator SYSTEM "xml/gstiterator.xml">
  29 <!ENTITY GstMessage SYSTEM "xml/gstmessage.xml">
  30 <!ENTITY GstMiniObject SYSTEM "xml/gstminiobject.xml">
  31 <!ENTITY GstObject SYSTEM "xml/gstobject.xml">
  32 <!ENTITY GstPad SYSTEM "xml/gstpad.xml">
  33 <!ENTITY GstPadTemplate SYSTEM "xml/gstpadtemplate.xml">
  34 <!ENTITY GstParamSpec SYSTEM "xml/gstparamspec.xml">
  35 <!ENTITY GstParse SYSTEM "xml/gstparse.xml">
  36 <!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
  37 <!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
  38 <!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
  39 <!ENTITY GstPoll SYSTEM "xml/gstpoll.xml">
  40 <!ENTITY GstPreset SYSTEM "xml/gstpreset.xml">
  41 <!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
  42 <!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
  43 <!ENTITY GstSegment SYSTEM "xml/gstsegment.xml">
  44 <!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
  45 <!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
  46 <!ENTITY GstTagList SYSTEM "xml/gsttaglist.xml">
  47 <!ENTITY GstTagSetter SYSTEM "xml/gsttagsetter.xml">
  48 <!ENTITY GstTask SYSTEM "xml/gsttask.xml">
  49 <!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
  50 <!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
  51 <!ENTITY GstTypeFindFactory SYSTEM "xml/gsttypefindfactory.xml">
  52 <!ENTITY GstUriHandler SYSTEM "xml/gsturihandler.xml">
  53 <!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
  54 <!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
  55 <!ENTITY GstVersion SYSTEM "xml/gstversion.xml">
  56 <!ENTITY GstXML SYSTEM "xml/gstxml.xml">
  57
  58 <!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.sgml">
  59
  60 <!ENTITY gst-Running SYSTEM "running.xml">
  61
  62 <!ENTITY hash "#">
  63 ]>
  64 <book id="index">
  65   <bookinfo>
  66     <title>GStreamer &GST_MAJORMINOR; Core Reference Manual</title>
  67     <releaseinfo>
  68       for GStreamer Core &GST_MAJORMINOR; (&GST_VERSION;)
  69       The latest version of this documentation can be found on-line at
  70       <ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/</ulink>.
  71     </releaseinfo>
  72   </bookinfo>
  73
  74   <chapter id="gstreamer">
  75
  76     <title>GStreamer Overview</title>
  77     <para>
  78 GStreamer is a streaming media framework.
  79 It uses graphs of elements which operate on data.
  80 The functionality to process media is provided by plug-ins which provide
  81 features like elements, typefinding, and so on.
  82 This allows new functionality to be added simply by installing new plug-ins.
  83     </para>
  84
  85     <para>
  86 GStreamer is cross-platform and works on most UNIX-like platforms as well as
  87 Windows.  It is released under the GNU Library General Public License
  88 (GNU LGPL).
  89     </para>
  90
  91     &gst-Running;
  92   </chapter>
  93
  94   <chapter id="libgstreamer">
  95     <title>GStreamer Core Library</title>
  96
  97     <para>
  98       libgstreamer-&GST_MAJORMINOR;.so provides all the core GStreamer services,
  99       including initialization, plugin management and types,
 100       as well as the object hierarchy that defines elements and bins,
 101       along with some more specialized elements.
 102     </para>
 103
 104     &Gst;
 105     &GstBin;
 106     &GstBuffer;
 107     &GstBus;
 108     &GstCaps;
 109     &GstChildProxy;
 110     &GstClock;
 111     &GstConfig;
 112     &GstElement;
 113     &GstElementFactory;
 114     &GstError;
 115     &GstEvent;
 116     &GstFilter;
 117     &GstFormat;
 118     &GstGhostPad;
 119     &GstImplementsInterface;
 120     &GstIndex;
 121     &GstIndexFactory;
 122     &GstIterator;
 123     &GstMessage;
 124     &GstMiniObject;
 125     &GstObject;
 126     &GstPad;
 127     &GstPadTemplate;
 128     &GstParamSpec;
 129     &GstParse;
 130     &GstPipeline;
 131     &GstPlugin;
 132     &GstPluginFeature;
 133     &GstPoll;
 134     &GstPreset;
 135     &GstQuery;
 136     &GstRegistry;
 137     &GstSegment;
 138     &GstStructure;
 139     &GstSystemClock;
 140     &GstTagList;
 141     &GstTagSetter;
 142     &GstTask;
 143     &GstTypeFind;
 144     &GstTypeFindFactory;
 145     &GstUriHandler;
 146     &GstUtils;
 147     &GstValue;
 148     &GstVersion;
 149     &GstXML;
 150
 151   </chapter>
 152
 153   <chapter id="gstreamer-support">
 154     <title>GStreamer Core Support</title>
 155     <para>
 156       Theses modules support the gstreamer core and plugin development.
 157       Application developers will rarely need to know about it.
 158     </para>
 159
 160     &GstInfo;
 161     &GstTrace;
 162
 163   </chapter>
 164
 165 <!--
 166   <chapter id="gstreamer-compat">
 167     <title>GStreamer Core Compatibility</title>
 168     <para>
 169       These elements are defined for compatibility with older code.
 170       They must not be used in new code!
 171     </para>
 172
 173     &GstCompat;
 174
 175   </chapter>
 176 -->
 177
 178   <chapter id="gstreamer-hierarchy">
 179     <title>Object Hierarchy</title>
 180     &gstreamer-tree-index;
 181   </chapter>
 182
 183   <index id="api-index">
 184     <title>Index</title>
 185   </index>
 186   <index role="deprecated">
 187     <title>Index of deprecated symbols</title>
 188   </index>
 189   <!-- disable, as
 190      - index generation is extremly slow in xslt
 191      - we have not tagged lots of symbols this way anyway
 192   <index role="0.9">
 193     <title>Index of new symbols in 0.9</title>
 194   </index>
 195   -->
 196
 197 </book>