gstreamer-docs.sgml 5.09 KB
Newer Older
1 2 3 4 5 6 7
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY Gst SYSTEM "xml/gst.xml">
<!ENTITY GstAutoplug SYSTEM "xml/gstautoplug.xml">
<!ENTITY GstAtomic SYSTEM "xml/gstatomic.xml">
<!ENTITY GstBin SYSTEM "xml/gstbin.xml">
8
<!ENTITY GstConfig SYSTEM "xml/gstconfig.xml">
9 10 11
<!ENTITY GstData SYSTEM "xml/gstdata.xml">
<!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
<!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
12
<!ENTITY GstBufferPool SYSTEM "xml/gstbuffer.xml">
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
<!ENTITY GstCpu SYSTEM "xml/gstcpu.xml">
<!ENTITY GstElement SYSTEM "xml/gstelement.xml">
<!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
<!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
<!ENTITY GstLog SYSTEM "xml/gstlog.xml">
<!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml">
<!ENTITY GstObject SYSTEM "xml/gstobject.xml">
<!ENTITY GstPad SYSTEM "xml/gstpad.xml">
<!ENTITY GstParse SYSTEM "xml/gstparse.xml">
<!ENTITY GstProbe SYSTEM "xml/gstprobe.xml">
<!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
<!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
<!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
<!ENTITY GstThread SYSTEM "xml/gstthread.xml">
<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
<!ENTITY GstRegistryPool SYSTEM "xml/gstregistrypool.xml">
<!ENTITY GstScheduler SYSTEM "xml/gstscheduler.xml">
<!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
<!ENTITY GstType SYSTEM "xml/gsttype.xml">
33
<!ENTITY GstTypeFactory SYSTEM "xml/gsttype.xml">
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
<!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
<!ENTITY GstProps SYSTEM "xml/gstprops.xml">
<!ENTITY GstClock SYSTEM "xml/gstclock.xml">
<!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
<!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
<!ENTITY GstUri SYSTEM "xml/gsturi.xml">
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
<!-- these are elements without API docs
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
<!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
-->
<!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
<!ENTITY cothreads SYSTEM "xml/cothreads.xml">

<!-- if none of the API is documented, these shouldn't go in
<!ENTITY GstStaticAutoplug SYSTEM "xml/gststaticautoplug.xml">
<!ENTITY GstStaticAutoplugRender SYSTEM "xml/gststaticautoplugrender.xml">
-->
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
<!ENTITY GstFakeSink SYSTEM "xml/gstfakesink.xml">
<!ENTITY GstFileSrc SYSTEM "xml/gstfilesrc.xml">
<!ENTITY GstDiskSink SYSTEM "xml/gstdisksink.xml">
<!ENTITY GstFdSrc SYSTEM "xml/gstfdsrc.xml">
<!ENTITY GstFdSink SYSTEM "xml/gstfdsink.xml">
<!ENTITY GstIdentity SYSTEM "xml/gstidentity.xml">
<!ENTITY GstPipefilter SYSTEM "xml/gstpipefilter.xml">
<!ENTITY GstStatistics SYSTEM "xml/gststatistics.xml">
<!ENTITY GstMD5Sink SYSTEM "xml/gstmd5sink.xml">
<!ENTITY GstTee SYSTEM "xml/gsttee.xml">

<!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.xml">
66 67

<!ENTITY hash "#">
68 69 70
]>
<book>
  <bookinfo>
71
    <title>GStreamer Core Reference Manual</title>
72
  </bookinfo>
Wim Taymans's avatar
Wim Taymans committed
73 74 75 76 77 78 79 80 81 82
  <chapter id="gstreamer-support">
    <title>GStreamer Core Support</title>
    <para>
    </para>

    &cothreads;
    &GstAtomic;
    &GstMemChunk;

  </chapter>
83 84 85 86
  <chapter id="gstreamer">
    <title>GStreamer Core Library</title>

    <para>libgst.la provides all the core GStreamer services,
87
including initialization, plugin management and types, as 
88
well as the object hierarchy that defines elements and bins, along
89 90 91
with some more specialized elements.</para>

    &Gst;
