~sipe-collab/sipe-collab/gstreamer-plugins-base
» Revision
83
: docs/libs/html/gst-plugins-base-libs-gstaudiobasesink.html
« back to all changes in this revision
Viewing changes to docs/libs/html/gst-plugins-base-libs-gstaudiobasesink.html
- browse files at revision 83
- compare with another revision
- download diff
- download tarball
- view history from revision 83
- 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
Upstream version 1.2.4
- files added:
- docs/libs/html/left-insensitive.png
- files modified:
- ChangeLog
added
removed
docs/libs/html/gst-plugins-base-libs-gstaudiobasesink.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>gstaudiobasesink</title>
5
<title>GStreamer Base Plugins 1.0 Library Reference Manual: gstaudiobasesink</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-gstaudiosrc.html" title="gstaudiosrc">
10
10
<link rel="next" href="gst-plugins-base-libs-gstaudiobasesrc.html" title="gstaudiobasesrc">
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-gstaudiosrc.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-gstaudiobasesrc.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-gstaudiobasesink.synopsis" class="shortcut">Top</a>
25
|
26
<a href="#gst-plugins-base-libs-gstaudiobasesink.description" class="shortcut">Description</a>
27
|
28
<a href="#gst-plugins-base-libs-gstaudiobasesink.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
|
30
<a href="#gst-plugins-base-libs-gstaudiobasesink.properties" class="shortcut">Properties</a>
31
</td></tr>
32
</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-gstaudiobasesink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19
<a href="#gst-plugins-base-libs-gstaudiobasesink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
20
<a href="#gst-plugins-base-libs-gstaudiobasesink.properties" class="shortcut">Properties</a></span>
21
</td>
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23
<td><a accesskey="u" href="gstreamer-audio.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24
<td><a accesskey="p" href="gst-plugins-base-libs-gstaudiosrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25
<td><a accesskey="n" href="gst-plugins-base-libs-gstaudiobasesrc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26
</tr></table>
33
27
<div class="refentry">
34
28
<a name="gst-plugins-base-libs-gstaudiobasesink"></a><div class="titlepage"></div>
35
29
<div class="refnamediv"><table width="100%"><tr>
37
31
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstaudiobasesink.top_of_page"></a>gstaudiobasesink</span></h2>
38
32
<p>gstaudiobasesink — Base class for audio sinks</p>
39
33
</td>
40
<td valign="top" align="right"></td>
34
<td class="gallery_image" valign="top" align="right"></td>
41
35
</tr></table></div>
42
<div class="refsynopsisdiv">
43
<a name="gst-plugins-base-libs-gstaudiobasesink.synopsis"></a><h2>Synopsis</h2>
44
<a name="GstAudioBaseSink"></a><pre class="synopsis">
45
#include <gst/audio/gstaudiobasesink.h>
46
47
struct <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink-struct" title="struct GstAudioBaseSink">GstAudioBaseSink</a>;
48
struct <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkClass" title="struct GstAudioBaseSinkClass">GstAudioBaseSinkClass</a>;
49
enum <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod">GstAudioBaseSinkSlaveMethod</a>;
50
#define <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GST-AUDIO-BASE-SINK-CLOCK:CAPS" title="GST_AUDIO_BASE_SINK_CLOCK()">GST_AUDIO_BASE_SINK_CLOCK</a> (obj)
51
#define <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GST-AUDIO-BASE-SINK-PAD:CAPS" title="GST_AUDIO_BASE_SINK_PAD()">GST_AUDIO_BASE_SINK_PAD</a> (obj)
52
<a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="returnvalue">GstAudioRingBuffer</span></a> * <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-create-ringbuffer" title="gst_audio_base_sink_create_ringbuffer ()">gst_audio_base_sink_create_ringbuffer</a>
53
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);
54
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-set-provide-clock" title="gst_audio_base_sink_set_provide_clock ()">gst_audio_base_sink_set_provide_clock</a>
55
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
56
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> provide</code></em>);
57
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-get-provide-clock" title="gst_audio_base_sink_get_provide_clock ()">gst_audio_base_sink_get_provide_clock</a>
58
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);
59
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-set-slave-method" title="gst_audio_base_sink_set_slave_method ()">gst_audio_base_sink_set_slave_method</a>
60
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
61
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod"><span class="type">GstAudioBaseSinkSlaveMethod</span></a> method</code></em>);
62
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod"><span class="returnvalue">GstAudioBaseSinkSlaveMethod</span></a> <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-get-slave-method" title="gst_audio_base_sink_get_slave_method ()">gst_audio_base_sink_get_slave_method</a>
63
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);
64
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-set-drift-tolerance" title="gst_audio_base_sink_set_drift_tolerance ()">gst_audio_base_sink_set_drift_tolerance</a>
65
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
66
<em class="parameter"><code><span class="type">gint64</span> drift_tolerance</code></em>);
67
<span class="returnvalue">gint64</span> <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-get-drift-tolerance" title="gst_audio_base_sink_get_drift_tolerance ()">gst_audio_base_sink_get_drift_tolerance</a>
68
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);
69
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-set-alignment-threshold" title="gst_audio_base_sink_set_alignment_threshold ()">gst_audio_base_sink_set_alignment_threshold</a>
70
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
71
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> alignment_threshold</code></em>);
72
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a> <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-get-alignment-threshold" title="gst_audio_base_sink_get_alignment_threshold ()">gst_audio_base_sink_get_alignment_threshold</a>
73
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);
74
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-set-discont-wait" title="gst_audio_base_sink_set_discont_wait ()">gst_audio_base_sink_set_discont_wait</a>
75
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
76
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> discont_wait</code></em>);
77
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a> <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-get-discont-wait" title="gst_audio_base_sink_get_discont_wait ()">gst_audio_base_sink_get_discont_wait</a>
78
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);
79
</pre>
36
<div class="refsect1">
37
<a name="gst-plugins-base-libs-gstaudiobasesink.functions"></a><h2>Functions</h2>
38
<div class="informaltable"><table width="100%" border="0">
39
<colgroup>
40
<col width="150px" class="functions_return">
41
<col class="functions_name">
42
</colgroup>
43
<tbody>
44
<tr>
45
<td class="define_keyword">#define</td>
46
<td class="function_name">
47
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GST-AUDIO-BASE-SINK-CLOCK:CAPS" title="GST_AUDIO_BASE_SINK_CLOCK()">GST_AUDIO_BASE_SINK_CLOCK</a><span class="c_punctuation">()</span>
48
</td>
49
</tr>
50
<tr>
51
<td class="define_keyword">#define</td>
52
<td class="function_name">
53
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GST-AUDIO-BASE-SINK-PAD:CAPS" title="GST_AUDIO_BASE_SINK_PAD()">GST_AUDIO_BASE_SINK_PAD</a><span class="c_punctuation">()</span>
54
</td>
55
</tr>
56
<tr>
57
<td class="function_type">
58
<a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="returnvalue">GstAudioRingBuffer</span></a> *
59
</td>
60
<td class="function_name">
61
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-create-ringbuffer" title="gst_audio_base_sink_create_ringbuffer ()">gst_audio_base_sink_create_ringbuffer</a> <span class="c_punctuation">()</span>
62
</td>
63
</tr>
64
<tr>
65
<td class="function_type">
66
<span class="returnvalue">void</span>
67
</td>
68
<td class="function_name">
69
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-set-provide-clock" title="gst_audio_base_sink_set_provide_clock ()">gst_audio_base_sink_set_provide_clock</a> <span class="c_punctuation">()</span>
70
</td>
71
</tr>
72
<tr>
73
<td class="function_type">
74
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
75
</td>
76
<td class="function_name">
77
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-get-provide-clock" title="gst_audio_base_sink_get_provide_clock ()">gst_audio_base_sink_get_provide_clock</a> <span class="c_punctuation">()</span>
78
</td>
79
</tr>
80
<tr>
81
<td class="function_type">
82
<span class="returnvalue">void</span>
83
</td>
84
<td class="function_name">
85
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-set-slave-method" title="gst_audio_base_sink_set_slave_method ()">gst_audio_base_sink_set_slave_method</a> <span class="c_punctuation">()</span>
86
</td>
87
</tr>
88
<tr>
89
<td class="function_type">
90
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod"><span class="returnvalue">GstAudioBaseSinkSlaveMethod</span></a>
91
</td>
92
<td class="function_name">
93
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-get-slave-method" title="gst_audio_base_sink_get_slave_method ()">gst_audio_base_sink_get_slave_method</a> <span class="c_punctuation">()</span>
94
</td>
95
</tr>
96
<tr>
97
<td class="function_type">
98
<span class="returnvalue">void</span>
99
</td>
100
<td class="function_name">
101
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-set-drift-tolerance" title="gst_audio_base_sink_set_drift_tolerance ()">gst_audio_base_sink_set_drift_tolerance</a> <span class="c_punctuation">()</span>
102
</td>
103
</tr>
104
<tr>
105
<td class="function_type">
106
<span class="returnvalue">gint64</span>
107
</td>
108
<td class="function_name">
109
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-get-drift-tolerance" title="gst_audio_base_sink_get_drift_tolerance ()">gst_audio_base_sink_get_drift_tolerance</a> <span class="c_punctuation">()</span>
110
</td>
111
</tr>
112
<tr>
113
<td class="function_type">
114
<span class="returnvalue">void</span>
115
</td>
116
<td class="function_name">
117
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-set-alignment-threshold" title="gst_audio_base_sink_set_alignment_threshold ()">gst_audio_base_sink_set_alignment_threshold</a> <span class="c_punctuation">()</span>
118
</td>
119
</tr>
120
<tr>
121
<td class="function_type">
122
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a>
123
</td>
124
<td class="function_name">
125
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-get-alignment-threshold" title="gst_audio_base_sink_get_alignment_threshold ()">gst_audio_base_sink_get_alignment_threshold</a> <span class="c_punctuation">()</span>
126
</td>
127
</tr>
128
<tr>
129
<td class="function_type">
130
<span class="returnvalue">void</span>
131
</td>
132
<td class="function_name">
133
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-set-discont-wait" title="gst_audio_base_sink_set_discont_wait ()">gst_audio_base_sink_set_discont_wait</a> <span class="c_punctuation">()</span>
134
</td>
135
</tr>
136
<tr>
137
<td class="function_type">
138
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a>
139
</td>
140
<td class="function_name">
141
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#gst-audio-base-sink-get-discont-wait" title="gst_audio_base_sink_get_discont_wait ()">gst_audio_base_sink_get_discont_wait</a> <span class="c_punctuation">()</span>
142
</td>
143
</tr>
144
</tbody>
145
</table></div>
146
</div>
147
<div class="refsect1">
148
<a name="gst-plugins-base-libs-gstaudiobasesink.properties"></a><h2>Properties</h2>
149
<div class="informaltable"><table border="0">
150
<colgroup>
151
<col width="150px" class="properties_type">
152
<col width="300px" class="properties_name">
153
<col width="200px" class="properties_flags">
154
</colgroup>
155
<tbody>
156
<tr>
157
<td class="property_type"><span class="type">guint64</span></td>
158
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--alignment-threshold" title="The “alignment-threshold” property">alignment-threshold</a></td>
159
<td class="property_flags">Read / Write</td>
160
</tr>
161
<tr>
162
<td class="property_type"><span class="type">gint64</span></td>
163
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--buffer-time" title="The “buffer-time” property">buffer-time</a></td>
164
<td class="property_flags">Read / Write</td>
165
</tr>
166
<tr>
167
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
168
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--can-activate-pull" title="The “can-activate-pull” property">can-activate-pull</a></td>
169
<td class="property_flags">Read / Write</td>
170
</tr>
171
<tr>
172
<td class="property_type"><span class="type">guint64</span></td>
173
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--discont-wait" title="The “discont-wait” property">discont-wait</a></td>
174
<td class="property_flags">Read / Write</td>
175
</tr>
176
<tr>
177
<td class="property_type"><span class="type">gint64</span></td>
178
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--drift-tolerance" title="The “drift-tolerance” property">drift-tolerance</a></td>
179
<td class="property_flags">Read / Write</td>
180
</tr>
181
<tr>
182
<td class="property_type"><span class="type">gint64</span></td>
183
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--latency-time" title="The “latency-time” property">latency-time</a></td>
184
<td class="property_flags">Read / Write</td>
185
</tr>
186
<tr>
187
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
188
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--provide-clock" title="The “provide-clock” property">provide-clock</a></td>
189
<td class="property_flags">Read / Write</td>
190
</tr>
191
<tr>
192
<td class="property_type"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod"><span class="type">GstAudioBaseSinkSlaveMethod</span></a></td>
193
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--slave-method" title="The “slave-method” property">slave-method</a></td>
194
<td class="property_flags">Read / Write</td>
195
</tr>
196
</tbody>
197
</table></div>
198
</div>
199
<a name="GstAudioBaseSink"></a><div class="refsect1">
200
<a name="gst-plugins-base-libs-gstaudiobasesink.other"></a><h2>Types and Values</h2>
201
<div class="informaltable"><table width="100%" border="0">
202
<colgroup>
203
<col width="150px" class="name">
204
<col class="description">
205
</colgroup>
206
<tbody>
207
<tr>
208
<td class="datatype_keyword">struct</td>
209
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink-struct" title="struct GstAudioBaseSink">GstAudioBaseSink</a></td>
210
</tr>
211
<tr>
212
<td class="datatype_keyword">struct</td>
213
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkClass" title="struct GstAudioBaseSinkClass">GstAudioBaseSinkClass</a></td>
214
</tr>
215
<tr>
216
<td class="datatype_keyword">enum</td>
217
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod">GstAudioBaseSinkSlaveMethod</a></td>
218
</tr>
219
</tbody>
220
</table></div>
80
221
</div>
81
222
<div class="refsect1">
82
223
<a name="gst-plugins-base-libs-gstaudiobasesink.object-hierarchy"></a><h2>Object Hierarchy</h2>
83
<pre class="synopsis">
84
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
85
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
86
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
87
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
88
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a>
89
+----GstAudioBaseSink
90
+----<a class="link" href="gst-plugins-base-libs-gstaudiosink.html#GstAudioSink">GstAudioSink</a>
224
<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
225
<span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
226
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
227
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
228
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a>
229
<span class="lineart">╰──</span> GstAudioBaseSink
230
<span class="lineart">╰──</span> <a class="link" href="gst-plugins-base-libs-gstaudiosink.html#GstAudioSink">GstAudioSink</a>
91
231
</pre>
92
232
</div>
93
233
<div class="refsect1">
94
<a name="gst-plugins-base-libs-gstaudiobasesink.properties"></a><h2>Properties</h2>
95
<pre class="synopsis">
96
"<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--alignment-threshold" title='The "alignment-threshold" property'>alignment-threshold</a>" <span class="type">guint64</span> : Read / Write
97
"<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--buffer-time" title='The "buffer-time" property'>buffer-time</a>" <span class="type">gint64</span> : Read / Write
98
"<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--can-activate-pull" title='The "can-activate-pull" property'>can-activate-pull</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
99
"<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--discont-wait" title='The "discont-wait" property'>discont-wait</a>" <span class="type">guint64</span> : Read / Write
100
"<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--drift-tolerance" title='The "drift-tolerance" property'>drift-tolerance</a>" <span class="type">gint64</span> : Read / Write
101
"<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--latency-time" title='The "latency-time" property'>latency-time</a>" <span class="type">gint64</span> : Read / Write
102
"<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--provide-clock" title='The "provide-clock" property'>provide-clock</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
103
"<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink--slave-method" title='The "slave-method" property'>slave-method</a>" <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod"><span class="type">GstAudioBaseSinkSlaveMethod</span></a> : Read / Write
234
<a name="gst-plugins-base-libs-gstaudiobasesink.includes"></a><h2>Includes</h2>
235
<pre class="synopsis">#include <gst/audio/gstaudiobasesink.h>
104
236
</pre>
105
237
</div>
106
238
<div class="refsect1">
107
239
<a name="gst-plugins-base-libs-gstaudiobasesink.description"></a><h2>Description</h2>
108
<p>
109
This is the base class for audio sinks. Subclasses need to implement the
240
<p>This is the base class for audio sinks. Subclasses need to implement the
110
241
::create_ringbuffer vmethod. This base class will then take care of
111
writing samples to the ringbuffer, synchronisation, clipping and flushing.
112
</p>
113
<p>
114
Last reviewed on 2006-09-27 (0.10.12)
115
</p>
116
</div>
117
<div class="refsect1">
118
<a name="gst-plugins-base-libs-gstaudiobasesink.details"></a><h2>Details</h2>
242
writing samples to the ringbuffer, synchronisation, clipping and flushing.</p>
243
<p>Last reviewed on 2006-09-27 (0.10.12)</p>
244
</div>
245
<div class="refsect1">
246
<a name="gst-plugins-base-libs-gstaudiobasesink.functions_details"></a><h2>Functions</h2>
247
<div class="refsect2">
248
<a name="GST-AUDIO-BASE-SINK-CLOCK:CAPS"></a><h3>GST_AUDIO_BASE_SINK_CLOCK()</h3>
249
<pre class="programlisting">#define GST_AUDIO_BASE_SINK_CLOCK(obj) (GST_AUDIO_BASE_SINK (obj)->clock)
250
</pre>
251
<p>Get the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html"><span class="type">GstClock</span></a> of <em class="parameter"><code>obj</code></em>
252
.</p>
253
<div class="refsect3">
254
<a name="id-1.2.6.13.10.2.5"></a><h4>Parameters</h4>
255
<div class="informaltable"><table width="100%" border="0">
256
<colgroup>
257
<col width="150px" class="parameters_name">
258
<col class="parameters_description">
259
<col width="200px" class="parameters_annotations">
260
</colgroup>
261
<tbody><tr>
262
<td class="parameter_name"><p>obj</p></td>
263
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a></p></td>
264
<td class="parameter_annotations"> </td>
265
</tr></tbody>
266
</table></div>
267
</div>
268
</div>
269
<hr>
270
<div class="refsect2">
271
<a name="GST-AUDIO-BASE-SINK-PAD:CAPS"></a><h3>GST_AUDIO_BASE_SINK_PAD()</h3>
272
<pre class="programlisting">#define GST_AUDIO_BASE_SINK_PAD(obj) (GST_BASE_SINK (obj)->sinkpad)
273
</pre>
274
<p>Get the sink <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> of <em class="parameter"><code>obj</code></em>
275
.</p>
276
<div class="refsect3">
277
<a name="id-1.2.6.13.10.3.5"></a><h4>Parameters</h4>
278
<div class="informaltable"><table width="100%" border="0">
279
<colgroup>
280
<col width="150px" class="parameters_name">
281
<col class="parameters_description">
282
<col width="200px" class="parameters_annotations">
283
</colgroup>
284
<tbody><tr>
285
<td class="parameter_name"><p>obj</p></td>
286
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a></p></td>
287
<td class="parameter_annotations"> </td>
288
</tr></tbody>
289
</table></div>
290
</div>
291
</div>
292
<hr>
293
<div class="refsect2">
294
<a name="gst-audio-base-sink-create-ringbuffer"></a><h3>gst_audio_base_sink_create_ringbuffer ()</h3>
295
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="returnvalue">GstAudioRingBuffer</span></a> *
296
gst_audio_base_sink_create_ringbuffer (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);</pre>
297
<p>Create and return the <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="type">GstAudioRingBuffer</span></a> for <em class="parameter"><code>sink</code></em>
298
. This function will call the
299
::create_ringbuffer vmethod and will set <em class="parameter"><code>sink</code></em>
300
as the parent of the returned
301
buffer (see <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html#gst-object-set-parent"><code class="function">gst_object_set_parent()</code></a>).</p>
302
<div class="refsect3">
303
<a name="id-1.2.6.13.10.4.5"></a><h4>Parameters</h4>
304
<div class="informaltable"><table width="100%" border="0">
305
<colgroup>
306
<col width="150px" class="parameters_name">
307
<col class="parameters_description">
308
<col width="200px" class="parameters_annotations">
309
</colgroup>
310
<tbody><tr>
311
<td class="parameter_name"><p>sink</p></td>
312
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>.</p></td>
313
<td class="parameter_annotations"> </td>
314
</tr></tbody>
315
</table></div>
316
</div>
317
<div class="refsect3">
318
<a name="id-1.2.6.13.10.4.6"></a><h4>Returns</h4>
319
<p> The new ringbuffer of <em class="parameter"><code>sink</code></em>
320
. </p>
321
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
322
</div>
323
</div>
324
<hr>
325
<div class="refsect2">
326
<a name="gst-audio-base-sink-set-provide-clock"></a><h3>gst_audio_base_sink_set_provide_clock ()</h3>
327
<pre class="programlisting"><span class="returnvalue">void</span>
328
gst_audio_base_sink_set_provide_clock (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
329
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> provide</code></em>);</pre>
330
<p>Controls whether <em class="parameter"><code>sink</code></em>
331
will provide a clock or not. If <em class="parameter"><code>provide</code></em>
332
is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>,
333
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html#gst-element-provide-clock"><code class="function">gst_element_provide_clock()</code></a> will return a clock that reflects the datarate
334
of <em class="parameter"><code>sink</code></em>
335
. If <em class="parameter"><code>provide</code></em>
336
is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html#gst-element-provide-clock"><code class="function">gst_element_provide_clock()</code></a> will return NULL.</p>
337
<div class="refsect3">
338
<a name="id-1.2.6.13.10.5.5"></a><h4>Parameters</h4>
339
<div class="informaltable"><table width="100%" border="0">
340
<colgroup>
341
<col width="150px" class="parameters_name">
342
<col class="parameters_description">
343
<col width="200px" class="parameters_annotations">
344
</colgroup>
345
<tbody>
346
<tr>
347
<td class="parameter_name"><p>sink</p></td>
348
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a></p></td>
349
<td class="parameter_annotations"> </td>
350
</tr>
351
<tr>
352
<td class="parameter_name"><p>provide</p></td>
353
<td class="parameter_description"><p>new state</p></td>
354
<td class="parameter_annotations"> </td>
355
</tr>
356
</tbody>
357
</table></div>
358
</div>
359
</div>
360
<hr>
361
<div class="refsect2">
362
<a name="gst-audio-base-sink-get-provide-clock"></a><h3>gst_audio_base_sink_get_provide_clock ()</h3>
363
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
364
gst_audio_base_sink_get_provide_clock (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);</pre>
365
<p>Queries whether <em class="parameter"><code>sink</code></em>
366
will provide a clock or not. See also
367
gst_audio_base_sink_set_provide_clock.</p>
368
<div class="refsect3">
369
<a name="id-1.2.6.13.10.6.5"></a><h4>Parameters</h4>
370
<div class="informaltable"><table width="100%" border="0">
371
<colgroup>
372
<col width="150px" class="parameters_name">
373
<col class="parameters_description">
374
<col width="200px" class="parameters_annotations">
375
</colgroup>
376
<tbody><tr>
377
<td class="parameter_name"><p>sink</p></td>
378
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a></p></td>
379
<td class="parameter_annotations"> </td>
380
</tr></tbody>
381
</table></div>
382
</div>
383
<div class="refsect3">
384
<a name="id-1.2.6.13.10.6.6"></a><h4>Returns</h4>
385
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>sink</code></em>
386
will provide a clock.</p>
387
<p></p>
388
</div>
389
</div>
390
<hr>
391
<div class="refsect2">
392
<a name="gst-audio-base-sink-set-slave-method"></a><h3>gst_audio_base_sink_set_slave_method ()</h3>
393
<pre class="programlisting"><span class="returnvalue">void</span>
394
gst_audio_base_sink_set_slave_method (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
395
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod"><span class="type">GstAudioBaseSinkSlaveMethod</span></a> method</code></em>);</pre>
396
<p>Controls how clock slaving will be performed in <em class="parameter"><code>sink</code></em>
397
.</p>
398
<div class="refsect3">
399
<a name="id-1.2.6.13.10.7.5"></a><h4>Parameters</h4>
400
<div class="informaltable"><table width="100%" border="0">
401
<colgroup>
402
<col width="150px" class="parameters_name">
403
<col class="parameters_description">
404
<col width="200px" class="parameters_annotations">
405
</colgroup>
406
<tbody>
407
<tr>
408
<td class="parameter_name"><p>sink</p></td>
409
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a></p></td>
410
<td class="parameter_annotations"> </td>
411
</tr>
412
<tr>
413
<td class="parameter_name"><p>method</p></td>
414
<td class="parameter_description"><p>the new slave method</p></td>
415
<td class="parameter_annotations"> </td>
416
</tr>
417
</tbody>
418
</table></div>
419
</div>
420
</div>
421
<hr>
422
<div class="refsect2">
423
<a name="gst-audio-base-sink-get-slave-method"></a><h3>gst_audio_base_sink_get_slave_method ()</h3>
424
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod"><span class="returnvalue">GstAudioBaseSinkSlaveMethod</span></a>
425
gst_audio_base_sink_get_slave_method (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);</pre>
426
<p>Get the current slave method used by <em class="parameter"><code>sink</code></em>
427
.</p>
428
<div class="refsect3">
429
<a name="id-1.2.6.13.10.8.5"></a><h4>Parameters</h4>
430
<div class="informaltable"><table width="100%" border="0">
431
<colgroup>
432
<col width="150px" class="parameters_name">
433
<col class="parameters_description">
434
<col width="200px" class="parameters_annotations">
435
</colgroup>
436
<tbody><tr>
437
<td class="parameter_name"><p>sink</p></td>
438
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a></p></td>
439
<td class="parameter_annotations"> </td>
440
</tr></tbody>
441
</table></div>
442
</div>
443
<div class="refsect3">
444
<a name="id-1.2.6.13.10.8.6"></a><h4>Returns</h4>
445
<p> The current slave method used by <em class="parameter"><code>sink</code></em>
446
.</p>
447
<p></p>
448
</div>
449
</div>
450
<hr>
451
<div class="refsect2">
452
<a name="gst-audio-base-sink-set-drift-tolerance"></a><h3>gst_audio_base_sink_set_drift_tolerance ()</h3>
453
<pre class="programlisting"><span class="returnvalue">void</span>
454
gst_audio_base_sink_set_drift_tolerance
455
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
456
<em class="parameter"><code><span class="type">gint64</span> drift_tolerance</code></em>);</pre>
457
<p>Controls the sink's drift tolerance.</p>
458
<div class="refsect3">
459
<a name="id-1.2.6.13.10.9.5"></a><h4>Parameters</h4>
460
<div class="informaltable"><table width="100%" border="0">
461
<colgroup>
462
<col width="150px" class="parameters_name">
463
<col class="parameters_description">
464
<col width="200px" class="parameters_annotations">
465
</colgroup>
466
<tbody>
467
<tr>
468
<td class="parameter_name"><p>sink</p></td>
469
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a></p></td>
470
<td class="parameter_annotations"> </td>
471
</tr>
472
<tr>
473
<td class="parameter_name"><p>drift_tolerance</p></td>
474
<td class="parameter_description"><p>the new drift tolerance in microseconds</p></td>
475
<td class="parameter_annotations"> </td>
476
</tr>
477
</tbody>
478
</table></div>
479
</div>
480
</div>
481
<hr>
482
<div class="refsect2">
483
<a name="gst-audio-base-sink-get-drift-tolerance"></a><h3>gst_audio_base_sink_get_drift_tolerance ()</h3>
484
<pre class="programlisting"><span class="returnvalue">gint64</span>
485
gst_audio_base_sink_get_drift_tolerance
486
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);</pre>
487
<p>Get the current drift tolerance, in microseconds, used by <em class="parameter"><code>sink</code></em>
488
.</p>
489
<div class="refsect3">
490
<a name="id-1.2.6.13.10.10.5"></a><h4>Parameters</h4>
491
<div class="informaltable"><table width="100%" border="0">
492
<colgroup>
493
<col width="150px" class="parameters_name">
494
<col class="parameters_description">
495
<col width="200px" class="parameters_annotations">
496
</colgroup>
497
<tbody><tr>
498
<td class="parameter_name"><p>sink</p></td>
499
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a></p></td>
500
<td class="parameter_annotations"> </td>
501
</tr></tbody>
502
</table></div>
503
</div>
504
<div class="refsect3">
505
<a name="id-1.2.6.13.10.10.6"></a><h4>Returns</h4>
506
<p> The current drift tolerance used by <em class="parameter"><code>sink</code></em>
507
.</p>
508
<p></p>
509
</div>
510
</div>
511
<hr>
512
<div class="refsect2">
513
<a name="gst-audio-base-sink-set-alignment-threshold"></a><h3>gst_audio_base_sink_set_alignment_threshold ()</h3>
514
<pre class="programlisting"><span class="returnvalue">void</span>
515
gst_audio_base_sink_set_alignment_threshold
516
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
517
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> alignment_threshold</code></em>);</pre>
518
<p>Controls the sink's alignment threshold.</p>
519
<div class="refsect3">
520
<a name="id-1.2.6.13.10.11.5"></a><h4>Parameters</h4>
521
<div class="informaltable"><table width="100%" border="0">
522
<colgroup>
523
<col width="150px" class="parameters_name">
524
<col class="parameters_description">
525
<col width="200px" class="parameters_annotations">
526
</colgroup>
527
<tbody>
528
<tr>
529
<td class="parameter_name"><p>sink</p></td>
530
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a></p></td>
531
<td class="parameter_annotations"> </td>
532
</tr>
533
<tr>
534
<td class="parameter_name"><p>alignment_threshold</p></td>
535
<td class="parameter_description"><p>the new alignment threshold in nanoseconds</p></td>
536
<td class="parameter_annotations"> </td>
537
</tr>
538
</tbody>
539
</table></div>
540
</div>
541
</div>
542
<hr>
543
<div class="refsect2">
544
<a name="gst-audio-base-sink-get-alignment-threshold"></a><h3>gst_audio_base_sink_get_alignment_threshold ()</h3>
545
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a>
546
gst_audio_base_sink_get_alignment_threshold
547
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);</pre>
548
<p>Get the current alignment threshold, in nanoseconds, used by <em class="parameter"><code>sink</code></em>
549
.</p>
550
<div class="refsect3">
551
<a name="id-1.2.6.13.10.12.5"></a><h4>Parameters</h4>
552
<div class="informaltable"><table width="100%" border="0">
553
<colgroup>
554
<col width="150px" class="parameters_name">
555
<col class="parameters_description">
556
<col width="200px" class="parameters_annotations">
557
</colgroup>
558
<tbody><tr>
559
<td class="parameter_name"><p>sink</p></td>
560
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a></p></td>
561
<td class="parameter_annotations"> </td>
562
</tr></tbody>
563
</table></div>
564
</div>
565
<div class="refsect3">
566
<a name="id-1.2.6.13.10.12.6"></a><h4>Returns</h4>
567
<p> The current alignment threshold used by <em class="parameter"><code>sink</code></em>
568
.</p>
569
<p></p>
570
</div>
571
</div>
572
<hr>
573
<div class="refsect2">
574
<a name="gst-audio-base-sink-set-discont-wait"></a><h3>gst_audio_base_sink_set_discont_wait ()</h3>
575
<pre class="programlisting"><span class="returnvalue">void</span>
576
gst_audio_base_sink_set_discont_wait (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
577
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> discont_wait</code></em>);</pre>
578
<p>Controls how long the sink will wait before creating a discontinuity.</p>
579
<div class="refsect3">
580
<a name="id-1.2.6.13.10.13.5"></a><h4>Parameters</h4>
581
<div class="informaltable"><table width="100%" border="0">
582
<colgroup>
583
<col width="150px" class="parameters_name">
584
<col class="parameters_description">
585
<col width="200px" class="parameters_annotations">
586
</colgroup>
587
<tbody>
588
<tr>
589
<td class="parameter_name"><p>sink</p></td>
590
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a></p></td>
591
<td class="parameter_annotations"> </td>
592
</tr>
593
<tr>
594
<td class="parameter_name"><p>discont_wait</p></td>
595
<td class="parameter_description"><p>the new discont wait in nanoseconds</p></td>
596
<td class="parameter_annotations"> </td>
597
</tr>
598
</tbody>
599
</table></div>
600
</div>
601
</div>
602
<hr>
603
<div class="refsect2">
604
<a name="gst-audio-base-sink-get-discont-wait"></a><h3>gst_audio_base_sink_get_discont_wait ()</h3>
605
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a>
606
gst_audio_base_sink_get_discont_wait (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);</pre>
607
<p>Get the current discont wait, in nanoseconds, used by <em class="parameter"><code>sink</code></em>
608
.</p>
609
<div class="refsect3">
610
<a name="id-1.2.6.13.10.14.5"></a><h4>Parameters</h4>
611
<div class="informaltable"><table width="100%" border="0">
612
<colgroup>
613
<col width="150px" class="parameters_name">
614
<col class="parameters_description">
615
<col width="200px" class="parameters_annotations">
616
</colgroup>
617
<tbody><tr>
618
<td class="parameter_name"><p>sink</p></td>
619
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a></p></td>
620
<td class="parameter_annotations"> </td>
621
</tr></tbody>
622
</table></div>
623
</div>
624
<div class="refsect3">
625
<a name="id-1.2.6.13.10.14.6"></a><h4>Returns</h4>
626
<p> The current discont wait used by <em class="parameter"><code>sink</code></em>
627
.</p>
628
<p></p>
629
</div>
630
</div>
631
</div>
632
<div class="refsect1">
633
<a name="gst-plugins-base-libs-gstaudiobasesink.other_details"></a><h2>Types and Values</h2>
119
634
<div class="refsect2">
120
635
<a name="GstAudioBaseSink-struct"></a><h3>struct GstAudioBaseSink</h3>
121
636
<pre class="programlisting">struct GstAudioBaseSink;</pre>
122
<p>
123
Opaque <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>.
124
</p>
637
<p>Opaque <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>.</p>
125
638
</div>
126
639
<hr>
127
640
<div class="refsect2">
137
650
GstBuffer *buffer);
138
651
};
139
652
</pre>
140
<p>
141
<a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> class. Override the vmethod to implement
142
functionality.
143
</p>
144
<div class="variablelist"><table border="0" class="variablelist">
653
<p><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> class. Override the vmethod to implement
654
functionality.</p>
655
<div class="refsect3">
656
<a name="id-1.2.6.13.11.3.5"></a><h4>Members</h4>
657
<div class="informaltable"><table width="100%" border="0">
145
658
<colgroup>
146
<col align="left" valign="top">
147
<col>
659
<col width="300px" class="struct_members_name">
660
<col class="struct_members_description">
661
<col width="200px" class="struct_members_annotations">
148
662
</colgroup>
149
663
<tbody>
150
664
<tr>
151
<td><p><span class="term"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html#GstBaseSinkClass"><span class="type">GstBaseSinkClass</span></a> <em class="structfield"><code><a name="GstAudioBaseSinkClass.parent-class"></a>parent_class</code></em>;</span></p></td>
152
<td>the parent class.</td>
153
</tr>
154
<tr>
155
<td><p><span class="term"><em class="structfield"><code><a name="GstAudioBaseSinkClass.create-ringbuffer"></a>create_ringbuffer</code></em> ()</span></p></td>
156
<td>create and return a <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="type">GstAudioRingBuffer</span></a> to write to.</td>
157
</tr>
158
<tr>
159
<td><p><span class="term"><em class="structfield"><code><a name="GstAudioBaseSinkClass.payload"></a>payload</code></em> ()</span></p></td>
160
<td>payload data in a format suitable to write to the sink. If no
665
<td class="struct_member_name"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html#GstBaseSinkClass"><span class="type">GstBaseSinkClass</span></a> <em class="structfield"><code><a name="GstAudioBaseSinkClass.parent-class"></a>parent_class</code></em>;</p></td>
666
<td class="struct_member_description"><p>the parent class.</p></td>
667
<td class="struct_member_annotations"> </td>
668
</tr>
669
<tr>
670
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAudioBaseSinkClass.create-ringbuffer"></a>create_ringbuffer</code></em> ()</p></td>
671
<td class="struct_member_description"><p>create and return a <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="type">GstAudioRingBuffer</span></a> to write to.</p></td>
672
<td class="struct_member_annotations"> </td>
673
</tr>
674
<tr>
675
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAudioBaseSinkClass.payload"></a>payload</code></em> ()</p></td>
676
<td class="struct_member_description"><p>payload data in a format suitable to write to the sink. If no
161
677
payloading is required, returns a reffed copy of the original
162
678
buffer, else returns the payloaded buffer with all other metadata
163
copied.</td>
679
copied.</p></td>
680
<td class="struct_member_annotations"> </td>
164
681
</tr>
165
682
</tbody>
166
683
</table></div>
167
684
</div>
685
</div>
168
686
<hr>
169
687
<div class="refsect2">
170
688
<a name="GstAudioBaseSinkSlaveMethod"></a><h3>enum GstAudioBaseSinkSlaveMethod</h3>
171
<pre class="programlisting">typedef enum {
172
GST_AUDIO_BASE_SINK_SLAVE_RESAMPLE,
173
GST_AUDIO_BASE_SINK_SLAVE_SKEW,
174
GST_AUDIO_BASE_SINK_SLAVE_NONE
175
} GstAudioBaseSinkSlaveMethod;
176
</pre>
177
<p>
178
Different possible clock slaving algorithms used when the internal audio
179
clock is not selected as the pipeline master clock.
180
</p>
181
<div class="variablelist"><table border="0" class="variablelist">
182
<colgroup>
183
<col align="left" valign="top">
184
<col>
185
</colgroup>
186
<tbody>
187
<tr>
188
<td><p><a name="GST-AUDIO-BASE-SINK-SLAVE-RESAMPLE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_BASE_SINK_SLAVE_RESAMPLE</code></span></p></td>
189
<td>Resample to match the master clock
190
</td>
191
</tr>
192
<tr>
193
<td><p><a name="GST-AUDIO-BASE-SINK-SLAVE-SKEW:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_BASE_SINK_SLAVE_SKEW</code></span></p></td>
194
<td>Adjust playout pointer when master clock
195
drifts too much.
196
</td>
197
</tr>
198
<tr>
199
<td><p><a name="GST-AUDIO-BASE-SINK-SLAVE-NONE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_BASE_SINK_SLAVE_NONE</code></span></p></td>
200
<td>No adjustment is done.
201
</td>
202
</tr>
203
</tbody>
204
</table></div>
205
</div>
206
<hr>
207
<div class="refsect2">
208
<a name="GST-AUDIO-BASE-SINK-CLOCK:CAPS"></a><h3>GST_AUDIO_BASE_SINK_CLOCK()</h3>
209
<pre class="programlisting">#define GST_AUDIO_BASE_SINK_CLOCK(obj) (GST_AUDIO_BASE_SINK (obj)->clock)
210
</pre>
211
<p>
212
Get the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html"><span class="type">GstClock</span></a> of <em class="parameter"><code>obj</code></em>.
213
</p>
214
<div class="variablelist"><table border="0" class="variablelist">
215
<colgroup>
216
<col align="left" valign="top">
217
<col>
218
</colgroup>
219
<tbody><tr>
220
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
221
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>
222
</td>
223
</tr></tbody>
224
</table></div>
225
</div>
226
<hr>
227
<div class="refsect2">
228
<a name="GST-AUDIO-BASE-SINK-PAD:CAPS"></a><h3>GST_AUDIO_BASE_SINK_PAD()</h3>
229
<pre class="programlisting">#define GST_AUDIO_BASE_SINK_PAD(obj) (GST_BASE_SINK (obj)->sinkpad)
230
</pre>
231
<p>
232
Get the sink <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> of <em class="parameter"><code>obj</code></em>.
233
</p>
234
<div class="variablelist"><table border="0" class="variablelist">
235
<colgroup>
236
<col align="left" valign="top">
237
<col>
238
</colgroup>
239
<tbody><tr>
240
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
241
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>
242
</td>
243
</tr></tbody>
244
</table></div>
245
</div>
246
<hr>
247
<div class="refsect2">
248
<a name="gst-audio-base-sink-create-ringbuffer"></a><h3>gst_audio_base_sink_create_ringbuffer ()</h3>
249
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="returnvalue">GstAudioRingBuffer</span></a> * gst_audio_base_sink_create_ringbuffer
250
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);</pre>
251
<p>
252
Create and return the <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="type">GstAudioRingBuffer</span></a> for <em class="parameter"><code>sink</code></em>. This function will call the
253
::create_ringbuffer vmethod and will set <em class="parameter"><code>sink</code></em> as the parent of the returned
254
buffer (see <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html#gst-object-set-parent"><code class="function">gst_object_set_parent()</code></a>).
255
</p>
256
<div class="variablelist"><table border="0" class="variablelist">
257
<colgroup>
258
<col align="left" valign="top">
259
<col>
260
</colgroup>
261
<tbody>
262
<tr>
263
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
264
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>.</td>
265
</tr>
266
<tr>
267
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
268
<td>The new ringbuffer of <em class="parameter"><code>sink</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
269
</td>
270
</tr>
271
</tbody>
272
</table></div>
273
</div>
274
<hr>
275
<div class="refsect2">
276
<a name="gst-audio-base-sink-set-provide-clock"></a><h3>gst_audio_base_sink_set_provide_clock ()</h3>
277
<pre class="programlisting"><span class="returnvalue">void</span> gst_audio_base_sink_set_provide_clock
278
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
279
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> provide</code></em>);</pre>
280
<p>
281
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="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>,
282
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html#gst-element-provide-clock"><code class="function">gst_element_provide_clock()</code></a> will return a clock that reflects the datarate
283
of <em class="parameter"><code>sink</code></em>. If <em class="parameter"><code>provide</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html#gst-element-provide-clock"><code class="function">gst_element_provide_clock()</code></a> will return NULL.
284
</p>
285
<div class="variablelist"><table border="0" class="variablelist">
286
<colgroup>
287
<col align="left" valign="top">
288
<col>
289
</colgroup>
290
<tbody>
291
<tr>
292
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
293
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>
294
</td>
295
</tr>
296
<tr>
297
<td><p><span class="term"><em class="parameter"><code>provide</code></em> :</span></p></td>
298
<td>new state</td>
299
</tr>
300
</tbody>
301
</table></div>
302
</div>
303
<hr>
304
<div class="refsect2">
305
<a name="gst-audio-base-sink-get-provide-clock"></a><h3>gst_audio_base_sink_get_provide_clock ()</h3>
306
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_audio_base_sink_get_provide_clock
307
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);</pre>
308
<p>
309
Queries whether <em class="parameter"><code>sink</code></em> will provide a clock or not. See also
310
gst_audio_base_sink_set_provide_clock.
311
</p>
312
<div class="variablelist"><table border="0" class="variablelist">
313
<colgroup>
314
<col align="left" valign="top">
315
<col>
316
</colgroup>
317
<tbody>
318
<tr>
319
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
320
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>
321
</td>
322
</tr>
323
<tr>
324
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
325
<td>
326
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>sink</code></em> will provide a clock.</td>
327
</tr>
328
</tbody>
329
</table></div>
330
</div>
331
<hr>
332
<div class="refsect2">
333
<a name="gst-audio-base-sink-set-slave-method"></a><h3>gst_audio_base_sink_set_slave_method ()</h3>
334
<pre class="programlisting"><span class="returnvalue">void</span> gst_audio_base_sink_set_slave_method
335
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
336
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod"><span class="type">GstAudioBaseSinkSlaveMethod</span></a> method</code></em>);</pre>
337
<p>
338
Controls how clock slaving will be performed in <em class="parameter"><code>sink</code></em>.
339
</p>
340
<div class="variablelist"><table border="0" class="variablelist">
341
<colgroup>
342
<col align="left" valign="top">
343
<col>
344
</colgroup>
345
<tbody>
346
<tr>
347
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
348
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>
349
</td>
350
</tr>
351
<tr>
352
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
353
<td>the new slave method</td>
354
</tr>
355
</tbody>
356
</table></div>
357
</div>
358
<hr>
359
<div class="refsect2">
360
<a name="gst-audio-base-sink-get-slave-method"></a><h3>gst_audio_base_sink_get_slave_method ()</h3>
361
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod"><span class="returnvalue">GstAudioBaseSinkSlaveMethod</span></a> gst_audio_base_sink_get_slave_method
362
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);</pre>
363
<p>
364
Get the current slave method used by <em class="parameter"><code>sink</code></em>.
365
</p>
366
<div class="variablelist"><table border="0" class="variablelist">
367
<colgroup>
368
<col align="left" valign="top">
369
<col>
370
</colgroup>
371
<tbody>
372
<tr>
373
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
374
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>
375
</td>
376
</tr>
377
<tr>
378
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
379
<td>The current slave method used by <em class="parameter"><code>sink</code></em>.</td>
380
</tr>
381
</tbody>
382
</table></div>
383
</div>
384
<hr>
385
<div class="refsect2">
386
<a name="gst-audio-base-sink-set-drift-tolerance"></a><h3>gst_audio_base_sink_set_drift_tolerance ()</h3>
387
<pre class="programlisting"><span class="returnvalue">void</span> gst_audio_base_sink_set_drift_tolerance
388
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
389
<em class="parameter"><code><span class="type">gint64</span> drift_tolerance</code></em>);</pre>
390
<p>
391
Controls the sink's drift tolerance.
392
</p>
393
<div class="variablelist"><table border="0" class="variablelist">
394
<colgroup>
395
<col align="left" valign="top">
396
<col>
397
</colgroup>
398
<tbody>
399
<tr>
400
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
401
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>
402
</td>
403
</tr>
404
<tr>
405
<td><p><span class="term"><em class="parameter"><code>drift_tolerance</code></em> :</span></p></td>
406
<td>the new drift tolerance in microseconds</td>
407
</tr>
408
</tbody>
409
</table></div>
410
</div>
411
<hr>
412
<div class="refsect2">
413
<a name="gst-audio-base-sink-get-drift-tolerance"></a><h3>gst_audio_base_sink_get_drift_tolerance ()</h3>
414
<pre class="programlisting"><span class="returnvalue">gint64</span> gst_audio_base_sink_get_drift_tolerance
415
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);</pre>
416
<p>
417
Get the current drift tolerance, in microseconds, used by <em class="parameter"><code>sink</code></em>.
418
</p>
419
<div class="variablelist"><table border="0" class="variablelist">
420
<colgroup>
421
<col align="left" valign="top">
422
<col>
423
</colgroup>
424
<tbody>
425
<tr>
426
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
427
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>
428
</td>
429
</tr>
430
<tr>
431
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
432
<td>The current drift tolerance used by <em class="parameter"><code>sink</code></em>.</td>
433
</tr>
434
</tbody>
435
</table></div>
436
</div>
437
<hr>
438
<div class="refsect2">
439
<a name="gst-audio-base-sink-set-alignment-threshold"></a><h3>gst_audio_base_sink_set_alignment_threshold ()</h3>
440
<pre class="programlisting"><span class="returnvalue">void</span> gst_audio_base_sink_set_alignment_threshold
441
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
442
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> alignment_threshold</code></em>);</pre>
443
<p>
444
Controls the sink's alignment threshold.
445
</p>
446
<div class="variablelist"><table border="0" class="variablelist">
447
<colgroup>
448
<col align="left" valign="top">
449
<col>
450
</colgroup>
451
<tbody>
452
<tr>
453
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
454
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>
455
</td>
456
</tr>
457
<tr>
458
<td><p><span class="term"><em class="parameter"><code>alignment_threshold</code></em> :</span></p></td>
459
<td>the new alignment threshold in nanoseconds</td>
460
</tr>
461
</tbody>
462
</table></div>
463
</div>
464
<hr>
465
<div class="refsect2">
466
<a name="gst-audio-base-sink-get-alignment-threshold"></a><h3>gst_audio_base_sink_get_alignment_threshold ()</h3>
467
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a> gst_audio_base_sink_get_alignment_threshold
468
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);</pre>
469
<p>
470
Get the current alignment threshold, in nanoseconds, used by <em class="parameter"><code>sink</code></em>.
471
</p>
472
<div class="variablelist"><table border="0" class="variablelist">
473
<colgroup>
474
<col align="left" valign="top">
475
<col>
476
</colgroup>
477
<tbody>
478
<tr>
479
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
480
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>
481
</td>
482
</tr>
483
<tr>
484
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
485
<td>The current alignment threshold used by <em class="parameter"><code>sink</code></em>.</td>
486
</tr>
487
</tbody>
488
</table></div>
489
</div>
490
<hr>
491
<div class="refsect2">
492
<a name="gst-audio-base-sink-set-discont-wait"></a><h3>gst_audio_base_sink_set_discont_wait ()</h3>
493
<pre class="programlisting"><span class="returnvalue">void</span> gst_audio_base_sink_set_discont_wait
494
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>,
495
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> discont_wait</code></em>);</pre>
496
<p>
497
Controls how long the sink will wait before creating a discontinuity.
498
</p>
499
<div class="variablelist"><table border="0" class="variablelist">
500
<colgroup>
501
<col align="left" valign="top">
502
<col>
503
</colgroup>
504
<tbody>
505
<tr>
506
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
507
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>
508
</td>
509
</tr>
510
<tr>
511
<td><p><span class="term"><em class="parameter"><code>discont_wait</code></em> :</span></p></td>
512
<td>the new discont wait in nanoseconds</td>
513
</tr>
514
</tbody>
515
</table></div>
516
</div>
517
<hr>
518
<div class="refsect2">
519
<a name="gst-audio-base-sink-get-discont-wait"></a><h3>gst_audio_base_sink_get_discont_wait ()</h3>
520
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a> gst_audio_base_sink_get_discont_wait
521
(<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a> *sink</code></em>);</pre>
522
<p>
523
Get the current discont wait, in nanoseconds, used by <em class="parameter"><code>sink</code></em>.
524
</p>
525
<div class="variablelist"><table border="0" class="variablelist">
526
<colgroup>
527
<col align="left" valign="top">
528
<col>
529
</colgroup>
530
<tbody>
531
<tr>
532
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
533
<td>a <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSink"><span class="type">GstAudioBaseSink</span></a>
534
</td>
535
</tr>
536
<tr>
537
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
538
<td>The current discont wait used by <em class="parameter"><code>sink</code></em>.</td>
539
</tr>
540
</tbody>
541
</table></div>
689
<p>Different possible clock slaving algorithms used when the internal audio
690
clock is not selected as the pipeline master clock.</p>
691
<div class="refsect3">
692
<a name="id-1.2.6.13.11.4.4"></a><h4>Members</h4>
693
<div class="informaltable"><table width="100%" border="0">
694
<colgroup>
695
<col width="300px" class="enum_members_name">
696
<col class="enum_members_description">
697
<col width="200px" class="enum_members_annotations">
698
</colgroup>
699
<tbody>
700
<tr>
701
<td class="enum_member_name"><p><a name="GST-AUDIO-BASE-SINK-SLAVE-RESAMPLE:CAPS"></a>GST_AUDIO_BASE_SINK_SLAVE_RESAMPLE</p></td>
702
<td class="enum_member_description">
703
<p>Resample to match the master clock</p>
704
</td>
705
<td class="enum_member_annotations"> </td>
706
</tr>
707
<tr>
708
<td class="enum_member_name"><p><a name="GST-AUDIO-BASE-SINK-SLAVE-SKEW:CAPS"></a>GST_AUDIO_BASE_SINK_SLAVE_SKEW</p></td>
709
<td class="enum_member_description">
710
<p>Adjust playout pointer when master clock
711
drifts too much.</p>
712
</td>
713
<td class="enum_member_annotations"> </td>
714
</tr>
715
<tr>
716
<td class="enum_member_name"><p><a name="GST-AUDIO-BASE-SINK-SLAVE-NONE:CAPS"></a>GST_AUDIO_BASE_SINK_SLAVE_NONE</p></td>
717
<td class="enum_member_description">
718
<p>No adjustment is done.</p>
719
</td>
720
<td class="enum_member_annotations"> </td>
721
</tr>
722
</tbody>
723
</table></div>
724
</div>
542
725
</div>
543
726
</div>
544
727
<div class="refsect1">
545
728
<a name="gst-plugins-base-libs-gstaudiobasesink.property-details"></a><h2>Property Details</h2>
546
729
<div class="refsect2">
547
<a name="GstAudioBaseSink--alignment-threshold"></a><h3>The <code class="literal">"alignment-threshold"</code> property</h3>
548
<pre class="programlisting"> "alignment-threshold" <span class="type">guint64</span> : Read / Write</pre>
730
<a name="GstAudioBaseSink--alignment-threshold"></a><h3>The <code class="literal">“alignment-threshold”</code> property</h3>
731
<pre class="programlisting"> “alignment-threshold” <span class="type">guint64</span></pre>
549
732
<p>Timestamp alignment threshold in nanoseconds.</p>
733
<p>Flags: Read / Write</p>
550
734
<p>Allowed values: [1,18446744073709551614]</p>
551
735
<p>Default value: 40000000</p>
552
736
</div>
553
737
<hr>
554
738
<div class="refsect2">
555
<a name="GstAudioBaseSink--buffer-time"></a><h3>The <code class="literal">"buffer-time"</code> property</h3>
556
<pre class="programlisting"> "buffer-time" <span class="type">gint64</span> : Read / Write</pre>
739
<a name="GstAudioBaseSink--buffer-time"></a><h3>The <code class="literal">“buffer-time”</code> property</h3>
740
<pre class="programlisting"> “buffer-time” <span class="type">gint64</span></pre>
557
741
<p>Size of audio buffer in microseconds, this is the minimum latency that the sink reports.</p>
742
<p>Flags: Read / Write</p>
558
743
<p>Allowed values: >= 1</p>
559
744
<p>Default value: 200000</p>
560
745
</div>
561
746
<hr>
562
747
<div class="refsect2">
563
<a name="GstAudioBaseSink--can-activate-pull"></a><h3>The <code class="literal">"can-activate-pull"</code> property</h3>
564
<pre class="programlisting"> "can-activate-pull" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
748
<a name="GstAudioBaseSink--can-activate-pull"></a><h3>The <code class="literal">“can-activate-pull”</code> property</h3>
749
<pre class="programlisting"> “can-activate-pull” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
565
750
<p>Allow pull-based scheduling.</p>
751
<p>Flags: Read / Write</p>
566
752
<p>Default value: FALSE</p>
567
753
</div>
568
754
<hr>
569
755
<div class="refsect2">
570
<a name="GstAudioBaseSink--discont-wait"></a><h3>The <code class="literal">"discont-wait"</code> property</h3>
571
<pre class="programlisting"> "discont-wait" <span class="type">guint64</span> : Read / Write</pre>
572
<p>
573
A window of time in nanoseconds to wait before creating a discontinuity as
574
a result of breaching the drift-tolerance.
575
</p>
756
<a name="GstAudioBaseSink--discont-wait"></a><h3>The <code class="literal">“discont-wait”</code> property</h3>
757
<pre class="programlisting"> “discont-wait” <span class="type">guint64</span></pre>
758
<p>A window of time in nanoseconds to wait before creating a discontinuity as
759
a result of breaching the drift-tolerance.</p>
760
<p>Flags: Read / Write</p>
576
761
<p>Allowed values: <= 18446744073709551614</p>
577
762
<p>Default value: 1000000000</p>
578
763
</div>
579
764
<hr>
580
765
<div class="refsect2">
581
<a name="GstAudioBaseSink--drift-tolerance"></a><h3>The <code class="literal">"drift-tolerance"</code> property</h3>
582
<pre class="programlisting"> "drift-tolerance" <span class="type">gint64</span> : Read / Write</pre>
583
<p>
584
Controls the amount of time in microseconds that clocks are allowed
585
to drift before resynchronisation happens.
586
</p>
766
<a name="GstAudioBaseSink--drift-tolerance"></a><h3>The <code class="literal">“drift-tolerance”</code> property</h3>
767
<pre class="programlisting"> “drift-tolerance” <span class="type">gint64</span></pre>
768
<p>Controls the amount of time in microseconds that clocks are allowed
769
to drift before resynchronisation happens.</p>
770
<p>Flags: Read / Write</p>
587
771
<p>Allowed values: >= 1</p>
588
772
<p>Default value: 40000</p>
589
773
</div>
590
774
<hr>
591
775
<div class="refsect2">
592
<a name="GstAudioBaseSink--latency-time"></a><h3>The <code class="literal">"latency-time"</code> property</h3>
593
<pre class="programlisting"> "latency-time" <span class="type">gint64</span> : Read / Write</pre>
776
<a name="GstAudioBaseSink--latency-time"></a><h3>The <code class="literal">“latency-time”</code> property</h3>
777
<pre class="programlisting"> “latency-time” <span class="type">gint64</span></pre>
594
778
<p>The minimum amount of data to write in each iteration in microseconds.</p>
779
<p>Flags: Read / Write</p>
595
780
<p>Allowed values: >= 1</p>
596
781
<p>Default value: 10000</p>
597
782
</div>
598
783
<hr>
599
784
<div class="refsect2">
600
<a name="GstAudioBaseSink--provide-clock"></a><h3>The <code class="literal">"provide-clock"</code> property</h3>
601
<pre class="programlisting"> "provide-clock" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
785
<a name="GstAudioBaseSink--provide-clock"></a><h3>The <code class="literal">“provide-clock”</code> property</h3>
786
<pre class="programlisting"> “provide-clock” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
602
787
<p>Provide a clock to be used as the global pipeline clock.</p>
788
<p>Flags: Read / Write</p>
603
789
<p>Default value: TRUE</p>
604
790
</div>
605
791
<hr>
606
792
<div class="refsect2">
607
<a name="GstAudioBaseSink--slave-method"></a><h3>The <code class="literal">"slave-method"</code> property</h3>
608
<pre class="programlisting"> "slave-method" <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod"><span class="type">GstAudioBaseSinkSlaveMethod</span></a> : Read / Write</pre>
793
<a name="GstAudioBaseSink--slave-method"></a><h3>The <code class="literal">“slave-method”</code> property</h3>
794
<pre class="programlisting"> “slave-method” <a class="link" href="gst-plugins-base-libs-gstaudiobasesink.html#GstAudioBaseSinkSlaveMethod" title="enum GstAudioBaseSinkSlaveMethod"><span class="type">GstAudioBaseSinkSlaveMethod</span></a></pre>
609
795
<p>Algorithm to use to match the rate of the masterclock.</p>
796
<p>Flags: Read / Write</p>
610
797
<p>Default value: GST_AUDIO_BASE_SINK_SLAVE_SKEW</p>
611
798
</div>
612
799
</div>
613
800
<div class="refsect1">
614
801
<a name="gst-plugins-base-libs-gstaudiobasesink.see-also"></a><h2>See Also</h2>
615
<a class="link" href="gst-plugins-base-libs-gstaudiosink.html#GstAudioSink"><span class="type">GstAudioSink</span></a>, <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="type">GstAudioRingBuffer</span></a>.
802
<p><a class="link" href="gst-plugins-base-libs-gstaudiosink.html#GstAudioSink"><span class="type">GstAudioSink</span></a>, <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBuffer"><span class="type">GstAudioRingBuffer</span></a>.</p>
616
803
</div>
617
804
</div>
618
805
<div class="footer">
619
806
<hr>
620
Generated by GTK-Doc V1.19</div>
807
Generated by GTK-Doc V1.20</div>
621
808
</body>
622
809
</html>
b'\\ No newline at end of file'
Loggerhead is a web-based interface for Breezy
Version: 2.0.1