← Back to branch summary

~sipe-collab/sipe-collab/gstreamer-plugins-base

« back to all changes in this revision

Viewing changes to docs/libs/html/gst-plugins-base-libs-gstaudiosrc.html

  • Committer: Sebastian Dröge
  • Date: 2014-04-19 13:47:47 UTC
  • mfrom: (1.1.23)
  • Revision ID: git-v1:d06393f82dba0d5f13ec2e66275d75cf8178fe5c
Merge tag 'upstream/1.2.4'

Upstream version 1.2.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libs/html/gst-plugins-base-libs-gstaudiosrc.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>gstaudiosrc</title>
 
5
<title>GStreamer Base Plugins 1.0 Library Reference Manual: gstaudiosrc</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
8
8
<link rel="up" href="gstreamer-audio.html" title="Audio Library">
9
9
<link rel="prev" href="gst-plugins-base-libs-gstaudiosink.html" title="gstaudiosink">
10
10
<link rel="next" href="gst-plugins-base-libs-gstaudiobasesink.html" title="gstaudiobasesink">
11
 
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="gst-plugins-base-libs-gstaudiosink.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="gstreamer-audio.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">GStreamer Base Plugins 1.0 Library Reference Manual</th>
21
 
<td><a accesskey="n" href="gst-plugins-base-libs-gstaudiobasesink.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#gst-plugins-base-libs-gstaudiosrc.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#gst-plugins-base-libs-gstaudiosrc.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#gst-plugins-base-libs-gstaudiosrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
</td></tr>
30
 
</table>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
 
18
                  <a href="#gst-plugins-base-libs-gstaudiosrc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
 
19
                  <a href="#gst-plugins-base-libs-gstaudiosrc.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
 
20
</td>
 
21
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
22
<td><a accesskey="u" href="gstreamer-audio.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="p" href="gst-plugins-base-libs-gstaudiosink.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="n" href="gst-plugins-base-libs-gstaudiobasesink.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
25
</tr></table>
31
26
<div class="refentry">
32
27
<a name="gst-plugins-base-libs-gstaudiosrc"></a><div class="titlepage"></div>
33
28
<div class="refnamediv"><table width="100%"><tr>
35
30
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstaudiosrc.top_of_page"></a>gstaudiosrc</span></h2>
36
31
<p>gstaudiosrc — Simple base class for audio sources</p>
37
32
</td>
38
 
<td valign="top" align="right"></td>
 
33
<td class="gallery_image" valign="top" align="right"></td>
39
34
</tr></table></div>
40
 
<div class="refsynopsisdiv">
41
 
<a name="gst-plugins-base-libs-gstaudiosrc.synopsis"></a><h2>Synopsis</h2>
42
 
<a name="GstAudioSrc"></a><pre class="synopsis">
43
 
#include &lt;gst/audio/gstaudiosrc.h&gt;
44
 
 
45
 
struct              <a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrc-struct" title="struct GstAudioSrc">GstAudioSrc</a>;
46
 
struct              <a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrcClass" title="struct GstAudioSrcClass">GstAudioSrcClass</a>;
47
 
</pre>
 
35
<a name="GstAudioSrc"></a><div class="refsect1">
 
36
<a name="gst-plugins-base-libs-gstaudiosrc.other"></a><h2>Types and Values</h2>
 
37
<div class="informaltable"><table width="100%" border="0">
 
38
<colgroup>
 
39
<col width="150px" class="name">
 
40
<col class="description">
 
41
</colgroup>
 
42
<tbody>
 
43
<tr>
 
44
<td class="datatype_keyword">struct</td>
 
45
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrc-struct" title="struct GstAudioSrc">GstAudioSrc</a></td>
 
46
</tr>
 
47
<tr>
 
48
<td class="datatype_keyword">struct</td>
 
49
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrcClass" title="struct GstAudioSrcClass">GstAudioSrcClass</a></td>
 
50
</tr>
 
51
</tbody>
 
52
</table></div>
48
53
</div>
49
54
<div class="refsect1">
50
55
<a name="gst-plugins-base-libs-gstaudiosrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
51
 
<pre class="synopsis">
52
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
53
 
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
54
 
         +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
55
 
               +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
56
 
                     +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html">GstBaseSrc</a>
57
 
                           +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
58
 
                                 +----<a class="link" href="gst-plugins-base-libs-gstaudiobasesrc.html#GstAudioBaseSrc">GstAudioBaseSrc</a>
59
 
                                       +----GstAudioSrc
 
56
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
57
    <span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
58
        <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
 
59
            <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
 
