• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0"?>
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">
5%version-entities;
6<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
7<!ENTITY hash "#">
8]>
9<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
10  <bookinfo>
11    <title>GStreamer &GST_API_VERSION; Library Reference Manual</title>
12    <releaseinfo>
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>.
16    </releaseinfo>
17  </bookinfo>
18  <part id="gstreamer-libs">
19    <title>GStreamer Libraries</title>
20
21    <para>
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.
24    </para>
25    <para>
26      GStreamer provides some standard libraries you can use to create plugins.
27    </para>
28
29    <chapter id="gstreamer-base">
30      <title>GStreamer Base and Utility Classes</title>
31      <para>
32        libgstbase-&GST_API_VERSION;.so provides some base classes to be extended
33        by elements and utility classes that are most useful for plugin developers.
34      </para>
35
36      <xi:include href="xml/gstaggregator.xml" />
37      <xi:include href="xml/gstaggregatorpad.xml" />
38
39      <xi:include href="xml/gstbaseparse.xml" />
40      <xi:include href="xml/gstbasesrc.xml" />
41      <xi:include href="xml/gstbasesink.xml" />
42      <xi:include href="xml/gstbasetransform.xml" />
43      <xi:include href="xml/gstpushsrc.xml" />
44
45      <xi:include href="xml/gstadapter.xml" />
46      <xi:include href="xml/gstbitreader.xml" />
47      <xi:include href="xml/gstbitwriter.xml" />
48      <xi:include href="xml/gstbytereader.xml" />
49      <xi:include href="xml/gstbytewriter.xml" />
50      <xi:include href="xml/gstcollectpads.xml" />
51      <xi:include href="xml/gstflowcombiner.xml" />
52      <xi:include href="xml/gsttypefindhelper.xml" />
53      <xi:include href="xml/gstdataqueue.xml" />
54      <xi:include href="xml/gstqueuearray.xml" />
55    </chapter>
56
57    <chapter id="gstreamer-control">
58      <title>GStreamer Dynamic Parameter Control</title>
59      <para>
60        libgstcontroller-&GST_API_VERSION;.so provides functionality to animate
61        element properties over time.
62      </para>
63
64			<xi:include href="xml/gstargbcontrolbinding.xml" />
65			<xi:include href="xml/gstdirectcontrolbinding.xml" />
66			<xi:include href="xml/gstproxycontrolbinding.xml" />
67
68      <xi:include href="xml/gsttimedvaluecontrolsource.xml" />
69      <xi:include href="xml/gstinterpolationcontrolsource.xml" />
70      <xi:include href="xml/gstlfocontrolsource.xml" />
71      <xi:include href="xml/gsttriggercontrolsource.xml" />
72    </chapter>
73
74    <chapter id="gstreamer-net">
75      <title>GStreamer Network Classes</title>
76      <para>
77        libgstnet-&GST_API_VERSION;.so provides network elements and objects.
78      </para>
79
80      <xi:include href="xml/gstnetaddressmeta.xml" />
81      <xi:include href="xml/gstnetclientclock.xml" />
82      <xi:include href="xml/gstnetcontrolmessagemeta.xml" />
83      <xi:include href="xml/gstnettimepacket.xml" />
84      <xi:include href="xml/gstnettimeprovider.xml" />
85      <xi:include href="xml/gstptpclock.xml" />
86    </chapter>
87
88    <chapter id="gstreamer-check">
89      <title>GStreamer Check Unit Testing</title>
90      <para>
91        libgstcheck-&GST_API_VERSION;.so provides functionality for writing
92        unit tests that use the check framework.
93      </para>
94
95      <xi:include href="xml/gstcheck.xml" />
96      <xi:include href="xml/gstcheckbufferstraw.xml" />
97      <xi:include href="xml/gstcheckconsistencychecker.xml" />
98      <xi:include href="xml/gstharness.xml" />
99      <xi:include href="xml/gsttestclock.xml" />
100    </chapter>
101  </part>
102
103  <chapter id="gstreamer-hierarchy">
104    <title>Object Hierarchy</title>
105    <xi:include href="xml/tree_index.sgml"/>
106  </chapter>
107
108  <index>
109    <title>API Index</title>
110    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
111  </index>
112  <index role="deprecated">
113    <title>Index of deprecated API</title>
114    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
115  </index>
116  <index>
117    <title>Index of new API in 1.14</title>
118    <xi:include href="xml/api-index-1.14.xml"><xi:fallback /></xi:include>
119  </index>
120  <index>
121    <title>Index of new API in 1.12.1</title>
122    <xi:include href="xml/api-index-1.12.1.xml"><xi:fallback /></xi:include>
123  </index>
124  <index>
125    <title>Index of new API in 1.12</title>
126    <xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include>
127  </index>
128  <index>
129    <title>Index of new API in 1.10</title>
130    <xi:include href="xml/api-index-1.10.xml"><xi:fallback /></xi:include>
131  </index>
132  <index>
133    <title>Index of new API in 1.8</title>
134    <xi:include href="xml/api-index-1.8.xml"><xi:fallback /></xi:include>
135  </index>
136  <index>
137    <title>Index of new API in 1.6</title>
138    <xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include>
139  </index>
140  <index>
141    <title>Index of new API in 1.4</title>
142    <xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include>
143  </index>
144  <index>
145    <title>Index of new API in 1.2</title>
146    <xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
147  </index>
148  <index>
149    <title>Index of new API in 1.0.1</title>
150    <xi:include href="xml/api-index-1.0.1.xml"><xi:fallback /></xi:include>
151  </index>
152
153  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
154
155</book>
156