docs/libs/html/gst-plugins-base-libs-gstbaseaudiosrc.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>gstbaseaudiosrc</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-gstbaseaudiosink.html" title="gstbaseaudiosink">
  10 <link rel="next" href="gst-plugins-base-libs-gstmultichannel.html" title="gstmultichannel">
  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-gstbaseaudiosink.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-gstmultichannel.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-gstbaseaudiosrc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gstbaseaudiosrc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-libs-gstbaseaudiosrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-libs-gstbaseaudiosrc.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-base-libs-gstbaseaudiosrc"></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-gstbaseaudiosrc.top_of_page"></a>gstbaseaudiosrc</span></h2>
  38 <p>gstbaseaudiosrc — Base class for audio sources</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-gstbaseaudiosrc.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstBaseAudioSrc"></a><pre class="synopsis">
  45 #include &lt;gst/audio/gstbaseaudiosrc.h&gt;
  46
  47 struct              <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc-struct" title="struct GstBaseAudioSrc">GstBaseAudioSrc</a>;
  48 struct              <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrcClass" title="struct GstBaseAudioSrcClass">GstBaseAudioSrcClass</a>;
  49 enum                <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrcSlaveMethod" title="enum GstBaseAudioSrcSlaveMethod">GstBaseAudioSrcSlaveMethod</a>;
  50 #define             <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GST-BASE-AUDIO-SRC-CLOCK:CAPS" title="GST_BASE_AUDIO_SRC_CLOCK()">GST_BASE_AUDIO_SRC_CLOCK</a>            (obj)
  51 #define             <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GST-BASE-AUDIO-SRC-PAD:CAPS" title="GST_BASE_AUDIO_SRC_PAD()">GST_BASE_AUDIO_SRC_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-gstbaseaudiosrc.html#gst-base-audio-src-create-ringbuffer" title="gst_base_audio_src_create_ringbuffer ()">gst_base_audio_src_create_ringbuffer</a>
  53                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a> *src</code></em>);
  54 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#gst-base-audio-src-set-provide-clock" title="gst_base_audio_src_set_provide_clock ()">gst_base_audio_src_set_provide_clock</a>
  55                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a> *src</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-gstbaseaudiosrc.html#gst-base-audio-src-get-provide-clock" title="gst_base_audio_src_get_provide_clock ()">gst_base_audio_src_get_provide_clock</a>
  58                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a> *src</code></em>);
  59 <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrcSlaveMethod" title="enum GstBaseAudioSrcSlaveMethod"><span class="returnvalue">GstBaseAudioSrcSlaveMethod</span></a> <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#gst-base-audio-src-get-slave-method" title="gst_base_audio_src_get_slave_method ()">gst_base_audio_src_get_slave_method</a>
  60                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a> *src</code></em>);
  61 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#gst-base-audio-src-set-slave-method" title="gst_base_audio_src_set_slave_method ()">gst_base_audio_src_set_slave_method</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a> *src</code></em>,
  62                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrcSlaveMethod" title="enum GstBaseAudioSrcSlaveMethod"><span class="type">GstBaseAudioSrcSlaveMethod</span></a> method</code></em>);
  63 </pre>
  64 </div>
  65 <div class="refsect1">
  66 <a name="gst-plugins-base-libs-gstbaseaudiosrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
  67 <pre class="synopsis">
  68   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  69    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  70          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  71                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html">GstBaseSrc</a>
  72                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
  73                            +----GstBaseAudioSrc
  74                                  +----<a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrc">GstAudioSrc</a>
  75 </pre>
  76 </div>
  77 <div class="refsect1">
  78 <a name="gst-plugins-base-libs-gstbaseaudiosrc.properties"></a><h2>Properties</h2>
  79 <pre class="synopsis">
  80   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc--actual-buffer-time" title='The "actual-buffer-time" property'>actual-buffer-time</a>"       <span class="type">gint64</span>                : Read
  81   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc--actual-latency-time" title='The "actual-latency-time" property'>actual-latency-time</a>"      <span class="type">gint64</span>                : Read
  82   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc--buffer-time" title='The "buffer-time" property'>buffer-time</a>"              <span class="type">gint64</span>                : Read / Write
  83   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc--latency-time" title='The "latency-time" property'>latency-time</a>"             <span class="type">gint64</span>                : Read / Write
  84   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc--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
  85   "<a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc--slave-method" title='The "slave-method" property'>slave-method</a>"             <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrcSlaveMethod" title="enum GstBaseAudioSrcSlaveMethod"><span class="type">GstBaseAudioSrcSlaveMethod</span></a>  : Read / Write
  86 </pre>
  87 </div>
  88 <div class="refsect1">
  89 <a name="gst-plugins-base-libs-gstbaseaudiosrc.description"></a><h2>Description</h2>
  90 <p>
  91 This is the base class for audio sources. Subclasses need to implement the
  92 ::create_ringbuffer vmethod. This base class will then take care of
  93 reading samples from the ringbuffer, synchronisation and flushing.
  94 </p>
  95 <p>
  96 Last reviewed on 2006-09-27 (0.10.12)
  97 </p>
  98 </div>
  99 <div class="refsect1">
 100 <a name="gst-plugins-base-libs-gstbaseaudiosrc.details"></a><h2>Details</h2>
 101 <div class="refsect2">
 102 <a name="GstBaseAudioSrc-struct"></a><h3>struct GstBaseAudioSrc</h3>
 103 <pre class="programlisting">struct GstBaseAudioSrc;</pre>
 104 <p>
 105 Opaque <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a>.
 106 </p>
 107 </div>
 108 <hr>
 109 <div class="refsect2">
 110 <a name="GstBaseAudioSrcClass"></a><h3>struct GstBaseAudioSrcClass</h3>
 111 <pre class="programlisting">struct GstBaseAudioSrcClass {
 112   GstPushSrcClass parent_class;
 113
 114   /* subclass ringbuffer allocation */
 115   GstRingBuffer* (*create_ringbuffer)  (GstBaseAudioSrc *src);
 116 };
 117 </pre>
 118 <p>
 119 <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a> class. Override the vmethod to implement
 120 functionality.
 121 </p>
 122 <div class="variablelist"><table border="0">
 123 <col align="left" valign="top">
 124 <tbody>
 125 <tr>
 126 <td><p><span class="term"><span class="type">GstPushSrcClass</span> <em class="structfield"><code><a name="GstBaseAudioSrcClass.parent-class"></a>parent_class</code></em>;</span></p></td>
 127 <td>the parent class.</td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term"><em class="structfield"><code><a name="GstBaseAudioSrcClass.create-ringbuffer"></a>create_ringbuffer</code></em> ()</span></p></td>
 131 <td>create and return a <a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBuffer"><span class="type">GstRingBuffer</span></a> to read from.</td>
 132 </tr>
 133 </tbody>
 134 </table></div>
 135 </div>
 136 <hr>
 137 <div class="refsect2">
 138 <a name="GstBaseAudioSrcSlaveMethod"></a><h3>enum GstBaseAudioSrcSlaveMethod</h3>
 139 <pre class="programlisting">typedef enum {
 140   GST_BASE_AUDIO_SRC_SLAVE_RESAMPLE,
 141   GST_BASE_AUDIO_SRC_SLAVE_RETIMESTAMP,
 142   GST_BASE_AUDIO_SRC_SLAVE_SKEW,
 143   GST_BASE_AUDIO_SRC_SLAVE_NONE
 144 } GstBaseAudioSrcSlaveMethod;
 145 </pre>
 146 <p>
 147 Different possible clock slaving algorithms when the internal audio clock was
 148 not selected as the pipeline clock.
 149 </p>
 150 <div class="variablelist"><table border="0">
 151 <col align="left" valign="top">
 152 <tbody>
 153 <tr>
 154 <td><p><a name="GST-BASE-AUDIO-SRC-SLAVE-RESAMPLE:CAPS"></a><span class="term"><code class="literal">GST_BASE_AUDIO_SRC_SLAVE_RESAMPLE</code></span></p></td>
 155 <td>Resample to match the master clock.
 156 </td>
 157 </tr>
 158 <tr>
 159 <td><p><a name="GST-BASE-AUDIO-SRC-SLAVE-RETIMESTAMP:CAPS"></a><span class="term"><code class="literal">GST_BASE_AUDIO_SRC_SLAVE_RETIMESTAMP</code></span></p></td>
 160 <td>Retimestamp output buffers with master
 161 clock time.
 162 </td>
 163 </tr>
 164 <tr>
 165 <td><p><a name="GST-BASE-AUDIO-SRC-SLAVE-SKEW:CAPS"></a><span class="term"><code class="literal">GST_BASE_AUDIO_SRC_SLAVE_SKEW</code></span></p></td>
 166 <td>Adjust capture pointer when master clock
 167 drifts too much.
 168 </td>
 169 </tr>
 170 <tr>
 171 <td><p><a name="GST-BASE-AUDIO-SRC-SLAVE-NONE:CAPS"></a><span class="term"><code class="literal">GST_BASE_AUDIO_SRC_SLAVE_NONE</code></span></p></td>
 172 <td>No adjustment is done.
 173 </td>
 174 </tr>
 175 </tbody>
 176 </table></div>
 177 </div>
 178 <hr>
 179 <div class="refsect2">
 180 <a name="GST-BASE-AUDIO-SRC-CLOCK:CAPS"></a><h3>GST_BASE_AUDIO_SRC_CLOCK()</h3>
 181 <pre class="programlisting">#define GST_BASE_AUDIO_SRC_CLOCK(obj)    (GST_BASE_AUDIO_SRC (obj)-&gt;clock)
 182 </pre>
 183 <p>
 184 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>.
 185 </p>
 186 <div class="variablelist"><table border="0">
 187 <col align="left" valign="top">
 188 <tbody><tr>
 189 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 190 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a>
 191 </td>
 192 </tr></tbody>
 193 </table></div>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="GST-BASE-AUDIO-SRC-PAD:CAPS"></a><h3>GST_BASE_AUDIO_SRC_PAD()</h3>
 198 <pre class="programlisting">#define GST_BASE_AUDIO_SRC_PAD(obj)      (GST_BASE_SRC (obj)-&gt;srcpad)
 199 </pre>
 200 <p>
 201 Get the source <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>.
 202 </p>
 203 <div class="variablelist"><table border="0">
 204 <col align="left" valign="top">
 205 <tbody><tr>
 206 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 207 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a>
 208 </td>
 209 </tr></tbody>
 210 </table></div>
 211 </div>
 212 <hr>
 213 <div class="refsect2">
 214 <a name="gst-base-audio-src-create-ringbuffer"></a><h3>gst_base_audio_src_create_ringbuffer ()</h3>
 215 <pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBuffer"><span class="returnvalue">GstRingBuffer</span></a> *     gst_base_audio_src_create_ringbuffer
 216                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a> *src</code></em>);</pre>
 217 <p>
 218 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>src</code></em>. This function will call the
 219 ::create_ringbuffer vmethod and will set <em class="parameter"><code>src</code></em> as the parent of the returned
 220 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>).
 221 </p>
 222 <div class="variablelist"><table border="0">
 223 <col align="left" valign="top">
 224 <tbody>
 225 <tr>
 226 <td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
 227 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a>.</td>
 228 </tr>
 229 <tr>
 230 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 231 <td>The new ringbuffer of <em class="parameter"><code>src</code></em>.</td>
 232 </tr>
 233 </tbody>
 234 </table></div>
 235 </div>
 236 <hr>
 237 <div class="refsect2">
 238 <a name="gst-base-audio-src-set-provide-clock"></a><h3>gst_base_audio_src_set_provide_clock ()</h3>
 239 <pre class="programlisting"><span class="returnvalue">void</span>                gst_base_audio_src_set_provide_clock
 240                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a> *src</code></em>,
 241                                                          <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>
 242 <p>
 243 Controls whether <em class="parameter"><code>src</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>,
 244 <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
 245 of <em class="parameter"><code>src</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.
 246 </p>
 247 <div class="variablelist"><table border="0">
 248 <col align="left" valign="top">
 249 <tbody>
 250 <tr>
 251 <td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
 252 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a>
 253 </td>
 254 </tr>
 255 <tr>
 256 <td><p><span class="term"><em class="parameter"><code>provide</code></em> :</span></p></td>
 257 <td>new state</td>
 258 </tr>
 259 </tbody>
 260 </table></div>
 261 <p class="since">Since 0.10.16</p>
 262 </div>
 263 <hr>
 264 <div class="refsect2">
 265 <a name="gst-base-audio-src-get-provide-clock"></a><h3>gst_base_audio_src_get_provide_clock ()</h3>
 266 <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_src_get_provide_clock
 267                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a> *src</code></em>);</pre>
 268 <p>
 269 Queries whether <em class="parameter"><code>src</code></em> will provide a clock or not. See also
 270 gst_base_audio_src_set_provide_clock.
 271 </p>
 272 <div class="variablelist"><table border="0">
 273 <col align="left" valign="top">
 274 <tbody>
 275 <tr>
 276 <td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
 277 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a>
 278 </td>
 279 </tr>
 280 <tr>
 281 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 282 <td>
 283 <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>src</code></em> will provide a clock.</td>
 284 </tr>
 285 </tbody>
 286 </table></div>
 287 <p class="since">Since 0.10.16</p>
 288 </div>
 289 <hr>
 290 <div class="refsect2">
 291 <a name="gst-base-audio-src-get-slave-method"></a><h3>gst_base_audio_src_get_slave_method ()</h3>
 292 <pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrcSlaveMethod" title="enum GstBaseAudioSrcSlaveMethod"><span class="returnvalue">GstBaseAudioSrcSlaveMethod</span></a> gst_base_audio_src_get_slave_method
 293                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a> *src</code></em>);</pre>
 294 <p>
 295 Get the current slave method used by <em class="parameter"><code>src</code></em>.
 296 </p>
 297 <div class="variablelist"><table border="0">
 298 <col align="left" valign="top">
 299 <tbody>
 300 <tr>
 301 <td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
 302 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a>
 303 </td>
 304 </tr>
 305 <tr>
 306 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 307 <td>The current slave method used by <em class="parameter"><code>src</code></em>.</td>
 308 </tr>
 309 </tbody>
 310 </table></div>
 311 <p class="since">Since 0.10.20</p>
 312 </div>
 313 <hr>
 314 <div class="refsect2">
 315 <a name="gst-base-audio-src-set-slave-method"></a><h3>gst_base_audio_src_set_slave_method ()</h3>
 316 <pre class="programlisting"><span class="returnvalue">void</span>                gst_base_audio_src_set_slave_method (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a> *src</code></em>,
 317                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrcSlaveMethod" title="enum GstBaseAudioSrcSlaveMethod"><span class="type">GstBaseAudioSrcSlaveMethod</span></a> method</code></em>);</pre>
 318 <p>
 319 Controls how clock slaving will be performed in <em class="parameter"><code>src</code></em>.
 320 </p>
 321 <div class="variablelist"><table border="0">
 322 <col align="left" valign="top">
 323 <tbody>
 324 <tr>
 325 <td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
 326 <td>a <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a>
 327 </td>
 328 </tr>
 329 <tr>
 330 <td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
 331 <td>the new slave method</td>
 332 </tr>
 333 </tbody>
 334 </table></div>
 335 <p class="since">Since 0.10.20</p>
 336 </div>
 337 </div>
 338 <div class="refsect1">
 339 <a name="gst-plugins-base-libs-gstbaseaudiosrc.property-details"></a><h2>Property Details</h2>
 340 <div class="refsect2">
 341 <a name="GstBaseAudioSrc--actual-buffer-time"></a><h3>The <code class="literal">"actual-buffer-time"</code> property</h3>
 342 <pre class="programlisting">  "actual-buffer-time"       <span class="type">gint64</span>                : Read</pre>
 343 <p>
 344 Actual configured size of audio buffer in microseconds.
 345 </p>
 346 <p>Allowed values: &gt;= -1</p>
 347 <p>Default value: -1</p>
 348 <p class="since">Since 0.10.20</p>
 349 </div>
 350 <hr>
 351 <div class="refsect2">
 352 <a name="GstBaseAudioSrc--actual-latency-time"></a><h3>The <code class="literal">"actual-latency-time"</code> property</h3>
 353 <pre class="programlisting">  "actual-latency-time"      <span class="type">gint64</span>                : Read</pre>
 354 <p>
 355 Actual configured audio latency in microseconds.
 356 </p>
 357 <p>Allowed values: &gt;= -1</p>
 358 <p>Default value: -1</p>
 359 <p class="since">Since 0.10.20</p>
 360 </div>
 361 <hr>
 362 <div class="refsect2">
 363 <a name="GstBaseAudioSrc--buffer-time"></a><h3>The <code class="literal">"buffer-time"</code> property</h3>
 364 <pre class="programlisting">  "buffer-time"              <span class="type">gint64</span>                : Read / Write</pre>
 365 <p>Size of audio buffer in microseconds.</p>
 366 <p>Allowed values: &gt;= 1</p>
 367 <p>Default value: 200000</p>
 368 </div>
 369 <hr>
 370 <div class="refsect2">
 371 <a name="GstBaseAudioSrc--latency-time"></a><h3>The <code class="literal">"latency-time"</code> property</h3>
 372 <pre class="programlisting">  "latency-time"             <span class="type">gint64</span>                : Read / Write</pre>
 373 <p>Audio latency in microseconds.</p>
 374 <p>Allowed values: &gt;= 1</p>
 375 <p>Default value: 10000</p>
 376 </div>
 377 <hr>
 378 <div class="refsect2">
 379 <a name="GstBaseAudioSrc--provide-clock"></a><h3>The <code class="literal">"provide-clock"</code> property</h3>
 380 <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>
 381 <p>Provide a clock to be used as the global pipeline clock.</p>
 382 <p>Default value: TRUE</p>
 383 </div>
 384 <hr>
 385 <div class="refsect2">
 386 <a name="GstBaseAudioSrc--slave-method"></a><h3>The <code class="literal">"slave-method"</code> property</h3>
 387 <pre class="programlisting">  "slave-method"             <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrcSlaveMethod" title="enum GstBaseAudioSrcSlaveMethod"><span class="type">GstBaseAudioSrcSlaveMethod</span></a>  : Read / Write</pre>
 388 <p>Algorithm to use to match the rate of the masterclock.</p>
 389 <p>Default value: GST_BASE_AUDIO_SRC_SLAVE_SKEW</p>
 390 </div>
 391 </div>
 392 <div class="refsect1">
 393 <a name="gst-plugins-base-libs-gstbaseaudiosrc.see-also"></a><h2>See Also</h2>
 394 <a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrc"><span class="type">GstAudioSrc</span></a>, <a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBuffer"><span class="type">GstRingBuffer</span></a>.
 395 </div>
 396 </div>
 397 <div class="footer">
 398 <hr>
 399           Generated by GTK-Doc V1.18</div>
 400 </body>
 401 </html>