Wim Taymans's avatar
Wim Taymans committed
92
    &GstAutoplug;
Wim Taymans's avatar
Wim Taymans committed
93
    &GstBin;
94
    &GstBuffer;
95
    &GstConfig;
Wim Taymans's avatar
Wim Taymans committed
96
    &GstCaps;
97
    &GstClock;
Wim Taymans's avatar
Wim Taymans committed
98
    &GstCpu;
99
    &GstData;
Wim Taymans's avatar
Wim Taymans committed
100
    &GstElement;
101
    &GstEvent;
Wim Taymans's avatar
Wim Taymans committed
102
    &GstFormat;
Wim Taymans's avatar
Wim Taymans committed
103
    &GstIndex;
Wim Taymans's avatar
Wim Taymans committed
104 105
    &GstInfo;
    &GstObject;
106
    &GstPad;
Wim Taymans's avatar
Wim Taymans committed
107 108
    &GstParse;
    &GstPipeline;
109
    &GstPlugin;
110
    &GstPluginFeature;
Wim Taymans's avatar
Wim Taymans committed
111
    &GstProbe;
Wim Taymans's avatar
Wim Taymans committed
112
    &GstProps;
Wim Taymans's avatar
Wim Taymans committed
113
    &GstQuery;
114 115
<!-- no API docs
    &GstQueue; -->
Wim Taymans's avatar
Wim Taymans committed
116
    &GstRegistry;
Wim Taymans's avatar
Wim Taymans committed
117
    &GstRegistryPool;
Wim Taymans's avatar
Wim Taymans committed
118
    &GstScheduler;
Wim Taymans's avatar
Wim Taymans committed
119
    &GstSystemClock;
120
    &GstThread;
121
    &GstType;
122 123
<!-- no API docs
    &GstTypeFind; -->
Wim Taymans's avatar
Wim Taymans committed
124
    &GstUri;
125
    &GstUtils;
Wim Taymans's avatar
Wim Taymans committed
126
    &GstXML;
Wim Taymans's avatar
Wim Taymans committed
127

128 129 130
  </chapter>

  <chapter id="element-types">
131 132 133 134
    <title>GStreamer Standard Elements</title>

    <para>
      libgstelements.la provide some basic elements like a disk source
135 136
      and sink. The use of these elements is strictly though the g_object_get() and
      g_object_set() functions and the GStreamer Core Library functions.
137 138
    </para>

Wim Taymans's avatar
Wim Taymans committed
139
<!--
140 141
    &GstAggregator;

142 143 144
    &GstFakeSrc;
    &GstFakeSink;

145
    &GstFileSrc;
Wim Taymans's avatar
Wim Taymans committed
146 147
    &GstDiskSink;

148
    &GstFdSrc;
149 150
    &GstFdSink;

151
    &GstPipefilter;
152
    &GstIdentity;
153

Wim Taymans's avatar
Wim Taymans committed
154
    &GstStatistics;
Wim Taymans's avatar
Wim Taymans committed
155
    &GstMD5Sink;
Wim Taymans's avatar
Wim Taymans committed
156

Wim Taymans's avatar
Wim Taymans committed
157
    &GstTee;
Wim Taymans's avatar
Wim Taymans committed
158
    -->
159 160
  </chapter>

161
<!-- no API is documented of these elements
Wim Taymans's avatar
Wim Taymans committed
162
  <chapter id="autopluggers">
163
    <title>GStreamer Autopluggers</title>
Wim Taymans's avatar
Wim Taymans committed
164 165 166 167 168 169 170

    <para>the autopluggers provide a way to automatically construct elements based on
    sink and src capabilities</para>

    &GstStaticAutoplug;
    &GstStaticAutoplugRender;
  </chapter>
171
-->
Wim Taymans's avatar
Wim Taymans committed
172

173
<!--
174 175 176 177 178 179 180 181
  <chapter id="gst-index">
    <title>Index</title>

    <sect1>
      <title>Object Hierarchy</title>
      &gstreamer-tree-index;
    </sect1>
  </chapter>
182
-->
183
</book>