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/gstdynamictypefactory.xml" />
  78     <xi:include href="xml/gstelement.xml" />
  79     <xi:include href="xml/gstelementfactory.xml" />
  80     <xi:include href="xml/gsterror.xml" />
  81     <xi:include href="xml/gstevent.xml" />
  82     <xi:include href="xml/gstformat.xml" />
  83     <xi:include href="xml/gstghostpad.xml" />
  84     <xi:include href="xml/gstiterator.xml" />
  85     <xi:include href="xml/gstmemory.xml" />
  86     <xi:include href="xml/gstmessage.xml" />
  87     <xi:include href="xml/gstmeta.xml" />
  88     <xi:include href="xml/gstminiobject.xml" />
  89     <xi:include href="xml/gstobject.xml" />
  90     <xi:include href="xml/gstpad.xml" />
  91     <xi:include href="xml/gstpadtemplate.xml" />
  92     <xi:include href="xml/gstparamspec.xml" />
  93     <xi:include href="xml/gstparse.xml" />
  94     <xi:include href="xml/gstpipeline.xml" />
  95     <xi:include href="xml/gstplugin.xml" />
  96     <xi:include href="xml/gstpluginfeature.xml" />
  97     <xi:include href="xml/gstpoll.xml" />
  98     <xi:include href="xml/gstpreset.xml" />
  99     <xi:include href="xml/gstprotection.xml" />
 100     <xi:include href="xml/gstquery.xml" />
 101     <xi:include href="xml/gstregistry.xml" />
 102     <xi:include href="xml/gstsegment.xml" />
 103     <xi:include href="xml/gststreams.xml" />
 104     <xi:include href="xml/gststreamcollection.xml" />
 105     <xi:include href="xml/gststructure.xml" />
 106     <xi:include href="xml/gstsystemclock.xml" />
 107     <xi:include href="xml/gsttaglist.xml" />
 108     <xi:include href="xml/gsttagsetter.xml" />
 109     <xi:include href="xml/gsttask.xml" />
 110     <xi:include href="xml/gsttaskpool.xml" />
 111     <xi:include href="xml/gsttoc.xml" />
 112     <xi:include href="xml/gsttocsetter.xml" />
 113     <xi:include href="xml/gsttypefind.xml" />
 114     <xi:include href="xml/gsttypefindfactory.xml" />
 115     <xi:include href="xml/gsturi.xml" />
 116     <xi:include href="xml/gsturihandler.xml" />
 117     <xi:include href="xml/gstutils.xml" />
 118     <xi:include href="xml/gstvalue.xml" />
 119     <xi:include href="xml/gstversion.xml" />
 120
 121   </chapter>
 122
 123   <chapter id="gstreamer-device-probing">
 124     <title>GStreamer Device Discovery and Device Probing</title>
 125     <xi:include href="xml/gstdevicemonitor.xml" />
 126     <xi:include href="xml/gstdevice.xml" />
 127     <xi:include href="xml/gstdeviceprovider.xml" />
 128     <xi:include href="xml/gstdeviceproviderfactory.xml" />
 129   </chapter>
 130
 131   <chapter id="gstreamer-support">
 132     <title>GStreamer Core Support</title>
 133     <para>
 134       Theses modules support the gstreamer core and plugin development.
 135       Application developers will rarely need to know about it.
 136     </para>
 137
 138     <xi:include href="xml/gstinfo.xml" />
 139     <xi:include href="xml/gsttracer.xml" />
 140     <xi:include href="xml/gsttracerfactory.xml" />
 141     <xi:include href="xml/gsttracerrecord.xml" />
 142
 143   </chapter>
 144
 145   <chapter id="gstreamer-hierarchy">
 146     <title>Object Hierarchy</title>
 147     <xi:include href="xml/tree_index.sgml"/>
 148   </chapter>
 149
 150   <index>
 151     <title>API Index</title>
 152     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 153   </index>
 154   <index role="deprecated">
 155     <title>Index of deprecated API</title>
 156     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 157   </index>
 158   <index>
 159     <title>Index of new API in 1.10</title>
 160     <xi:include href="xml/api-index-1.10.xml"><xi:fallback /></xi:include>
 161   </index>
 162   <index>
 163     <title>Index of new API in 1.8</title>
 164     <xi:include href="xml/api-index-1.8.xml"><xi:fallback /></xi:include>
 165   </index>
 166   <index>
 167     <title>Index of new API in 1.6</title>
 168     <xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include>
 169   </index>
 170   <index>
 171     <title>Index of new API in 1.4</title>
 172     <xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include>
 173   </index>
 174   <index>
 175     <title>Index of new API in 1.2.3</title>
 176     <xi:include href="xml/api-index-1.2.3.xml"><xi:fallback /></xi:include>
 177   </index>
 178   <index>
 179     <title>Index of new API in 1.2</title>
 180     <xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
 181   </index>
 182   <index>
 183     <title>Index of new API in 1.0.10</title>
 184     <xi:include href="xml/api-index-1.0.10.xml"><xi:fallback /></xi:include>
 185   </index>
 186   <index>
 187     <title>Index of new API in 1.0.5</title>
 188     <xi:include href="xml/api-index-1.0.5.xml"><xi:fallback /></xi:include>
 189   </index>
 190
 191   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 192
 193 </book>