60
                <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html">GstBaseSrc</a>
 
61
                    <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
 
62
                        <span class="lineart">╰──</span> <a class="link" href="gst-plugins-base-libs-gstaudiobasesrc.html#GstAudioBaseSrc">GstAudioBaseSrc</a>
 
63
                            <span class="lineart">╰──</span> GstAudioSrc
 
64
</pre>
 
65
</div>
 
66
<div class="refsect1">
 
67
<a name="gst-plugins-base-libs-gstaudiosrc.includes"></a><h2>Includes</h2>
 
68
<pre class="synopsis">#include &lt;gst/audio/gstaudiosrc.h&gt;
60
69
</pre>
61
70
</div>
62
71
<div class="refsect1">
63
72
<a name="gst-plugins-base-libs-gstaudiosrc.description"></a><h2>Description</h2>
64
 
<p>
65
 
This is the most simple base class for audio sources that only requires
66
 
subclasses to implement a set of simple functions:
67
 
</p>
68
 
<p>
69
 
</p>
 
73
<p>This is the most simple base class for audio sources that only requires
 
74
subclasses to implement a set of simple functions:</p>
70
75
<div class="variablelist"><table border="0" class="variablelist">
71
76
<colgroup>
72
77
<col align="left" valign="top">
104
109
</tr>
105
110
</tbody>
106
111
</table></div>
107
 
<p>
108
 
</p>
109
 
<p>
110
 
All scheduling of samples and timestamps is done in this base class
 
112
<p>All scheduling of samples and timestamps is done in this base class
111
113
together with <a class="link" href="gst-plugins-base-libs-gstaudiobasesrc.html#GstAudioBaseSrc"><span class="type">GstAudioBaseSrc</span></a> using a default implementation of a
112
 
<a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="type">GstAudioRingBuffer</span></a> that uses threads.
113
 
</p>
114
 
<p>
115
 
Last reviewed on 2006-09-27 (0.10.12)
116
 
</p>
117
 
</div>
118
 
<div class="refsect1">
119
 
<a name="gst-plugins-base-libs-gstaudiosrc.details"></a><h2>Details</h2>
 
114
<a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="type">GstAudioRingBuffer</span></a> that uses threads.</p>
 
115
<p>Last reviewed on 2006-09-27 (0.10.12)</p>
 
116
</div>
 
117
<div class="refsect1">
 
118
<a name="gst-plugins-base-libs-gstaudiosrc.functions_details"></a><h2>Functions</h2>
 
119
</div>
 
120
<div class="refsect1">
 
121
<a name="gst-plugins-base-libs-gstaudiosrc.other_details"></a><h2>Types and Values</h2>
120
122
<div class="refsect2">
121
123
<a name="GstAudioSrc-struct"></a><h3>struct GstAudioSrc</h3>
122
124
<pre class="programlisting">struct GstAudioSrc;</pre>
123
 
<p>
124
 
Base class for simple audio sources.
125
 
</p>
 
125
<p>Base class for simple audio sources.</p>
126
126
</div>
127
127
<hr>
128
128
<div class="refsect2">
149
149
  void     (*reset)     (GstAudioSrc *src);
150
150
};
151
151
</pre>
152
 
<p>
153
 
<a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrc"><span class="type">GstAudioSrc</span></a> class. Override the vmethod to implement
154
 
functionality.
155
 
</p>
156
 
<div class="variablelist"><table border="0" class="variablelist">
 
152
<p><a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrc"><span class="type">GstAudioSrc</span></a> class. Override the vmethod to implement
 
153
functionality.</p>
 
154
<div class="refsect3">
 
155
<a name="id-1.2.6.12.9.3.5"></a><h4>Members</h4>
 
156
<div class="informaltable"><table width="100%" border="0">
157
157
<colgroup>
158
 
<col align="left" valign="top">
159
 
<col>
 
158
<col width="300px" class="struct_members_name">
 
159
<col class="struct_members_description">
 
160
<col width="200px" class="struct_members_annotations">
160
161
</colgroup>
161
162
<tbody>
162
163
<tr>
163
 
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstaudiobasesrc.html#GstAudioBaseSrcClass" title="struct GstAudioBaseSrcClass"><span class="type">GstAudioBaseSrcClass</span></a> <em class="structfield"><code><a name="GstAudioSrcClass.parent-class"></a>parent_class</code></em>;</span></p></td>
164
 
<td>the parent class.</td>
165
 
</tr>
166
 
<tr>
167
 
<td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.open"></a>open</code></em> ()</span></p></td>
168
 
