Documentation updates
[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 GstInfo SYSTEM "sgml/gstinfo.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 GstLog SYSTEM "sgml/gstlog.sgml">
16 <!entity GstObject SYSTEM "sgml/gstobject.sgml">
17 <!entity GstPad SYSTEM "sgml/gstpad.sgml">
18 <!entity GstPadTemplate SYSTEM "sgml/gstpadtemplate.sgml">
19 <!entity GstParse SYSTEM "sgml/gstparse.sgml">
20 <!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
21 <!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
22 <!entity GstPluginFeature SYSTEM "sgml/gstpluginfeature.sgml">
23 <!entity GstThread SYSTEM "sgml/gstthread.sgml">
24 <!entity GstScheduler SYSTEM "sgml/gstscheduler.sgml">
25 <!entity GstSchedulerFactory SYSTEM "sgml/gstschedulerfactory.sgml">
26 <!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
27 <!entity GstType SYSTEM "sgml/gsttype.sgml">
28 <!entity GstTypeFactory SYSTEM "sgml/gsttypefactory.sgml">
29 <!entity GstCaps SYSTEM "sgml/gstcaps.sgml">
30 <!entity GstProps SYSTEM "sgml/gstprops.sgml">
31 <!entity GstClock SYSTEM "sgml/gstclock.sgml">
32 <!entity GstSystemClock SYSTEM "sgml/gstsystemclock.sgml">
33 <!entity GstUtils SYSTEM "sgml/gstutils.sgml">
34 <!entity GstXML SYSTEM "sgml/gstxml.sgml">
35 <!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
36 <!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
37 <!entity GstTimeCache SYSTEM "sgml/gsttimecache.sgml">
38 <!entity cothreads SYSTEM "sgml/cothreads.sgml">
39
40 <!entity GstStaticAutoplug SYSTEM "sgml/gststaticautoplug.sgml">
41 <!entity GstStaticAutoplugRender SYSTEM "sgml/gststaticautoplugrender.sgml">
42 <!entity GstAggregator SYSTEM "sgml/gstaggregator.sgml">
43 <!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
44 <!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
45 <!entity GstFileSrc SYSTEM "sgml/gstfilesrc.sgml">
46 <!entity GstDiskSink SYSTEM "sgml/gstdisksink.sgml">
47 <!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
48 <!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
49 <!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
50 <!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
51 <!entity GstStatistics SYSTEM "sgml/gststatistics.sgml">
52 <!entity GstMD5Sink SYSTEM "sgml/gstmd5sink.sgml">
53 <!entity GstTee SYSTEM "sgml/gsttee.sgml">
54
55 <!entity gstreamer-tree-index SYSTEM "sgml/tree_index.sgml">
56 ]>
57
58
59 <book>
60   <bookinfo>
61     <title>GStreamer Library Reference Manual (Core)</title>
62   </bookinfo>
63   <chapter id="gstreamer">
64     <title>GStreamer Core Library</title>
65
66     <para>libgst.la provides all the core GStreamer services,
67 including initialization, plugin management and types, as 
68 well as the object hiarchy that defines elements and bins, along
69 with some more specialized elements.</para>
70
71     &Gst;
72     &GstAutoplug;
73     &GstAutoplugFactory;
74     &GstBin;
75     &GstBuffer;
76     &GstBufferPool;
77     &GstCaps;
78     &GstClock;
79     &GstCpu;
80     &GstData;
81     &GstElement;
82     &GstElementFactory;
83     &GstEvent;
84     &GstInfo;
85     &GstObject;
86     &GstPad;
87     &GstPadTemplate;
88     &GstParse;
89     &GstPipeline;
90     &GstPlugin;
91     &GstPluginFeature;
92     &GstProps;
93     &GstQueue;
94     &GstScheduler;
95     &GstSchedulerFactory;
96     &GstSystemClock;
97     &GstThread;
98     &GstTimeCache;
99     &GstType;
100     &GstTypeFactory;
101     &GstTypeFind;
102     &GstUtils;
103     &GstXML;
104
105     &cothreads;
106   </chapter>
107
108   <chapter id="element-types">
109     <title>GStreamer Standard Elements</title>
110
111     <para>
112       libgstelements.la provide some basic elements like a disk source
113       and sink. The use of these elements is strictly though the g_object_get() and
114       g_object_set() functions and the GStreamer Core Library functions.
115     </para>
116
117     &GstAggregator;
118
119     &GstFakeSrc;
120     &GstFakeSink;
121
122     &GstFileSrc;
123     &GstDiskSink;
124
125     &GstFdSrc;
126     &GstFdSink;
127
128     &GstPipefilter;
129     &GstIdentity;
130
131     &GstStatistics;
132     &GstMD5Sink;
133
134     &GstTee;
135   </chapter>
136
137   <chapter id="autopluggers">
138     <title>GStreamer Autopluggers</title>
139
140     <para>the autopluggers provide a way to automatically construct elements based on
141     sink and src capabilities</para>
142
143     &GstStaticAutoplug;
144     &GstStaticAutoplugRender;
145   </chapter>
146
147   <chapter id="gst-index">
148     <title>Index</title>
149
150     <sect1>
151       <title>Object Hierarchy</title>
152       &gstreamer-tree-index;
153     </sect1>
154   </chapter>
155 </book>