Tizen 2.0 Release
[framework/multimedia/gst-plugins-good0.10.git] / 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.76.1">
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.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-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 <div class="refsynopsisdiv">
46 <h2>Synopsis</h2>
47 <div class="refsect2">
48 <a name="idp23647856"></a><h3>Element Information</h3>
49 <div class="variablelist"><table border="0">
50 <col align="left" valign="top">
51 <tbody>
52 <tr>
53 <td><p><span class="term">plugin</span></p></td>
54 <td>
55             <a class="link" href="gst-plugins-good-plugins-plugin-waveform.html#plugin-waveform">waveform</a>
56           </td>
57 </tr>
58 <tr>
59 <td><p><span class="term">author</span></p></td>
60 <td>Sebastien Moutte &lt;sebastien@moutte.net&gt;</td>
61 </tr>
62 <tr>
63 <td><p><span class="term">class</span></p></td>
64 <td>Sink/Audio</td>
65 </tr>
66 </tbody>
67 </table></div>
68 </div>
69 <hr>
70 <div class="refsect2">
71 <a name="idp24354896"></a><h3>Element Pads</h3>
72 </div>
73 </div>
74 <p>
75 </p>
76 </div>
77 <div class="refsect1">
78 <a name="gst-plugins-good-plugins-waveformsink.details"></a><h2>Details</h2>
79 <div class="refsect2">
80 <a name="GstWaveFormSink"></a><h3>struct GstWaveFormSink</h3>
81 <pre class="programlisting">struct GstWaveFormSink {
82   /* parent object */
83   GstAudioSink sink;
84
85   /* supported caps */
86   GstCaps *cached_caps;
87   
88   /* handle to the waveform-audio output device */
89   HWAVEOUT hwaveout;
90   
91   /* table of buffer headers */
92   WAVEHDR *wave_buffers;
93
94   /* critical section protecting access to the number of free buffers */
95   CRITICAL_SECTION critic_wave;
96
97   /* number of free buffers available */
98   guint free_buffers_count;
99   
100   /* current free buffer where you have to write incoming data */
101   guint write_buffer;
102   
103   /* size of buffers streamed to the device */
104   guint buffer_size;
105
106   /* number of buffers streamed to the device */
107   guint buffer_count;
108
109   /* total of bytes in queue before they are written to the device */
110   guint bytes_in_queue;
111
112   /* bytes per sample from setcaps used to evaluate the number samples returned by delay */
113   guint bytes_per_sample;
114
115   /* wave form error string */
116   gchar error_string[ERROR_LENGTH];
117 };
118 </pre>
119 <p>
120 </p>
121 </div>
122 </div>
123 </div>
124 <div class="footer">
125 <hr>
126           Generated by GTK-Doc V1.18</div>
127 </body>
128 </html>