Updated the API docs
[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 GstUtils SYSTEM "sgml/gstutils.sgml">
33 <!entity GstXML SYSTEM "sgml/gstxml.sgml">
34 <!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
35 <!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
36 <!entity GstTimeCache SYSTEM "sgml/gsttimecache.sgml">
37 <!entity cothreads SYSTEM "sgml/cothreads.sgml">
38
39 <!entity GstStaticAutoplug SYSTEM "sgml/gststaticautoplug.sgml">
40 <!entity GstStaticAutoplugRender SYSTEM "sgml/gststaticautoplugrender.sgml">
41 <!entity GstAggregator SYSTEM "sgml/gstaggregator.sgml">
42 <!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
43 <!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
44 <!entity GstFileSrc SYSTEM "sgml/gstfilesrc.sgml">
45 <!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
46 <!entity GstDiskSink SYSTEM "sgml/gstdisksink.sgml">
47 <!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml">
48 <!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
49 <!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
50 <!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
51 <!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
52 <!entity GstStatistics SYSTEM "sgml/gststatistics.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     &GstThread;
97     &GstTimeCache;
98     &GstType;
99     &GstTypeFactory;
100     &GstTypeFind;
101     &GstUtils;
102     &GstXML;
103
104     &cothreads;
105   </chapter>
106
107   <chapter id="element-types">
108     <title>GStreamer Standard Elements</title>
109
110     <para>
111       libgstelements.la provide some basic elements like a disk source
112       and sink. The use of these elements is strictly though the g_object_get() and
113       g_object_set() functions and the GStreamer Core Library functions.
114     </para>
115
116     &GstAggregator;
117
118     &GstFakeSrc;
119     &GstFakeSink;
120
121     <!-- &GstFileSrc; -->
122     &GstDiskSrc;
123     &GstDiskSink;
124
125     &GstHttpSrc;
126     
127     &GstFdSrc;
128     &GstFdSink;
129
130     &GstPipefilter;
131     &GstIdentity;
132
133     &GstStatistics;
134
135     &GstTee;
136   </chapter>
137
138   <chapter id="autopluggers">
139     <title>GStreamer Autoppluggers</title>
140
141     <para>the autopluggers provide a way to automatically construct elements based on
142     sink and src capabilities</para>
143
144     &GstStaticAutoplug;
145     &GstStaticAutoplugRender;
146   </chapter>
147
148   <chapter id="gst-index">
149     <title>Index</title>
150
151     <sect1>
152       <title>Object Hierarchy</title>
153       &gstreamer-tree-index;
154     </sect1>
155   </chapter>
156 </book>