Merge remote-tracking branch 'origin/master' into 0.11
[platform/upstream/gstreamer.git] / 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_MAJORMINOR; Core Reference Manual</title>
12     <releaseinfo>
13       for GStreamer Core &GST_MAJORMINOR; (&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_MAJORMINOR;.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/gstatomicqueue.xml" />
61     <xi:include href="xml/gstbin.xml" />
62     <xi:include href="xml/gstbuffer.xml" />
63     <xi:include href="xml/gstbufferlist.xml" />
64     <xi:include href="xml/gstbufferpool.xml" />
65     <xi:include href="xml/gstbus.xml" />
66     <xi:include href="xml/gstcaps.xml" />
67     <xi:include href="xml/gstchildproxy.xml" />
68     <xi:include href="xml/gstclock.xml" />
69     <xi:include href="xml/gstconfig.xml" />
70     <xi:include href="xml/gstcontrolsource.xml" />
71     <xi:include href="xml/gstdatetime.xml" />
72     <xi:include href="xml/gstelement.xml" />
73     <xi:include href="xml/gstelementfactory.xml" />
74     <xi:include href="xml/gsterror.xml" />
75     <xi:include href="xml/gstevent.xml" />
76     <xi:include href="xml/gstformat.xml" />
77     <xi:include href="xml/gstghostpad.xml" />
78     <xi:include href="xml/gstindex.xml" />
79     <xi:include href="xml/gstindexfactory.xml" />
80     <xi:include href="xml/gstiterator.xml" />
81     <xi:include href="xml/gstmemory.xml" />
82     <xi:include href="xml/gstmessage.xml" />
83     <xi:include href="xml/gstmeta.xml" />
84     <xi:include href="xml/gstminiobject.xml" />
85     <xi:include href="xml/gstobject.xml" />
86     <xi:include href="xml/gstpad.xml" />
87     <xi:include href="xml/gstpadtemplate.xml" />
88     <xi:include href="xml/gstparamspec.xml" />
89     <xi:include href="xml/gstparse.xml" />
90     <xi:include href="xml/gstpipeline.xml" />
91     <xi:include href="xml/gstplugin.xml" />
92     <xi:include href="xml/gstpluginfeature.xml" />
93     <xi:include href="xml/gstpoll.xml" />
94     <xi:include href="xml/gstpreset.xml" />
95     <xi:include href="xml/gstquery.xml" />
96     <xi:include href="xml/gstregistry.xml" />
97     <xi:include href="xml/gstsegment.xml" />
98     <xi:include href="xml/gststructure.xml" />
99     <xi:include href="xml/gstsystemclock.xml" />
100     <xi:include href="xml/gsttaglist.xml" />
101     <xi:include href="xml/gsttagsetter.xml" />
102     <xi:include href="xml/gsttask.xml" />
103     <xi:include href="xml/gsttaskpool.xml" />
104     <xi:include href="xml/gsttypefind.xml" />
105     <xi:include href="xml/gsttypefindfactory.xml" />
106     <xi:include href="xml/gsturihandler.xml" />
107     <xi:include href="xml/gstutils.xml" />
108     <xi:include href="xml/gstvalue.xml" />
109     <xi:include href="xml/gstversion.xml" />
110
111   </chapter>
112
113   <chapter id="gstreamer-support">
114     <title>GStreamer Core Support</title>
115     <para>
116       Theses modules support the gstreamer core and plugin development.
117       Application developers will rarely need to know about it.
118     </para>
119
120     <xi:include href="xml/gstinfo.xml" />
121     <xi:include href="xml/gsttrace.xml" />
122
123   </chapter>
124
125   <chapter id="gstreamer-hierarchy">
126     <title>Object Hierarchy</title>
127     <xi:include href="xml/tree_index.sgml"/>
128   </chapter>
129
130   <index id="api-index-full">
131     <title>API Index</title>
132     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
133   </index>
134   <index id="api-index-deprecated" role="deprecated">
135     <title>Index of deprecated API</title>
136     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
137   </index>
138
139   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
140
141 </book>