2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4 <!ENTITY % version-entities SYSTEM "version.entities">
6 <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
9 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
11 <title>GStreamer &GST_API_VERSION; Library Reference Manual</title>
13 for GStreamer Library &GST_API_VERSION; (&GST_VERSION;)
14 The latest version of this documentation can be found on-line at
15 <ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/</ulink>.
18 <part id="gstreamer-libs">
19 <title>GStreamer Libraries</title>
22 To ease the creation of plugins, a library system was created. The most common
23 functions for a plugin can be found in a library.
26 GStreamer provides some standard libraries you can use to create plugins.
29 <chapter id="gstreamer-base">
30 <title>GStreamer Base and Utillity Classes</title>
32 libgstbase-&GST_API_VERSION;.so provides some base classes to be extended
33 by elements and utillity classes that are most useful for plugin developers.
36 <xi:include href="xml/gstbaseparse.xml" />
37 <xi:include href="xml/gstbasesrc.xml" />
38 <xi:include href="xml/gstbasesink.xml" />
39 <xi:include href="xml/gstbasetransform.xml" />
40 <xi:include href="xml/gstpushsrc.xml" />
42 <xi:include href="xml/gstadapter.xml" />
43 <xi:include href="xml/gstbitreader.xml" />
44 <xi:include href="xml/gstbytereader.xml" />
45 <xi:include href="xml/gstbytewriter.xml" />
46 <xi:include href="xml/gstcollectpads.xml" />
47 <xi:include href="xml/gstflowcombiner.xml" />
48 <xi:include href="xml/gsttypefindhelper.xml" />
49 <xi:include href="xml/gstdataqueue.xml" />
50 <xi:include href="xml/gstqueuearray.xml" />
53 <chapter id="gstreamer-control">
54 <title>GStreamer Dynamic Parameter Control</title>
56 libgstcontroller-&GST_API_VERSION;.so provides functionality to animate
57 element properties over time.
60 <xi:include href="xml/gstargbcontrolbinding.xml" />
61 <xi:include href="xml/gstdirectcontrolbinding.xml" />
63 <xi:include href="xml/gsttimedvaluecontrolsource.xml" />
64 <xi:include href="xml/gstinterpolationcontrolsource.xml" />
65 <xi:include href="xml/gstlfocontrolsource.xml" />
66 <xi:include href="xml/gsttriggercontrolsource.xml" />
69 <chapter id="gstreamer-net">
70 <title>GStreamer Network Classes</title>
72 libgstnet-&GST_API_VERSION;.so provides network elements and objects.
75 <xi:include href="xml/gstnetaddressmeta.xml" />
76 <xi:include href="xml/gstnetclientclock.xml" />
77 <xi:include href="xml/gstnettimepacket.xml" />
78 <xi:include href="xml/gstnettimeprovider.xml" />
79 <xi:include href="xml/gstptpclock.xml" />
82 <chapter id="gstreamer-check">
83 <title>GStreamer Check Unit Testing</title>
85 libgstcheck-&GST_API_VERSION;.so provides functionality for writing
86 unit tests that use the check framework.
89 <xi:include href="xml/gstcheck.xml" />
90 <xi:include href="xml/gstcheckbufferstraw.xml" />
91 <xi:include href="xml/gstcheckconsistencychecker.xml" />
92 <xi:include href="xml/gsttestclock.xml" />
96 <chapter id="gstreamer-hierarchy">
97 <title>Object Hierarchy</title>
98 <xi:include href="xml/tree_index.sgml"/>
101 <index id="api-index-full">
102 <title>API Index</title>
103 <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
105 <index id="api-index-deprecated" role="deprecated">
106 <title>Index of deprecated API</title>
107 <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
110 <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>