summaryrefslogtreecommitdiff
path: root/docs/gst/gstreamer-docs.sgml
blob: eac3acb36a8776a87e5659bea77c5334f75d49ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY hash "#">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>GStreamer &GST_API_VERSION; Core Reference Manual</title>
    <releaseinfo>
      for GStreamer Core &GST_API_VERSION; (&GST_VERSION;)
      The latest version of this documentation can be found on-line at
      <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>.
    </releaseinfo>
  </bookinfo>

  <chapter id="gstreamer">

    <title>GStreamer Overview</title>
    <para>
GStreamer is a streaming media framework.
It uses graphs of elements which operate on data.
The functionality to process media is provided by plug-ins which provide
features like elements, typefinding, and so on.
This allows new functionality to be added simply by installing new plug-ins.
    </para>

    <para>
GStreamer is cross-platform and works on most UNIX-like platforms as well as
Windows.  It is released under the GNU Library General Public License
(GNU LGPL).
    </para>
    
    <mediaobject>
      <imageobject>
        <imagedata fileref="gst-universe.svg" format="SVG"/>
      </imageobject>
      <caption>
        <para>Relation between gstreamer core objects.</para>
      </caption>
    </mediaobject>

    <xi:include href="building.xml" />
    <xi:include href="running.xml" />
  </chapter>

  <chapter id="libgstreamer">
    <title>GStreamer Core Library</title>

    <para>
      libgstreamer-&GST_API_VERSION;.so provides all the core GStreamer services,
      including initialization, plugin management and types,
      as well as the object hierarchy that defines elements and bins,
      along with some more specialized elements.
    </para>

    <xi:include href="xml/gst.xml" />
    <xi:include href="xml/gstallocator.xml" />
    <xi:include href="xml/gstatomicqueue.xml" />
    <xi:include href="xml/gstbin.xml" />
    <xi:include href="xml/gstbuffer.xml" />
    <xi:include href="xml/gstbufferlist.xml" />
    <xi:include href="xml/gstbufferpool.xml" />
    <xi:include href="xml/gstbus.xml" />
    <xi:include href="xml/gstcaps.xml" />
    <xi:include href="xml/gstcapsfeatures.xml" />
    <xi:include href="xml/gstsample.xml" />
    <xi:include href="xml/gstchildproxy.xml" />
    <xi:include href="xml/gstclock.xml" />
    <xi:include href="xml/gstconfig.xml" />
    <xi:include href="xml/gstcontext.xml" />
    <xi:include href="xml/gstcontrolbinding.xml" />
    <xi:include href="xml/gstcontrolsource.xml" />
    <xi:include href="xml/gstdatetime.xml" />
    <xi:include href="xml/gstelement.xml" />
    <xi:include href="xml/gstelementfactory.xml" />
    <xi:include href="xml/gsterror.xml" />
    <xi:include href="xml/gstevent.xml" />
    <xi:include href="xml/gstformat.xml" />
    <xi:include href="xml/gstghostpad.xml" />
    <xi:include href="xml/gstiterator.xml" />
    <xi:include href="xml/gstmemory.xml" />
    <xi:include href="xml/gstmessage.xml" />
    <xi:include href="xml/gstmeta.xml" />
    <xi:include href="xml/gstminiobject.xml" />
    <xi:include href="xml/gstobject.xml" />
    <xi:include href="xml/gstpad.xml" />
    <xi:include href="xml/gstpadtemplate.xml" />
    <xi:include href="xml/gstparamspec.xml" />
    <xi:include href="xml/gstparse.xml" />
    <xi:include href="xml/gstpipeline.xml" />
    <xi:include href="xml/gstplugin.xml" />
    <xi:include href="xml/gstpluginfeature.xml" />
    <xi:include href="xml/gstpoll.xml" />
    <xi:include href="xml/gstpreset.xml" />
    <xi:include href="xml/gstquery.xml" />
    <xi:include href="xml/gstregistry.xml" />
    <xi:include href="xml/gstsegment.xml" />
    <xi:include href="xml/gststructure.xml" />
    <xi:include href="xml/gstsystemclock.xml" />
    <xi:include href="xml/gsttaglist.xml" />
    <xi:include href="xml/gsttagsetter.xml" />
    <xi:include href="xml/gsttask.xml" />
    <xi:include href="xml/gsttaskpool.xml" />
    <xi:include href="xml/gsttoc.xml" />
    <xi:include href="xml/gsttocsetter.xml" />
    <xi:include href="xml/gsttypefind.xml" />
    <xi:include href="xml/gsttypefindfactory.xml" />
    <xi:include href="xml/gsturihandler.xml" />
    <xi:include href="xml/gstutils.xml" />
    <xi:include href="xml/gstvalue.xml" />
    <xi:include href="xml/gstversion.xml" />

  </chapter>

  <chapter id="gstreamer-support">
    <title>GStreamer Core Support</title>
    <para>
      Theses modules support the gstreamer core and plugin development.
      Application developers will rarely need to know about it.
    </para>

    <xi:include href="xml/gstinfo.xml" />

  </chapter>

  <chapter id="gstreamer-hierarchy">
    <title>Object Hierarchy</title>
    <xi:include href="xml/tree_index.sgml"/>
  </chapter>

  <index id="api-index-full">
    <title>API Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-deprecated" role="deprecated">
    <title>Index of deprecated API</title>
    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
  </index>

  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>

</book>