8
8
<link rel="up" href="gstreamer-audio.html" title="Audio Library">
9
9
<link rel="prev" href="gst-plugins-base-libs-gstaudiosrc.html" title="gstaudiosrc">
10
10
<link rel="next" href="gst-plugins-base-libs-gstbaseaudiosrc.html" title="gstbaseaudiosrc">
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="gstreamer-plugins-base.html" title="Part I. GStreamer Base Plugins Libraries">
14
<link rel="chapter" href="gstreamer-app.html" title="App Library">
15
<link rel="chapter" href="gstreamer-audio.html" title="Audio Library">
16
<link rel="chapter" href="gstreamer-cdda.html" title="CDDA Library">
17
<link rel="chapter" href="gstreamer-ffft.html" title="FFT Library">
18
<link rel="chapter" href="gstreamer-floatcast.html" title="FloatCast Library">
19
<link rel="chapter" href="gstreamer-interfaces.html" title="Interfaces Library">
20
<link rel="chapter" href="gstreamer-netbuffer.html" title="Network Buffer Library">
21
<link rel="chapter" href="gstreamer-riff.html" title="Riff Media Library">
22
<link rel="chapter" href="gstreamer-rtp.html" title="RTP Library">
23
<link rel="chapter" href="gstreamer-rtsp.html" title="RTSP Library">
24
<link rel="chapter" href="gstreamer-sdp.html" title="SDP Library">
25
<link rel="chapter" href="gstreamer-tag.html" title="Tag Support Library">
26
<link rel="chapter" href="gstreamer-base-utils.html" title="Base Utils Library">
27
<link rel="chapter" href="gstreamer-video.html" title="Video Library">
28
<link rel="part" href="gstreamer-libs-hierarchy.html" title="Part II. Object Hierarchy">
29
<link rel="index" href="api-index-full.html" title="Index">
30
<link rel="index" href="api-index-deprecated.html" title="Index of deprecated API">
32
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
33
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
68
50
#define <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GST-BASE-AUDIO-SINK-CLOCK:CAPS" title="GST_BASE_AUDIO_SINK_CLOCK()">GST_BASE_AUDIO_SINK_CLOCK</a> (obj)
69
51
#define <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GST-BASE-AUDIO-SINK-PAD:CAPS" title="GST_BASE_AUDIO_SINK_PAD()">GST_BASE_AUDIO_SINK_PAD</a> (obj)
70
52
<a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBuffer"><span class="returnvalue">GstRingBuffer</span></a> * <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#gst-base-audio-sink-create-ringbuffer" title="gst_base_audio_sink_create_ringbuffer ()">gst_base_audio_sink_create_ringbuffer</a>
71
(<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="returnvalue">GstBaseAudioSink</span></a> *sink);
53
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>);
72
54
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#gst-base-audio-sink-set-provide-clock" title="gst_base_audio_sink_set_provide_clock ()">gst_base_audio_sink_set_provide_clock</a>
73
(<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="returnvalue">GstBaseAudioSink</span></a> *sink,
74
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> provide);
55
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>,
56
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> provide</code></em>);
75
57
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#gst-base-audio-sink-get-provide-clock" title="gst_base_audio_sink_get_provide_clock ()">gst_base_audio_sink_get_provide_clock</a>
76
(<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="returnvalue">GstBaseAudioSink</span></a> *sink);
58
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>);
77
59
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#gst-base-audio-sink-set-slave-method" title="gst_base_audio_sink_set_slave_method ()">gst_base_audio_sink_set_slave_method</a>
78
(<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="returnvalue">GstBaseAudioSink</span></a> *sink,
79
<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSinkSlaveMethod" title="enum GstBaseAudioSinkSlaveMethod"><span class="returnvalue">GstBaseAudioSinkSlaveMethod</span></a> method);
60
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>,
61
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSinkSlaveMethod" title="enum GstBaseAudioSinkSlaveMethod"><span class="type">GstBaseAudioSinkSlaveMethod</span></a> method</code></em>);
80
62
<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSinkSlaveMethod" title="enum GstBaseAudioSinkSlaveMethod"><span class="returnvalue">GstBaseAudioSinkSlaveMethod</span></a> <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#gst-base-audio-sink-get-slave-method" title="gst_base_audio_sink_get_slave_method ()">gst_base_audio_sink_get_slave_method</a>
81
(<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="returnvalue">GstBaseAudioSink</span></a> *sink);
63
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>);
84
66
<div class="refsect1" title="Object Hierarchy">
111
93
writing samples to the ringbuffer, synchronisation, clipping and flushing.
114
Last reviewed on 2006-09-27 (0.10.12)</p>
96
Last reviewed on 2006-09-27 (0.10.12)
116
99
<div class="refsect1" title="Details">
117
100
<a name="gst-plugins-base-libs-gstbaseaudiosink.details"></a><h2>Details</h2>
119
102
<a name="GstBaseAudioSink-struct"></a><h3>GstBaseAudioSink</h3>
120
103
<pre class="programlisting">typedef struct _GstBaseAudioSink GstBaseAudioSink;</pre>
122
Opaque <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>.</p>
105
Opaque <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>.
125
109
<div class="refsect2" title="GstBaseAudioSinkClass">
135
119
<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> class. Override the vmethod to implement
137
122
<div class="variablelist"><table border="0">
138
123
<col align="left" valign="top">
141
126
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/gstreamer-libs-0.10/GstBaseSink.html#GstBaseSinkClass"><span class="type">GstBaseSinkClass</span></a> <em class="structfield"><code><a name="GstBaseAudioSinkClass.parent-class"></a>parent_class</code></em>;</span></p></td>
142
<td> the parent class.
127
<td>the parent class.
146
131
<td><p><span class="term"><em class="structfield"><code><a name="GstBaseAudioSinkClass.create-ringbuffer"></a>create_ringbuffer</code></em> ()</span></p></td>
147
<td> create and return a <a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBuffer"><span class="type">GstRingBuffer</span></a> to write to.
132
<td>create and return a <a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBuffer"><span class="type">GstRingBuffer</span></a> to write to.
164
149
Different possible clock slaving algorithms used when the internal audio
165
clock is not selected as the pipeline master clock.</p>
150
clock is not selected as the pipeline master clock.
166
152
<div class="variablelist"><table border="0">
167
153
<col align="left" valign="top">
170
156
<td><p><a name="GST-BASE-AUDIO-SINK-SLAVE-RESAMPLE:CAPS"></a><span class="term"><code class="literal">GST_BASE_AUDIO_SINK_SLAVE_RESAMPLE</code></span></p></td>
171
<td> Resample to match the master clock
157
<td>Resample to match the master clock
175
161
<td><p><a name="GST-BASE-AUDIO-SINK-SLAVE-SKEW:CAPS"></a><span class="term"><code class="literal">GST_BASE_AUDIO_SINK_SLAVE_SKEW</code></span></p></td>
176
<td> Adjust playout pointer when master clock
162
<td>Adjust playout pointer when master clock
181
167
<td><p><a name="GST-BASE-AUDIO-SINK-SLAVE-NONE:CAPS"></a><span class="term"><code class="literal">GST_BASE_AUDIO_SINK_SLAVE_NONE</code></span></p></td>
182
<td> No adjustment is done.
168
<td>No adjustment is done.
191
177
<pre class="programlisting">#define GST_BASE_AUDIO_SINK_CLOCK(obj) (GST_BASE_AUDIO_SINK (obj)->clock)
194
Get the <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html"><span class="type">GstClock</span></a> of <em class="parameter"><code>obj</code></em>.</p>
180
Get the <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html"><span class="type">GstClock</span></a> of <em class="parameter"><code>obj</code></em>.
195
182
<div class="variablelist"><table border="0">
196
183
<col align="left" valign="top">
198
185
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
199
<td> a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
186
<td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
207
194
<pre class="programlisting">#define GST_BASE_AUDIO_SINK_PAD(obj) (GST_BASE_SINK (obj)->sinkpad)
210
Get the sink <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html"><span class="type">GstPad</span></a> of <em class="parameter"><code>obj</code></em>.</p>
197
Get the sink <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html"><span class="type">GstPad</span></a> of <em class="parameter"><code>obj</code></em>.
211
199
<div class="variablelist"><table border="0">
212
200
<col align="left" valign="top">
214
202
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
215
<td> a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
203
<td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
221
209
<div class="refsect2" title="gst_base_audio_sink_create_ringbuffer ()">
222
210
<a name="gst-base-audio-sink-create-ringbuffer"></a><h3>gst_base_audio_sink_create_ringbuffer ()</h3>
223
211
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBuffer"><span class="returnvalue">GstRingBuffer</span></a> * gst_base_audio_sink_create_ringbuffer
224
(<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="returnvalue">GstBaseAudioSink</span></a> *sink);</pre>
212
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>);</pre>
226
214
Create and return the <a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBuffer"><span class="type">GstRingBuffer</span></a> for <em class="parameter"><code>sink</code></em>. This function will call the
227
215
::create_ringbuffer vmethod and will set <em class="parameter"><code>sink</code></em> as the parent of the returned
228
buffer (see <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstObject.html#gst-object-set-parent"><code class="function">gst_object_set_parent()</code></a>).</p>
216
buffer (see <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstObject.html#gst-object-set-parent"><code class="function">gst_object_set_parent()</code></a>).
229
218
<div class="variablelist"><table border="0">
230
219
<col align="left" valign="top">
233
222
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
234
<td> a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>.
223
<td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>.
246
235
<div class="refsect2" title="gst_base_audio_sink_set_provide_clock ()">
247
236
<a name="gst-base-audio-sink-set-provide-clock"></a><h3>gst_base_audio_sink_set_provide_clock ()</h3>
248
237
<pre class="programlisting"><span class="returnvalue">void</span> gst_base_audio_sink_set_provide_clock
249
(<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="returnvalue">GstBaseAudioSink</span></a> *sink,
250
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> provide);</pre>
238
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>,
239
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> provide</code></em>);</pre>
252
241
Controls whether <em class="parameter"><code>sink</code></em> will provide a clock or not. If <em class="parameter"><code>provide</code></em> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>,
253
242
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html#gst-element-provide-clock"><code class="function">gst_element_provide_clock()</code></a> will return a clock that reflects the datarate
254
of <em class="parameter"><code>sink</code></em>. If <em class="parameter"><code>provide</code></em> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html#gst-element-provide-clock"><code class="function">gst_element_provide_clock()</code></a> will return NULL.</p>
243
of <em class="parameter"><code>sink</code></em>. If <em class="parameter"><code>provide</code></em> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html#gst-element-provide-clock"><code class="function">gst_element_provide_clock()</code></a> will return NULL.
255
245
<div class="variablelist"><table border="0">
256
246
<col align="left" valign="top">
259
249
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
260
<td> a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
250
<td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
264
254
<td><p><span class="term"><em class="parameter"><code>provide</code></em> :</span></p></td>
273
263
<div class="refsect2" title="gst_base_audio_sink_get_provide_clock ()">
274
264
<a name="gst-base-audio-sink-get-provide-clock"></a><h3>gst_base_audio_sink_get_provide_clock ()</h3>
275
265
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_base_audio_sink_get_provide_clock
276
(<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="returnvalue">GstBaseAudioSink</span></a> *sink);</pre>
266
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>);</pre>
278
268
Queries whether <em class="parameter"><code>sink</code></em> will provide a clock or not. See also
279
gst_base_audio_sink_set_provide_clock.</p>
269
gst_base_audio_sink_set_provide_clock.
280
271
<div class="variablelist"><table border="0">
281
272
<col align="left" valign="top">
284
275
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
285
<td> a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
276
<td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
299
290
<div class="refsect2" title="gst_base_audio_sink_set_slave_method ()">
300
291
<a name="gst-base-audio-sink-set-slave-method"></a><h3>gst_base_audio_sink_set_slave_method ()</h3>
301
292
<pre class="programlisting"><span class="returnvalue">void</span> gst_base_audio_sink_set_slave_method
302
(<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="returnvalue">GstBaseAudioSink</span></a> *sink,
303
<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSinkSlaveMethod" title="enum GstBaseAudioSinkSlaveMethod"><span class="returnvalue">GstBaseAudioSinkSlaveMethod</span></a> method);</pre>
293
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>,
294
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSinkSlaveMethod" title="enum GstBaseAudioSinkSlaveMethod"><span class="type">GstBaseAudioSinkSlaveMethod</span></a> method</code></em>);</pre>
305
Controls how clock slaving will be performed in <em class="parameter"><code>sink</code></em>.</p>
296
Controls how clock slaving will be performed in <em class="parameter"><code>sink</code></em>.
306
298
<div class="variablelist"><table border="0">
307
299
<col align="left" valign="top">
310
302
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
311
<td> a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
303
<td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
315
307
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
316
<td> the new slave method
308
<td>the new slave method
324
316
<div class="refsect2" title="gst_base_audio_sink_get_slave_method ()">
325
317
<a name="gst-base-audio-sink-get-slave-method"></a><h3>gst_base_audio_sink_get_slave_method ()</h3>
326
318
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSinkSlaveMethod" title="enum GstBaseAudioSinkSlaveMethod"><span class="returnvalue">GstBaseAudioSinkSlaveMethod</span></a> gst_base_audio_sink_get_slave_method
327
(<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="returnvalue">GstBaseAudioSink</span></a> *sink);</pre>
319
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>);</pre>
329
Get the current slave method used by <em class="parameter"><code>sink</code></em>.</p>
321
Get the current slave method used by <em class="parameter"><code>sink</code></em>.
330
323
<div class="variablelist"><table border="0">
331
324
<col align="left" valign="top">
334
327
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
335
<td> a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
328
<td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
368
361
<pre class="programlisting"> "drift-tolerance" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write</pre>
370
363
Controls the amount of time in milliseconds that timestamps or clocks are allowed
371
to drift before resynchronisation happens.</p>
364
to drift before resynchronisation happens.
372
366
<p>Allowed values: >= 1</p>
373
367
<p>Default value: 40000</p>
374
368
<p class="since">Since 0.10.26</p>