docs/libs/html/gst-plugins-base-libs-gstbaseaudiosink.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>gstbaseaudiosink</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-audio.html" title="Audio Library">
   9 <link rel="prev" href="gst-plugins-base-libs-gstaudiosrc.html" title="gstaudiosrc">
  10 <link rel="next" href="gst-plugins-base-libs-gstbaseaudiosrc.html" title="gstbaseaudiosrc">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  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 0.10 Library Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-libs-gstbaseaudiosrc.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-gstbaseaudiosink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gstbaseaudiosink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-libs-gstbaseaudiosink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-libs-gstbaseaudiosink.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-base-libs-gstbaseaudiosink"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstbaseaudiosink.top_of_page"></a>gstbaseaudiosink</span></h2>
  38 <p>gstbaseaudiosink — Base class for audio sinks</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-base-libs-gstbaseaudiosink.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstBaseAudioSink"></a><pre class="synopsis">
  45 #include &lt;gst/audio/gstbaseaudiosink.h&gt;
  46
  47 struct              <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink-struct" title="struct GstBaseAudioSink">GstBaseAudioSink</a>;
  48 struct              <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSinkClass" title="struct GstBaseAudioSinkClass">GstBaseAudioSinkClass</a>;
  49 enum                <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSinkSlaveMethod" title="enum GstBaseAudioSinkSlaveMethod">GstBaseAudioSinkSlaveMethod</a>;
  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)
  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)
  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>
  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>);
  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>
  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="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-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>
  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>);
  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>
  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>);
  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>
  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>);
  64 <span class="returnvalue">gint64</span>              <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#gst-base-audio-sink-get-drift-tolerance" title="gst_base_audio_sink_get_drift_tolerance ()">gst_base_audio_sink_get_drift_tolerance</a>
  65                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>);
  66 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#gst-base-audio-sink-set-drift-tolerance" title="gst_base_audio_sink_set_drift_tolerance ()">gst_base_audio_sink_set_drift_tolerance</a>
  67                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>,
  68                                                          <em class="parameter"><code><span class="type">gint64</span> drift_tolerance</code></em>);
  69 </pre>
  70 </div>
  71 <div class="refsect1">
  72 <a name="gst-plugins-base-libs-gstbaseaudiosink.object-hierarchy"></a><h2>Object Hierarchy</h2>
  73 <pre class="synopsis">
  74   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  75    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  76          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  77                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a>
  78                      +----GstBaseAudioSink
  79                            +----<a class="link" href="gst-plugins-base-libs-gstaudiosink.html#GstAudioSink">GstAudioSink</a>
  80 </pre>
  81 </div>
  82 <div class="refsect1">
  83 <a name="gst-plugins-base-libs-gstbaseaudiosink.properties"></a><h2>Properties</h2>
  84 <pre class="synopsis">
  85   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink--alignment-threshold" title='The "alignment-threshold" property'>alignment-threshold</a>"      <span class="type">guint64</span>               : Read / Write
  86   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink--buffer-time" title='The "buffer-time" property'>buffer-time</a>"              <span class="type">gint64</span>                : Read / Write
  87   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink--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
  88   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink--discont-wait" title='The "discont-wait" property'>discont-wait</a>"             <span class="type">guint64</span>               : Read / Write
  89   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink--drift-tolerance" title='The "drift-tolerance" property'>drift-tolerance</a>"          <span class="type">gint64</span>                : Read / Write
  90   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink--latency-time" title='The "latency-time" property'>latency-time</a>"             <span class="type">gint64</span>                : Read / Write
  91   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink--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
  92   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink--slave-method" title='The "slave-method" property'>slave-method</a>"             <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSinkSlaveMethod" title="enum GstBaseAudioSinkSlaveMethod"><span class="type">GstBaseAudioSinkSlaveMethod</span></a>  : Read / Write
  93 </pre>
  94 </div>
  95 <div class="refsect1">
  96 <a name="gst-plugins-base-libs-gstbaseaudiosink.description"></a><h2>Description</h2>
  97 <p>
  98 This is the base class for audio sinks. Subclasses need to implement the
  99 ::create_ringbuffer vmethod. This base class will then take care of
 100 writing samples to the ringbuffer, synchronisation, clipping and flushing.
 101 </p>
 102 <p>
 103 Last reviewed on 2006-09-27 (0.10.12)
 104 </p>
 105 </div>
 106 <div class="refsect1">
 107 <a name="gst-plugins-base-libs-gstbaseaudiosink.details"></a><h2>Details</h2>
 108 <div class="refsect2">
 109 <a name="GstBaseAudioSink-struct"></a><h3>struct GstBaseAudioSink</h3>
 110 <pre class="programlisting">struct GstBaseAudioSink;</pre>
 111 <p>
 112 Opaque <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>.
 113 </p>
 114 </div>
 115 <hr>
 116 <div class="refsect2">
 117 <a name="GstBaseAudioSinkClass"></a><h3>struct GstBaseAudioSinkClass</h3>
 118 <pre class="programlisting">struct GstBaseAudioSinkClass {
 119   GstBaseSinkClass parent_class;
 120
 121   /* subclass ringbuffer allocation */
 122   GstRingBuffer* (*create_ringbuffer)  (GstBaseAudioSink *sink);
 123
 124   /* subclass payloader */
 125   GstBuffer*     (*payload)            (GstBaseAudioSink *sink,
 126                                         GstBuffer        *buffer);
 127 };
 128 </pre>
 129 <p>
 130 <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> class. Override the vmethod to implement
 131 functionality.
 132 </p>
 133 <div class="variablelist"><table border="0">
 134 <col align="left" valign="top">
 135 <tbody>
 136 <tr>
 137 <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="GstBaseAudioSinkClass.parent-class"></a>parent_class</code></em>;</span></p></td>
 138 <td>the parent class.</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term"><em class="structfield"><code><a name="GstBaseAudioSinkClass.create-ringbuffer"></a>create_ringbuffer</code></em> ()</span></p></td>
 142 <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.</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term"><em class="structfield"><code><a name="GstBaseAudioSinkClass.payload"></a>payload</code></em> ()</span></p></td>
 146 <td>payload data in a format suitable to write to the sink. If no
 147 payloading is required, returns a reffed copy of the original
 148 buffer, else returns the payloaded buffer with all other metadata
 149 copied. (Since: 0.10.36)</td>
 150 </tr>
 151 </tbody>
 152 </table></div>
 153 </div>
 154 <hr>
 155 <div class="refsect2">
 156 <a name="GstBaseAudioSinkSlaveMethod"></a><h3>enum GstBaseAudioSinkSlaveMethod</h3>
 157 <pre class="programlisting">typedef enum {
 158   GST_BASE_AUDIO_SINK_SLAVE_RESAMPLE,
 159   GST_BASE_AUDIO_SINK_SLAVE_SKEW,
 160   GST_BASE_AUDIO_SINK_SLAVE_NONE
 161 } GstBaseAudioSinkSlaveMethod;
 162 </pre>
 163 <p>
 164 Different possible clock slaving algorithms used when the internal audio
 165 clock is not selected as the pipeline master clock.
 166 </p>
 167 <div class="variablelist"><table border="0">
 168 <col align="left" valign="top">
 169 <tbody>
 170 <tr>
 171 <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>
 172 <td>Resample to match the master clock
 173 </td>
 174 </tr>
 175 <tr>
 176 <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>
 177 <td>Adjust playout pointer when master clock
 178 drifts too much.
 179 </td>
 180 </tr>
 181 <tr>
 182 <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>
 183 <td>No adjustment is done.
 184 </td>
 185 </tr>
 186 </tbody>
 187 </table></div>
 188 </div>
 189 <hr>
 190 <div class="refsect2">
 191 <a name="GST-BASE-AUDIO-SINK-CLOCK:CAPS"></a><h3>GST_BASE_AUDIO_SINK_CLOCK()</h3>
 192 <pre class="programlisting">#define GST_BASE_AUDIO_SINK_CLOCK(obj)   (GST_BASE_AUDIO_SINK (obj)-&gt;clock)
 193 </pre>
 194 <p>
 195 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>.
 196 </p>
 197 <div class="variablelist"><table border="0">
 198 <col align="left" valign="top">
 199 <tbody><tr>
 200 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 201 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
 202 </td>
 203 </tr></tbody>
 204 </table></div>
 205 </div>
 206 <hr>
 207 <div class="refsect2">
 208 <a name="GST-BASE-AUDIO-SINK-PAD:CAPS"></a><h3>GST_BASE_AUDIO_SINK_PAD()</h3>
 209 <pre class="programlisting">#define GST_BASE_AUDIO_SINK_PAD(obj)     (GST_BASE_SINK (obj)-&gt;sinkpad)
 210 </pre>
 211 <p>
 212 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>.
 213 </p>
 214 <div class="variablelist"><table border="0">
 215 <col align="left" valign="top">
 216 <tbody><tr>
 217 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 218 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
 219 </td>
 220 </tr></tbody>
 221 </table></div>
 222 </div>
 223 <hr>
 224 <div class="refsect2">
 225 <a name="gst-base-audio-sink-create-ringbuffer"></a><h3>gst_base_audio_sink_create_ringbuffer ()</h3>
 226 <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
 227                                                         (<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>
 228 <p>
 229 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
 230 ::create_ringbuffer vmethod and will set <em class="parameter"><code>sink</code></em> as the parent of the returned
 231 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>).
 232 </p>
 233 <div class="variablelist"><table border="0">
 234 <col align="left" valign="top">
 235 <tbody>
 236 <tr>
 237 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
 238 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>.</td>
 239 </tr>
 240 <tr>
 241 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 242 <td>The new ringbuffer of <em class="parameter"><code>sink</code></em>.</td>
 243 </tr>
 244 </tbody>
 245 </table></div>
 246 </div>
 247 <hr>
 248 <div class="refsect2">
 249 <a name="gst-base-audio-sink-set-provide-clock"></a><h3>gst_base_audio_sink_set_provide_clock ()</h3>
 250 <pre class="programlisting"><span class="returnvalue">void</span>                gst_base_audio_sink_set_provide_clock
 251                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>,
 252                                                          <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>
 253 <p>
 254 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>,
 255 <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
 256 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.
 257 </p>
 258 <div class="variablelist"><table border="0">
 259 <col align="left" valign="top">
 260 <tbody>
 261 <tr>
 262 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
 263 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
 264 </td>
 265 </tr>
 266 <tr>
 267 <td><p><span class="term"><em class="parameter"><code>provide</code></em> :</span></p></td>
 268 <td>new state</td>
 269 </tr>
 270 </tbody>
 271 </table></div>
 272 <p class="since">Since 0.10.16</p>
 273 </div>
 274 <hr>
 275 <div class="refsect2">
 276 <a name="gst-base-audio-sink-get-provide-clock"></a><h3>gst_base_audio_sink_get_provide_clock ()</h3>
 277 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_base_audio_sink_get_provide_clock
 278                                                         (<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>
 279 <p>
 280 Queries whether <em class="parameter"><code>sink</code></em> will provide a clock or not. See also
 281 gst_base_audio_sink_set_provide_clock.
 282 </p>
 283 <div class="variablelist"><table border="0">
 284 <col align="left" valign="top">
 285 <tbody>
 286 <tr>
 287 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
 288 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
 289 </td>
 290 </tr>
 291 <tr>
 292 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 293 <td>
 294 <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>
 295 </tr>
 296 </tbody>
 297 </table></div>
 298 <p class="since">Since 0.10.16</p>
 299 </div>
 300 <hr>
 301 <div class="refsect2">
 302 <a name="gst-base-audio-sink-set-slave-method"></a><h3>gst_base_audio_sink_set_slave_method ()</h3>
 303 <pre class="programlisting"><span class="returnvalue">void</span>                gst_base_audio_sink_set_slave_method
 304                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>,
 305                                                          <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>
 306 <p>
 307 Controls how clock slaving will be performed in <em class="parameter"><code>sink</code></em>.
 308 </p>
 309 <div class="variablelist"><table border="0">
 310 <col align="left" valign="top">
 311 <tbody>
 312 <tr>
 313 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
 314 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
 315 </td>
 316 </tr>
 317 <tr>
 318 <td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
 319 <td>the new slave method</td>
 320 </tr>
 321 </tbody>
 322 </table></div>
 323 <p class="since">Since 0.10.16</p>
 324 </div>
 325 <hr>
 326 <div class="refsect2">
 327 <a name="gst-base-audio-sink-get-slave-method"></a><h3>gst_base_audio_sink_get_slave_method ()</h3>
 328 <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
 329                                                         (<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>
 330 <p>
 331 Get the current slave method used by <em class="parameter"><code>sink</code></em>.
 332 </p>
 333 <div class="variablelist"><table border="0">
 334 <col align="left" valign="top">
 335 <tbody>
 336 <tr>
 337 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
 338 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
 339 </td>
 340 </tr>
 341 <tr>
 342 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 343 <td>The current slave method used by <em class="parameter"><code>sink</code></em>.</td>
 344 </tr>
 345 </tbody>
 346 </table></div>
 347 <p class="since">Since 0.10.16</p>
 348 </div>
 349 <hr>
 350 <div class="refsect2">
 351 <a name="gst-base-audio-sink-get-drift-tolerance"></a><h3>gst_base_audio_sink_get_drift_tolerance ()</h3>
 352 <pre class="programlisting"><span class="returnvalue">gint64</span>              gst_base_audio_sink_get_drift_tolerance
 353                                                         (<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>
 354 <p>
 355 Get the current drift tolerance, in microseconds, used by <em class="parameter"><code>sink</code></em>.
 356 </p>
 357 <div class="variablelist"><table border="0">
 358 <col align="left" valign="top">
 359 <tbody>
 360 <tr>
 361 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
 362 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
 363 </td>
 364 </tr>
 365 <tr>
 366 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 367 <td>The current drift tolerance used by <em class="parameter"><code>sink</code></em>.</td>
 368 </tr>
 369 </tbody>
 370 </table></div>
 371 <p class="since">Since 0.10.31</p>
 372 </div>
 373 <hr>
 374 <div class="refsect2">
 375 <a name="gst-base-audio-sink-set-drift-tolerance"></a><h3>gst_base_audio_sink_set_drift_tolerance ()</h3>
 376 <pre class="programlisting"><span class="returnvalue">void</span>                gst_base_audio_sink_set_drift_tolerance
 377                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a> *sink</code></em>,
 378                                                          <em class="parameter"><code><span class="type">gint64</span> drift_tolerance</code></em>);</pre>
 379 <p>
 380 Controls the sink's drift tolerance.
 381 </p>
 382 <div class="variablelist"><table border="0">
 383 <col align="left" valign="top">
 384 <tbody>
 385 <tr>
 386 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
 387 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>
 388 </td>
 389 </tr>
 390 <tr>
 391 <td><p><span class="term"><em class="parameter"><code>drift_tolerance</code></em> :</span></p></td>
 392 <td>the new drift tolerance in microseconds</td>
 393 </tr>
 394 </tbody>
 395 </table></div>
 396 <p class="since">Since 0.10.31</p>
 397 </div>
 398 </div>
 399 <div class="refsect1">
 400 <a name="gst-plugins-base-libs-gstbaseaudiosink.property-details"></a><h2>Property Details</h2>
 401 <div class="refsect2">
 402 <a name="GstBaseAudioSink--alignment-threshold"></a><h3>The <code class="literal">"alignment-threshold"</code> property</h3>
 403 <pre class="programlisting">  "alignment-threshold"      <span class="type">guint64</span>               : Read / Write</pre>
 404 <p>Timestamp alignment threshold in nanoseconds.</p>
 405 <p>Allowed values: [1,18446744073709551614]</p>
 406 <p>Default value: 40000000</p>
 407 </div>
 408 <hr>
 409 <div class="refsect2">
 410 <a name="GstBaseAudioSink--buffer-time"></a><h3>The <code class="literal">"buffer-time"</code> property</h3>
 411 <pre class="programlisting">  "buffer-time"              <span class="type">gint64</span>                : Read / Write</pre>
 412 <p>Size of audio buffer in microseconds.</p>
 413 <p>Allowed values: &gt;= 1</p>
 414 <p>Default value: 200000</p>
 415 </div>
 416 <hr>
 417 <div class="refsect2">
 418 <a name="GstBaseAudioSink--can-activate-pull"></a><h3>The <code class="literal">"can-activate-pull"</code> property</h3>
 419 <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>
 420 <p>Allow pull-based scheduling.</p>
 421 <p>Default value: FALSE</p>
 422 </div>
 423 <hr>
 424 <div class="refsect2">
 425 <a name="GstBaseAudioSink--discont-wait"></a><h3>The <code class="literal">"discont-wait"</code> property</h3>
 426 <pre class="programlisting">  "discont-wait"             <span class="type">guint64</span>               : Read / Write</pre>
 427 <p>
 428 A window of time in nanoseconds to wait before creating a discontinuity as
 429 a result of breaching the drift-tolerance.
 430 </p>
 431 <p>Allowed values: &lt;= 18446744073709551614</p>
 432 <p>Default value: 1000000000</p>
 433 <p class="since">Since 0.10.36</p>
 434 </div>
 435 <hr>
 436 <div class="refsect2">
 437 <a name="GstBaseAudioSink--drift-tolerance"></a><h3>The <code class="literal">"drift-tolerance"</code> property</h3>
 438 <pre class="programlisting">  "drift-tolerance"          <span class="type">gint64</span>                : Read / Write</pre>
 439 <p>
 440 Controls the amount of time in microseconds that clocks are allowed
 441 to drift before resynchronisation happens.
 442 </p>
 443 <p>Allowed values: &gt;= 1</p>
 444 <p>Default value: 40000</p>
 445 <p class="since">Since 0.10.26</p>
 446 </div>
 447 <hr>
 448 <div class="refsect2">
 449 <a name="GstBaseAudioSink--latency-time"></a><h3>The <code class="literal">"latency-time"</code> property</h3>
 450 <pre class="programlisting">  "latency-time"             <span class="type">gint64</span>                : Read / Write</pre>
 451 <p>Audio latency in microseconds.</p>
 452 <p>Allowed values: &gt;= 1</p>
 453 <p>Default value: 10000</p>
 454 </div>
 455 <hr>
 456 <div class="refsect2">
 457 <a name="GstBaseAudioSink--provide-clock"></a><h3>The <code class="literal">"provide-clock"</code> property</h3>
 458 <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>
 459 <p>Provide a clock to be used as the global pipeline clock.</p>
 460 <p>Default value: TRUE</p>
 461 </div>
 462 <hr>
 463 <div class="refsect2">
 464 <a name="GstBaseAudioSink--slave-method"></a><h3>The <code class="literal">"slave-method"</code> property</h3>
 465 <pre class="programlisting">  "slave-method"             <a class="link" href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSinkSlaveMethod" title="enum GstBaseAudioSinkSlaveMethod"><span class="type">GstBaseAudioSinkSlaveMethod</span></a>  : Read / Write</pre>
 466 <p>Algorithm to use to match the rate of the masterclock.</p>
 467 <p>Default value: GST_BASE_AUDIO_SINK_SLAVE_SKEW</p>
 468 </div>
 469 </div>
 470 <div class="refsect1">
 471 <a name="gst-plugins-base-libs-gstbaseaudiosink.see-also"></a><h2>See Also</h2>
 472 <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-gstringbuffer.html#GstRingBuffer"><span class="type">GstRingBuffer</span></a>.
 473 </div>
 474 </div>
 475 <div class="footer">
 476 <hr>
 477           Generated by GTK-Doc V1.18</div>
 478 </body>
 479 </html>