docs/libs/html/gst-plugins-base-libs-gstaudiosrc.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>gstaudiosrc</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   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-gstaudiosink.html" title="gstaudiosink">
  10 <link rel="next" href="gst-plugins-base-libs-gstbaseaudiosink.html" title="gstbaseaudiosink">
  11 <meta name="generator" content="GTK-Doc V1.17 (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-gstaudiosink.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-audio.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Library Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-libs-gstbaseaudiosink.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-base-libs-gstaudiosrc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gstaudiosrc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-libs-gstaudiosrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="gst-plugins-base-libs-gstaudiosrc"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstaudiosrc.top_of_page"></a>gstaudiosrc</span></h2>
  36 <p>gstaudiosrc — Simple base class for audio sources</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="gst-plugins-base-libs-gstaudiosrc.synopsis"></a><h2>Synopsis</h2>
  42 <a name="GstAudioSrc"></a><pre class="synopsis">
  43 #include &lt;gst/audio/gstaudiosrc.h&gt;
  44
  45 struct              <a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrc-struct" title="struct GstAudioSrc">GstAudioSrc</a>;
  46 struct              <a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrcClass" title="struct GstAudioSrcClass">GstAudioSrcClass</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-base-libs-gstaudiosrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  53    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  54          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  55                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html">GstBaseSrc</a>
  56                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
  57                            +----<a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc">GstBaseAudioSrc</a>
  58                                  +----GstAudioSrc
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gst-plugins-base-libs-gstaudiosrc.description"></a><h2>Description</h2>
  63 <p>
  64 This is the most simple base class for audio sources that only requires
  65 subclasses to implement a set of simple functions:
  66 </p>
  67 <p>
  68 </p>
  69 <div class="variablelist"><table border="0">
  70 <col align="left" valign="top">
  71 <tbody>
  72 <tr>
  73 <td><p><span class="term"><code class="function">open()</code></span></p></td>
  74 <td><p>Open the device.</p></td>
  75 </tr>
  76 <tr>
  77 <td><p><span class="term"><code class="function">prepare()</code></span></p></td>
  78 <td><p>Configure the device with the specified format.</p></td>
  79 </tr>
  80 <tr>
  81 <td><p><span class="term"><code class="function">read()</code></span></p></td>
  82 <td><p>Read samples from the device.</p></td>
  83 </tr>
  84 <tr>
  85 <td><p><span class="term"><code class="function">reset()</code></span></p></td>
  86 <td><p>Unblock reads and flush the device.</p></td>
  87 </tr>
  88 <tr>
  89 <td><p><span class="term"><code class="function">delay()</code></span></p></td>
  90 <td><p>Get the number of samples in the device but not yet read.
  91     </p></td>
  92 </tr>
  93 <tr>
  94 <td><p><span class="term"><code class="function">unprepare()</code></span></p></td>
  95 <td><p>Undo operations done by prepare.</p></td>
  96 </tr>
  97 <tr>
  98 <td><p><span class="term"><code class="function">close()</code></span></p></td>
  99 <td><p>Close the device.</p></td>
 100 </tr>
 101 </tbody>
 102 </table></div>
 103 <p>
 104 </p>
 105 <p>
 106 All scheduling of samples and timestamps is done in this base class
 107 together with <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a> using a default implementation of a
 108 <a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBuffer"><span class="type">GstRingBuffer</span></a> that uses threads.
 109 </p>
 110 <p>
 111 Last reviewed on 2006-09-27 (0.10.12)
 112 </p>
 113 </div>
 114 <div class="refsect1">
 115 <a name="gst-plugins-base-libs-gstaudiosrc.details"></a><h2>Details</h2>
 116 <div class="refsect2">
 117 <a name="GstAudioSrc-struct"></a><h3>struct GstAudioSrc</h3>
 118 <pre class="programlisting">struct GstAudioSrc;</pre>
 119 <p>
 120 Base class for simple audio sources.
 121 </p>
 122 <div class="variablelist"><table border="0">
 123 <col align="left" valign="top">
 124 <tbody></tbody>
 125 </table></div>
 126 </div>
 127 <hr>
 128 <div class="refsect2">
 129 <a name="GstAudioSrcClass"></a><h3>struct GstAudioSrcClass</h3>
 130 <pre class="programlisting">struct GstAudioSrcClass {
 131   GstBaseAudioSrcClass parent_class;
 132
 133   /* vtable */
 134
 135   /* open the device with given specs */
 136   gboolean (*open)      (GstAudioSrc *src);
 137   /* prepare resources and state to operate with the given specs */
 138   gboolean (*prepare)   (GstAudioSrc *src, GstRingBufferSpec *spec);
 139   /* undo anything that was done in prepare() */
 140   gboolean (*unprepare) (GstAudioSrc *src);
 141   /* close the device */
 142   gboolean (*close)     (GstAudioSrc *src);
 143   /* read samples from the device */
 144   guint    (*read)      (GstAudioSrc *src, gpointer data, guint length);
 145   /* get number of samples queued in the device */
 146   guint    (*delay)     (GstAudioSrc *src);
 147   /* reset the audio device, unblock from a write */
 148   void     (*reset)     (GstAudioSrc *src);
 149 };
 150 </pre>
 151 <p>
 152 <a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrc"><span class="type">GstAudioSrc</span></a> class. Override the vmethod to implement
 153 functionality.
 154 </p>
 155 <div class="variablelist"><table border="0">
 156 <col align="left" valign="top">
 157 <tbody>
 158 <tr>
 159 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrcClass" title="struct GstBaseAudioSrcClass"><span class="type">GstBaseAudioSrcClass</span></a> <em class="structfield"><code><a name="GstAudioSrcClass.parent-class"></a>parent_class</code></em>;</span></p></td>
 160 <td>the parent class.</td>
 161 </tr>
 162 <tr>
 163 <td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.open"></a>open</code></em> ()</span></p></td>
 164 <td>open the device with the specified caps</td>
 165 </tr>
 166 <tr>
 167 <td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.prepare"></a>prepare</code></em> ()</span></p></td>
 168 <td>configure device with format</td>
 169 </tr>
 170 <tr>
 171 <td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.unprepare"></a>unprepare</code></em> ()</span></p></td>
 172 <td>undo the configuration</td>
 173 </tr>
 174 <tr>
 175 <td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.close"></a>close</code></em> ()</span></p></td>
 176 <td>close the device</td>
 177 </tr>
 178 <tr>
 179 <td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.read"></a>read</code></em> ()</span></p></td>
 180 <td>read samples to the audio device</td>
 181 </tr>
 182 <tr>
 183 <td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.delay"></a>delay</code></em> ()</span></p></td>
 184 <td>the number of samples queued in the device</td>
 185 </tr>
 186 <tr>
 187 <td><p><span class="term"><em class="structfield"><code><a name="GstAudioSrcClass.reset"></a>reset</code></em> ()</span></p></td>
 188 <td>unblock a read to the device and reset.</td>
 189 </tr>
 190 </tbody>
 191 </table></div>
 192 </div>
 193 </div>
 194 <div class="refsect1">
 195 <a name="gst-plugins-base-libs-gstaudiosrc.see-also"></a><h2>See Also</h2>
 196 <a class="link" href="gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</span></a>, <a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBuffer"><span class="type">GstRingBuffer</span></a>, <a class="link" href="gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrc"><span class="type">GstAudioSrc</span></a>.
 197 </div>
 198 </div>
 199 <div class="footer">
 200 <hr>
 201           Generated by GTK-Doc V1.17</div>
 202 </body>
 203 </html>