<td>open the device with the specified caps</td>
169
 
</tr>
170
 
<tr>
171
 
<td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.prepare"></a>prepare</code></em> ()</span></p></td>
172
 
<td>configure device with format</td>
173
 
</tr>
174
 
<tr>
175
 
<td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.unprepare"></a>unprepare</code></em> ()</span></p></td>
176
 
<td>undo the configuration</td>
177
 
</tr>
178
 
<tr>
179
 
<td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.close"></a>close</code></em> ()</span></p></td>
180
 
<td>close the device</td>
181
 
</tr>
182
 
<tr>
183
 
<td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.read"></a>read</code></em> ()</span></p></td>
184
 
<td>read samples to the audio device</td>
185
 
</tr>
186
 
<tr>
187
 
<td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.delay"></a>delay</code></em> ()</span></p></td>
188
 
<td>the number of samples queued in the device</td>
189
 
</tr>
190
 
<tr>
191
 
<td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.reset"></a>reset</code></em> ()</span></p></td>
192
 
<td>unblock a read to the device and reset.</td>
 
164
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstaudiobasesrc.html#GstAudioBaseSrcClass" title="struct GstAudioBaseSrcClass"><span class="type">GstAudioBaseSrcClass</span></a> <em class="structfield"><code><a name="GstAudioSrcClass.parent-class"></a>parent_class</code></em>;</p></td>
 
165
<td class="struct_member_description"><p>the parent class.</p></td>
 
166
<td class="struct_member_annotations"> </td>
 
167
</tr>
 
168
<tr>
 
169
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAudioSrcClass.open"></a>open</code></em> ()</p></td>
 
170
<td class="struct_member_description"><p>open the device with the specified caps</p></td>
 
171
<td class="struct_member_annotations"> </td>
 
172
</tr>
 
173
<tr>
 
174
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAudioSrcClass.prepare"></a>prepare</code></em> ()</p></td>
 
175
<td class="struct_member_description"><p>configure device with format</p></td>
 
176
<td class="struct_member_annotations"> </td>
 
177
</tr>
 
178
<tr>
 
179
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAudioSrcClass.unprepare"></a>unprepare</code></em> ()</p></td>
 
180
<td class="struct_member_description"><p>undo the configuration</p></td>
 
181
<td class="struct_member_annotations"> </td>
 
182
</tr>
 
183
<tr>
 
184
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAudioSrcClass.close"></a>close</code></em> ()</p></td>
 
185
<td class="struct_member_description"><p>close the device</p></td>
 
186
<td class="struct_member_annotations"> </td>
 
187
</tr>
 
188
<tr>
 
189
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAudioSrcClass.read"></a>read</code></em> ()</p></td>
 
190
<td class="struct_member_description"><p>read samples to the audio device</p></td>
 
191
<td class="struct_member_annotations"> </td>
 
192
</tr>
 
193
<tr>
 
194
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAudioSrcClass.delay"></a>delay</code></em> ()</p></td>
 
195
<td class="struct_member_description"><p>the number of samples queued in the device</p></td>
 
196
<td class="struct_member_annotations"> </td>
 
197
</tr>
 
198
<tr>
 
199
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAudioSrcClass.reset"></a>reset</code></em> ()</p></td>
 
200
<td class="struct_member_description"><p>unblock a read to the device and reset.</p></td>
 
201
<td class="struct_member_annotations"> </td>
193
202
</tr>
194
203
</tbody>
195
204
</table></div>
196
205
</div>
197
206
</div>
 
207
</div>
198
208
<div class="refsect1">
199
209
<a name="gst-plugins-base-libs-gstaudiosrc.see-also"></a><h2>See Also</h2>
200
 
<a class="link" href="gst-plugins-base-libs-gstaudiobasesrc.html#GstAudioBaseSrc"><span class="type">GstAudioBaseSrc</span></a>, <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="type">GstAudioRingBuffer</span></a>, <a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrc"><span class="type">GstAudioSrc</span></a>.
 
210
<p><a class="link" href="gst-plugins-base-libs-gstaudiobasesrc.html#GstAudioBaseSrc"><span class="type">GstAudioBaseSrc</span></a>, <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="type">GstAudioRingBuffer</span></a>, <a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrc"><span class="type">GstAudioSrc</span></a>.</p>
201
211
</div>
202
212
</div>
203
213
<div class="footer">
204
214
<hr>
205
 
          Generated by GTK-Doc V1.19</div>
 
215
          Generated by GTK-Doc V1.20</div>
206
216
</body>
207
217
</html>
 
 
b'\\ No newline at end of file'