docs/gst/gstreamer-docs.sgml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
   4 <!ENTITY % version-entities SYSTEM "version.entities">
   5 %version-entities;
   6 <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
   7 <!ENTITY hash "#">
   8 ]>
   9 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  10   <bookinfo>
  11     <title>GStreamer &GST_API_VERSION; Core Reference Manual</title>
  12     <releaseinfo>
  13       for GStreamer Core &GST_API_VERSION; (&GST_VERSION;)
  14       The latest version of this documentation can be found on-line at
  15       <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>.
  16     </releaseinfo>
  17   </bookinfo>
  18
  19   <chapter id="gstreamer">
  20
  21     <title>GStreamer Overview</title>
  22     <para>
  23 GStreamer is a streaming media framework.
  24 It uses graphs of elements which operate on data.
  25 The functionality to process media is provided by plug-ins which provide
  26 features like elements, typefinding, and so on.
  27 This allows new functionality to be added simply by installing new plug-ins.
  28     </para>
  29
  30     <para>
  31 GStreamer is cross-platform and works on most UNIX-like platforms as well as
  32 Windows.  It is released under the GNU Library General Public License
  33 (GNU LGPL).
  34     </para>
  35
  36     <mediaobject>
  37       <imageobject>
  38         <imagedata fileref="gst-universe.svg" format="SVG"/>
  39       </imageobject>
  40       <caption>
  41         <para>Relation between gstreamer core objects.</para>
  42       </caption>
  43     </mediaobject>
  44
  45     <xi:include href="building.xml" />
  46     <xi:include href="running.xml" />
  47   </chapter>
  48
  49   <chapter id="libgstreamer">
  50     <title>GStreamer Core Library</title>
  51
  52     <para>
  53       libgstreamer-&GST_API_VERSION;.so provides all the core GStreamer services,
  54       including initialization, plugin management and types,
  55       as well as the object hierarchy that defines elements and bins,
  56       along with some more specialized elements.
  57     </para>
  58
  59     <xi:include href="xml/gst.xml" />
  60     <xi:include href="xml/gstallocator.xml" />
  61     <xi:include href="xml/gstatomicqueue.xml" />
  62     <xi:include href="xml/gstbin.xml" />
  63     <xi:include href="xml/gstbuffer.xml" />
  64     <xi:include href="xml/gstbufferlist.xml" />
  65     <xi:include href="xml/gstbufferpool.xml" />
  66     <xi:include href="xml/gstbus.xml" />
  67     <xi:include href="xml/gstcaps.xml" />
  68     <xi:include href="xml/gstcapsfeatures.xml" />
  69     <xi:include href="xml/gstsample.xml" />
  70     <xi:include href="xml/gstchildproxy.xml" />
  71     <xi:include href="xml/gstclock.xml" />
  72     <xi:include href="xml/gstconfig.xml" />
  73     <xi:include href="xml/gstcontext.xml" />
  74     <xi:include href="xml/gstcontrolbinding.xml" />
  75     <xi:include href="xml/gstcontrolsource.xml" />
  76     <xi:include href="xml/gstdatetime.xml" />
  77     <xi:include href="xml/gstelement.xml" />
  78     <xi:include href="xml/gstelementfactory.xml" />
  79     <xi:include href="xml/gsterror.xml" />
  80     <xi:include href="xml/gstevent.xml" />
  81     <xi:include href="xml/gstformat.xml" />
  82     <xi:include href="xml/gstghostpad.xml" />
  83     <xi:include href="xml/gstiterator.xml" />
  84     <xi:include href="xml/gstmemory.xml" />
  85     <xi:include href="xml/gstmessage.xml" />
  86     <xi:include href="xml/gstmeta.xml" />
  87     <xi:include href="xml/gstminiobject.xml" />
  88     <xi:include href="xml/gstobject.xml" />
  89     <xi:include href="xml/gstpad.xml" />
  90     <xi:include href="xml/gstpadtemplate.xml" />
  91     <xi:include href="xml/gstparamspec.xml" />
  92     <xi:include href="xml/gstparse.xml" />
  93     <xi:include href="xml/gstpipeline.xml" />
  94     <xi:include href="xml/gstplugin.xml" />
  95     <xi:include href="xml/gstpluginfeature.xml" />
  96     <xi:include href="xml/gstpoll.xml" />
  97     <xi:include href="xml/gstpreset.xml" />
  98     <xi:include href="xml/gstquery.xml" />
  99     <xi:include href="xml/gstregistry.xml" />
 100     <xi:include href="xml/gstsegment.xml" />
 101     <xi:include href="xml/gststructure.xml" />
 102     <xi:include href="xml/gstsystemclock.xml" />
 103     <xi:include href="xml/gsttaglist.xml" />
 104     <xi:include href="xml/gsttagsetter.xml" />
 105     <xi:include href="xml/gsttask.xml" />
 106     <xi:include href="xml/gsttaskpool.xml" />
 107     <xi:include href="xml/gsttoc.xml" />
 108     <xi:include href="xml/gsttocsetter.xml" />
 109     <xi:include href="xml/gsttypefind.xml" />
 110     <xi:include href="xml/gsttypefindfactory.xml" />
 111     <xi:include href="xml/gsturi.xml" />
 112     <xi:include href="xml/gsturihandler.xml" />
 113     <xi:include href="xml/gstutils.xml" />
 114     <xi:include href="xml/gstvalue.xml" />
 115     <xi:include href="xml/gstversion.xml" />
 116
 117   </chapter>
 118
 119   <chapter id="gstreamer-device-probing">
 120     <title>GStreamer Device Discovery and Device Probing</title>
 121     <xi:include href="xml/gstdevicemonitor.xml" />
 122     <xi:include href="xml/gstdevice.xml" />
 123     <xi:include href="xml/gstdeviceprovider.xml" />
 124     <xi:include href="xml/gstdeviceproviderfactory.xml" />
 125   </chapter>
 126
 127   <chapter id="gstreamer-support">
 128     <title>GStreamer Core Support</title>
 129     <para>
 130       Theses modules support the gstreamer core and plugin development.
 131       Application developers will rarely need to know about it.
 132     </para>
 133
 134     <xi:include href="xml/gstinfo.xml" />
 135
 136   </chapter>
 137
 138   <chapter id="gstreamer-hierarchy">
 139     <title>Object Hierarchy</title>
 140     <xi:include href="xml/tree_index.sgml"/>
 141   </chapter>
 142
 143   <index id="api-index-full">
 144     <title>API Index</title>
 145     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 146   </index>
 147   <index id="api-index-deprecated" role="deprecated">
 148     <title>Index of deprecated API</title>
 149     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 150   </index>
 151
 152   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 153
 154 </book>