Tizen 2.0 Release
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-wavpackenc.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>wavpackenc</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-wavpackdec.html" title="wavpackdec">
10 <link rel="next" href="gst-plugins-good-plugins-wavpackparse.html" title="wavpackparse">
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-wavpackdec.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-wavpackparse.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-wavpackenc.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-wavpackenc.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-wavpackenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-wavpackenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31                    | 
32                   <a href="#gst-plugins-good-plugins-wavpackenc.properties" class="shortcut">Properties</a>
33 </td></tr>
34 </table>
35 <div class="refentry">
36 <a name="gst-plugins-good-plugins-wavpackenc"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
38 <td valign="top">
39 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-wavpackenc.top_of_page"></a>wavpackenc</span></h2>
40 <p>wavpackenc — Encodes audio with the Wavpack lossless/lossy audio codec</p>
41 </td>
42 <td valign="top" align="right"></td>
43 </tr></table></div>
44 <div class="refsynopsisdiv">
45 <a name="gst-plugins-good-plugins-wavpackenc.synopsis"></a><h2>Synopsis</h2>
46 <a name="GstWavpackEnc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc-struct" title="struct GstWavpackEnc">GstWavpackEnc</a>;
47 </pre>
48 </div>
49 <div class="refsect1">
50 <a name="gst-plugins-good-plugins-wavpackenc.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                +----GstWavpackEnc
56 </pre>
57 </div>
58 <div class="refsect1">
59 <a name="gst-plugins-good-plugins-wavpackenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
60 <p>
61 GstWavpackEnc implements
62  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPreset.html">GstPreset</a>.</p>
63 </div>
64 <div class="refsect1">
65 <a name="gst-plugins-good-plugins-wavpackenc.properties"></a><h2>Properties</h2>
66 <pre class="synopsis">
67   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--bitrate" title='The "bitrate" property'>bitrate</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
68   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--bits-per-sample" title='The "bits-per-sample" property'>bits-per-sample</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
69   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--correction-mode" title='The "correction-mode" property'>correction-mode</a>"          <span class="type">GstWavpackEncCorrectionMode</span>  : Read / Write
70   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--extra-processing" title='The "extra-processing" property'>extra-processing</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
71   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--joint-stereo-mode" title='The "joint-stereo-mode" property'>joint-stereo-mode</a>"        <span class="type">GstWavpackEncJSMode</span>   : Read / Write
72   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--md5" title='The "md5" property'>md5</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
73   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--mode" title='The "mode" property'>mode</a>"                     <span class="type">GstWavpackEncMode</span>     : Read / Write
74 </pre>
75 </div>
76 <div class="refsect1">
77 <a name="gst-plugins-good-plugins-wavpackenc.description"></a><h2>Description</h2>
78 <div class="refsynopsisdiv">
79 <h2>Synopsis</h2>
80 <div class="refsect2">
81 <a name="idp23247120"></a><h3>Element Information</h3>
82 <div class="variablelist"><table border="0">
83 <col align="left" valign="top">
84 <tbody>
85 <tr>
86 <td><p><span class="term">plugin</span></p></td>
87 <td>
88             <a class="link" href="gst-plugins-good-plugins-plugin-wavpack.html#plugin-wavpack">wavpack</a>
89           </td>
90 </tr>
91 <tr>
92 <td><p><span class="term">author</span></p></td>
93 <td>Sebastian Dröge &lt;slomo@circular-chaos.org&gt;</td>
94 </tr>
95 <tr>
96 <td><p><span class="term">class</span></p></td>
97 <td>Codec/Encoder/Audio</td>
98 </tr>
99 </tbody>
100 </table></div>
101 </div>
102 <hr>
103 <div class="refsect2">
104 <a name="idp23493184"></a><h3>Element Pads</h3>
105 <div class="variablelist"><table border="0">
106 <col align="left" valign="top">
107 <tbody>
108 <tr>
109 <td><p><span class="term">name</span></p></td>
110 <td>sink</td>
111 </tr>
112 <tr>
113 <td><p><span class="term">direction</span></p></td>
114 <td>sink</td>
115 </tr>
116 <tr>
117 <td><p><span class="term">presence</span></p></td>
118 <td>always</td>
119 </tr>
120 <tr>
121 <td><p><span class="term">details</span></p></td>
122 <td>audio/x-raw-int, width=(int)32, depth=(int)[ 1, 32 ], endianness=(int)1234, channels=(int)[ 1, 8 ], rate=(int)[ 6000, 192000 ], signed=(boolean)true</td>
123 </tr>
124 </tbody>
125 </table></div>
126 <div class="variablelist"><table border="0">
127 <col align="left" valign="top">
128 <tbody>
129 <tr>
130 <td><p><span class="term">name</span></p></td>
131 <td>src</td>
132 </tr>
133 <tr>
134 <td><p><span class="term">direction</span></p></td>
135 <td>source</td>
136 </tr>
137 <tr>
138 <td><p><span class="term">presence</span></p></td>
139 <td>always</td>
140 </tr>
141 <tr>
142 <td><p><span class="term">details</span></p></td>
143 <td>audio/x-wavpack, width=(int)[ 1, 32 ], channels=(int)[ 1, 2 ], rate=(int)[ 6000, 192000 ], framed=(boolean)true</td>
144 </tr>
145 </tbody>
146 </table></div>
147 <div class="variablelist"><table border="0">
148 <col align="left" valign="top">
149 <tbody>
150 <tr>
151 <td><p><span class="term">name</span></p></td>
152 <td>wvcsrc</td>
153 </tr>
154 <tr>
155 <td><p><span class="term">direction</span></p></td>
156 <td>source</td>
157 </tr>
158 <tr>
159 <td><p><span class="term">presence</span></p></td>
160 <td>sometimes</td>
161 </tr>
162 <tr>
163 <td><p><span class="term">details</span></p></td>
164 <td>audio/x-wavpack-correction, framed=(boolean)true</td>
165 </tr>
166 </tbody>
167 </table></div>
168 </div>
169 </div>
170 <p>
171 </p>
172 </div>
173 <div class="refsect1">
174 <a name="gst-plugins-good-plugins-wavpackenc.details"></a><h2>Details</h2>
175 <div class="refsect2">
176 <a name="GstWavpackEnc-struct"></a><h3>struct GstWavpackEnc</h3>
177 <pre class="programlisting">struct GstWavpackEnc;</pre>
178 <p>
179 </p>
180 </div>
181 </div>
182 <div class="refsect1">
183 <a name="gst-plugins-good-plugins-wavpackenc.property-details"></a><h2>Property Details</h2>
184 <div class="refsect2">
185 <a name="GstWavpackEnc--bitrate"></a><h3>The <code class="literal">"bitrate"</code> property</h3>
186 <pre class="programlisting">  "bitrate"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
187 <p>Try to encode with this average bitrate (bits/sec). This enables lossy encoding, values smaller than 24000 disable it again.</p>
188 <p>Allowed values: &lt;= 9600000</p>
189 <p>Default value: 0</p>
190 </div>
191 <hr>
192 <div class="refsect2">
193 <a name="GstWavpackEnc--bits-per-sample"></a><h3>The <code class="literal">"bits-per-sample"</code> property</h3>
194 <pre class="programlisting">  "bits-per-sample"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
195 <p>Try to encode with this amount of bits per sample. This enables lossy encoding, values smaller than 2.0 disable it again.</p>
196 <p>Allowed values: [0,24]</p>
197 <p>Default value: 0</p>
198 </div>
199 <hr>
200 <div class="refsect2">
201 <a name="GstWavpackEnc--correction-mode"></a><h3>The <code class="literal">"correction-mode"</code> property</h3>
202 <pre class="programlisting">  "correction-mode"          <span class="type">GstWavpackEncCorrectionMode</span>  : Read / Write</pre>
203 <p>Use this mode for the correction stream. Only works in lossy mode!.</p>
204 <p>Default value: Create no correction file</p>
205 </div>
206 <hr>
207 <div class="refsect2">
208 <a name="GstWavpackEnc--extra-processing"></a><h3>The <code class="literal">"extra-processing"</code> property</h3>
209 <pre class="programlisting">  "extra-processing"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
210 <p>Use better but slower filters for better compression/quality.</p>
211 <p>Allowed values: &lt;= 6</p>
212 <p>Default value: 0</p>
213 </div>
214 <hr>
215 <div class="refsect2">
216 <a name="GstWavpackEnc--joint-stereo-mode"></a><h3>The <code class="literal">"joint-stereo-mode"</code> property</h3>
217 <pre class="programlisting">  "joint-stereo-mode"        <span class="type">GstWavpackEncJSMode</span>   : Read / Write</pre>
218 <p>Use this joint-stereo mode.</p>
219 <p>Default value: auto</p>
220 </div>
221 <hr>
222 <div class="refsect2">
223 <a name="GstWavpackEnc--md5"></a><h3>The <code class="literal">"md5"</code> property</h3>
224 <pre class="programlisting">  "md5"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
225 <p>Store MD5 hash of raw samples within the file.</p>
226 <p>Default value: FALSE</p>
227 </div>
228 <hr>
229 <div class="refsect2">
230 <a name="GstWavpackEnc--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
231 <pre class="programlisting">  "mode"                     <span class="type">GstWavpackEncMode</span>     : Read / Write</pre>
232 <p>Speed versus compression tradeoff.</p>
233 <p>Default value: Normal Compression</p>
234 </div>
235 </div>
236 </div>
237 <div class="footer">
238 <hr>
239           Generated by GTK-Doc V1.18</div>
240 </body>
241 </html>