a bunch of gtk-doc fixes
[platform/upstream/gstreamer.git] / docs / gst / gstreamer-docs.sgml
1 <!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
2
3 <!entity Gst SYSTEM "sgml/gst.sgml">
4 <!entity GstAutoplug SYSTEM "sgml/gstautoplug.sgml">
5 <!entity GstAutoplugFactory SYSTEM "sgml/gstautoplugfactory.sgml">
6 <!entity GstAtomic SYSTEM "sgml/gstatomic.sgml">
7 <!entity GstBin SYSTEM "sgml/gstbin.sgml">
8 <!entity GstData SYSTEM "sgml/gstdata.sgml">
9 <!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
10 <!entity GstEvent SYSTEM "sgml/gstevent.sgml">
11 <!entity GstBufferPool SYSTEM "sgml/gstbufferpool.sgml">
12 <!entity GstCpu SYSTEM "sgml/gstcpu.sgml">
13 <!entity GstElement SYSTEM "sgml/gstelement.sgml">
14 <!entity GstElementFactory SYSTEM "sgml/gstelementfactory.sgml">
15 <!entity GstFormat SYSTEM "sgml/gstformat.sgml">
16 <!entity GstInfo SYSTEM "sgml/gstinfo.sgml">
17 <!entity GstLog SYSTEM "sgml/gstlog.sgml">
18 <!entity GstMemChunk SYSTEM "sgml/gstmemchunk.sgml">
19 <!entity GstObject SYSTEM "sgml/gstobject.sgml">
20 <!entity GstPad SYSTEM "sgml/gstpad.sgml">
21 <!entity GstPadTemplate SYSTEM "sgml/gstpadtemplate.sgml">
22 <!entity GstParse SYSTEM "sgml/gstparse.sgml">
23 <!entity GstProbe SYSTEM "sgml/gstprobe.sgml">
24 <!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
25 <!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
26 <!entity GstPluginFeature SYSTEM "sgml/gstpluginfeature.sgml">
27 <!entity GstQuery SYSTEM "sgml/gstquery.sgml">
28 <!entity GstThread SYSTEM "sgml/gstthread.sgml">
29 <!entity GstRegistry SYSTEM "sgml/gstregistry.sgml">
30 <!entity GstRegistryPool SYSTEM "sgml/gstregistrypool.sgml">
31 <!entity GstScheduler SYSTEM "sgml/gstscheduler.sgml">
32 <!entity GstSchedulerFactory SYSTEM "sgml/gstschedulerfactory.sgml">
33 <!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
34 <!entity GstType SYSTEM "sgml/gsttype.sgml">
35 <!entity GstTypeFactory SYSTEM "sgml/gsttypefactory.sgml">
36 <!entity GstCaps SYSTEM "sgml/gstcaps.sgml">
37 <!entity GstProps SYSTEM "sgml/gstprops.sgml">
38 <!entity GstClock SYSTEM "sgml/gstclock.sgml">
39 <!entity GstSystemClock SYSTEM "sgml/gstsystemclock.sgml">
40 <!entity GstUtils SYSTEM "sgml/gstutils.sgml">
41 <!entity GstUri SYSTEM "sgml/gsturi.sgml">
42 <!entity GstXML SYSTEM "sgml/gstxml.sgml">
43 <!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
44 <!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
45 <!entity GstIndex SYSTEM "sgml/gstindex.sgml">
46 <!entity GstIndexFactory SYSTEM "sgml/gstindexfactory.sgml">
47 <!entity cothreads SYSTEM "sgml/cothreads.sgml">
48
49 <!entity GstStaticAutoplug SYSTEM "sgml/gststaticautoplug.sgml">
50 <!entity GstStaticAutoplugRender SYSTEM "sgml/gststaticautoplugrender.sgml">
51 <!entity GstAggregator SYSTEM "sgml/gstaggregator.sgml">
52 <!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
53 <!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
54 <!entity GstFileSrc SYSTEM "sgml/gstfilesrc.sgml">
55 <!entity GstDiskSink SYSTEM "sgml/gstdisksink.sgml">
56 <!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
57 <!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
58 <!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
59 <!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
60 <!entity GstStatistics SYSTEM "sgml/gststatistics.sgml">
61 <!entity GstMD5Sink SYSTEM "sgml/gstmd5sink.sgml">
62 <!entity GstTee SYSTEM "sgml/gsttee.sgml">
63
64 <!entity gstreamer-tree-index SYSTEM "sgml/tree_index.sgml">
65 ]>
66
67
68 <book>
69   <bookinfo>
70     <title>GStreamer Core Reference Manual</title>
71   </bookinfo>
72   <chapter id="gstreamer-support">
73     <title>GStreamer Core Support</title>
74     <para>
75     </para>
76
77     &cothreads;
78     &GstAtomic;
79     &GstMemChunk;
80
81   </chapter>
82   <chapter id="gstreamer">
83     <title>GStreamer Core Library</title>
84
85     <para>libgst.la provides all the core GStreamer services,
86 including initialization, plugin management and types, as 
87 well as the object hierarchy that defines elements and bins, along
88 with some more specialized elements.</para>
89
90     &Gst;
91     &GstAutoplug;
92     &GstAutoplugFactory;
93     &GstBin;
94     &GstBuffer;
95     &GstBufferPool;
96     &GstCaps;
97     &GstClock;
98     &GstCpu;
99     &GstData;
100     &GstElement;
101     &GstElementFactory;
102     &GstEvent;
103     &GstFormat;
104     &GstIndex;
105     &GstIndexFactory;
106     &GstInfo;
107     &GstObject;
108     &GstPad;
109     &GstPadTemplate;
110     &GstParse;
111     &GstPipeline;
112     &GstPlugin;
113     &GstPluginFeature;
114     &GstProbe;
115     &GstProps;
116     &GstQuery;
117     &GstQueue;
118     &GstRegistry;
119     &GstRegistryPool;
120     &GstScheduler;
121     &GstSchedulerFactory;
122     &GstSystemClock;
123     &GstThread;
124     &GstType;
125     &GstTypeFactory;
126     &GstTypeFind;
127     &GstUri;
128     &GstUtils;
129     &GstXML;
130
131   </chapter>
132
133   <chapter id="element-types">
134     <title>GStreamer Standard Elements</title>
135
136     <para>
137       libgstelements.la provide some basic elements like a disk source
138       and sink. The use of these elements is strictly though the g_object_get() and
139       g_object_set() functions and the GStreamer Core Library functions.
140     </para>
141
142 <!--
143     &GstAggregator;
144
145     &GstFakeSrc;
146     &GstFakeSink;
147
148     &GstFileSrc;
149     &GstDiskSink;
150
151     &GstFdSrc;
152     &GstFdSink;
153
154     &GstPipefilter;
155     &GstIdentity;
156
157     &GstStatistics;
158     &GstMD5Sink;
159
160     &GstTee;
161     -->
162   </chapter>
163
164   <chapter id="autopluggers">
165     <title>GStreamer Autopluggers</title>
166
167     <para>the autopluggers provide a way to automatically construct elements based on
168     sink and src capabilities</para>
169
170     &GstStaticAutoplug;
171     &GstStaticAutoplugRender;
172   </chapter>
173
174   <chapter id="gst-index">
175     <title>Index</title>
176
177     <sect1>
178       <title>Object Hierarchy</title>
179       &gstreamer-tree-index;
180     </sect1>
181   </chapter>
182 </book>