docs/plugins/html/gst-plugins-good-plugins-waveformsink.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>waveformsink</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
   9 <link rel="prev" href="gst-plugins-good-plugins-wavenc.html" title="wavenc">
  10 <link rel="next" href="gst-plugins-good-plugins-wavpackdec.html" title="wavpackdec">
  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-good-plugins-wavenc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.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 Good Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-good-plugins-wavpackdec.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-good-plugins-waveformsink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-waveformsink.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gst-plugins-good-plugins-waveformsink"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-waveformsink.top_of_page"></a>waveformsink</span></h2>
  34 <p>waveformsink — WaveForm audio sink</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gst-plugins-good-plugins-waveformsink.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-waveformsink.html#GstWaveFormSink" title="struct GstWaveFormSink">GstWaveFormSink</a>;
  41 </pre>
  42 </div>
  43 <div class="refsect1">
  44 <a name="gst-plugins-good-plugins-waveformsink.description"></a><h2>Description</h2>
  45 <p>
  46 This element lets you output sound using the Windows WaveForm API.
  47 </p>
  48 <p>
  49 Note that you should almost always use generic audio conversion elements
  50 like audioconvert and audioresample in front of an audiosink to make sure
  51 your pipeline works under all circumstances (those conversion elements will
  52 act in passthrough-mode if no conversion is necessary).
  53 </p>
  54 <p>
  55 </p>
  56 <div class="refsect2">
  57 <a name="idp24035104"></a><h3>Example pipelines</h3>
  58 <div class="informalexample">
  59   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  60     <tbody>
  61       <tr>
  62         <td class="listing_lines" align="right"><pre>1</pre></td>
  63         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v audiotestsrc <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> volume volume<span class="gtkdoc opt">=</span><span class="number">0.1</span> <span class="gtkdoc opt">!</span> waveformsink</pre></td>
  64       </tr>
  65     </tbody>
  66   </table>
  67 </div>
  68  will output a sine wave (continuous beep sound) to your sound card (with
  69 a very low volume as precaution).
  70 <div class="informalexample">
  71   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  72     <tbody>
  73       <tr>
  74         <td class="listing_lines" align="right"><pre>1</pre></td>
  75         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v filesrc location<span class="gtkdoc opt">=</span>music<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audioresample <span class="gtkdoc opt">!</span> waveformsink</pre></td>
  76       </tr>
  77     </tbody>
  78   </table>
  79 </div>
  80  will play an Ogg/Vorbis audio file and output it.
  81 </div>
  82 <p>
  83 </p>
  84 <div class="refsynopsisdiv">
  85 <h2>Synopsis</h2>
  86 <div class="refsect2">
  87 <a name="idp22850832"></a><h3>Element Information</h3>
  88 <div class="variablelist"><table border="0">
  89 <col align="left" valign="top">
  90 <tbody>
  91 <tr>
  92 <td><p><span class="term">plugin</span></p></td>
  93 <td>
  94             <a class="link" href="gst-plugins-good-plugins-plugin-waveform.html#plugin-waveform">waveform</a>
  95           </td>
  96 </tr>
  97 <tr>
  98 <td><p><span class="term">author</span></p></td>
  99 <td>Sebastien Moutte &lt;sebastien@moutte.net&gt;</td>
 100 </tr>
 101 <tr>
 102 <td><p><span class="term">class</span></p></td>
 103 <td>Sink/Audio</td>
 104 </tr>
 105 </tbody>
 106 </table></div>
 107 </div>
 108 <hr>
 109 <div class="refsect2">
 110 <a name="idp21046080"></a><h3>Element Pads</h3>
 111 </div>
 112 </div>
 113 <p>
 114 </p>
 115 </div>
 116 <div class="refsect1">
 117 <a name="gst-plugins-good-plugins-waveformsink.details"></a><h2>Details</h2>
 118 <div class="refsect2">
 119 <a name="GstWaveFormSink"></a><h3>struct GstWaveFormSink</h3>
 120 <pre class="programlisting">struct GstWaveFormSink {
 121   /* parent object */
 122   GstAudioSink sink;
 123
 124   /* supported caps */
 125   GstCaps *cached_caps;
 126
 127   /* handle to the waveform-audio output device */
 128   HWAVEOUT hwaveout;
 129
 130   /* table of buffer headers */
 131   WAVEHDR *wave_buffers;
 132
 133   /* critical section protecting access to the number of free buffers */
 134   CRITICAL_SECTION critic_wave;
 135
 136   /* number of free buffers available */
 137   guint free_buffers_count;
 138
 139   /* current free buffer where you have to write incoming data */
 140   guint write_buffer;
 141
 142   /* size of buffers streamed to the device */
 143   guint buffer_size;
 144
 145   /* number of buffers streamed to the device */
 146   guint buffer_count;
 147
 148   /* total of bytes in queue before they are written to the device */
 149   guint bytes_in_queue;
 150
 151   /* bytes per sample from setcaps used to evaluate the number samples returned by delay */
 152   guint bytes_per_sample;
 153
 154   /* wave form error string */
 155   gchar error_string[ERROR_LENGTH];
 156 };
 157 </pre>
 158 <p>
 159 </p>
 160 </div>
 161 </div>
 162 </div>
 163 <div class="footer">
 164 <hr>
 165           Generated by GTK-Doc V1.17</div>
 166 </body>
 167 </html>