aboutsummaryrefslogtreecommitdiff
path: root/docs/plugins/html/gst-plugins-good-plugins-wavpackenc.html
blob: 340e099f16f11864c10e09a8661839963e69eee0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>wavpackenc</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
<link rel="prev" href="gst-plugins-good-plugins-wavpackdec.html" title="wavpackdec">
<link rel="next" href="gst-plugins-good-plugins-wavpackparse.html" title="wavpackparse">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<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>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Good Plugins 1.0 Plugins Reference Manual</th>
<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>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-good-plugins-wavpackenc.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gst-plugins-good-plugins-wavpackenc.description" class="shortcut">Description</a>
                   | 
                  <a href="#gst-plugins-good-plugins-wavpackenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#gst-plugins-good-plugins-wavpackenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#gst-plugins-good-plugins-wavpackenc.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="gst-plugins-good-plugins-wavpackenc"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-wavpackenc.top_of_page"></a>wavpackenc</span></h2>
<p>wavpackenc — Encodes audio with the Wavpack lossless/lossy audio codec</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gst-plugins-good-plugins-wavpackenc.synopsis"></a><h2>Synopsis</h2>
<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>;
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-wavpackenc.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
         +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
               +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
                     +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstaudioencoder.html#GstAudioEncoder">GstAudioEncoder</a>
                           +----GstWavpackEnc
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-wavpackenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GstWavpackEnc implements
 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPreset.html">GstPreset</a>.</p>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-wavpackenc.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<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
  "<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
  "<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
  "<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
  "<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
  "<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
  "<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
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-wavpackenc.description"></a><h2>Description</h2>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="idp23547552"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
            <a class="link" href="gst-plugins-good-plugins-plugin-wavpack.html#plugin-wavpack">wavpack</a>
          </td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>Sebastian Dröge &lt;slomo@circular-chaos.org&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Codec/Encoder/Audio</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="idp26226528"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>audio/x-raw, format=(string)S32LE, layout=(string)interleaved, channels=(int)[ 1, 8 ], rate=(int)[ 6000, 192000 ]</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>src</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>audio/x-wavpack, depth=(int)[ 1, 32 ], channels=(int)[ 1, 8 ], rate=(int)[ 6000, 192000 ], framed=(boolean)true</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>wvcsrc</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>sometimes</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>audio/x-wavpack-correction, framed=(boolean)true</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-wavpackenc.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GstWavpackEnc-struct"></a><h3>struct GstWavpackEnc</h3>
<pre class="programlisting">struct GstWavpackEnc;</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-wavpackenc.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstWavpackEnc--bitrate"></a><h3>The <code class="literal">"bitrate"</code> property</h3>
<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>
<p>Try to encode with this average bitrate (bits/sec). This enables lossy encoding, values smaller than 24000 disable it again.</p>
<p>Allowed values: &lt;= 9600000</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstWavpackEnc--bits-per-sample"></a><h3>The <code class="literal">"bits-per-sample"</code> property</h3>
<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>
<p>Try to encode with this amount of bits per sample. This enables lossy encoding, values smaller than 2.0 disable it again.</p>
<p>Allowed values: [0,24]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstWavpackEnc--correction-mode"></a><h3>The <code class="literal">"correction-mode"</code> property</h3>
<pre class="programlisting">  "correction-mode"          <span class="type">GstWavpackEncCorrectionMode</span>  : Read / Write</pre>
<p>Use this mode for the correction stream. Only works in lossy mode!.</p>
<p>Default value: Create no correction file</p>
</div>
<hr>
<div class="refsect2">
<a name="GstWavpackEnc--extra-processing"></a><h3>The <code class="literal">"extra-processing"</code> property</h3>
<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>
<p>Use better but slower filters for better compression/quality.</p>
<p>Allowed values: &lt;= 6</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstWavpackEnc--joint-stereo-mode"></a><h3>The <code class="literal">"joint-stereo-mode"</code> property</h3>
<pre class="programlisting">  "joint-stereo-mode"        <span class="type">GstWavpackEncJSMode</span>   : Read / Write</pre>
<p>Use this joint-stereo mode.</p>
<p>Default value: auto</p>
</div>
<hr>
<div class="refsect2">
<a name="GstWavpackEnc--md5"></a><h3>The <code class="literal">"md5"</code> property</h3>
<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>
<p>Store MD5 hash of raw samples within the file.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GstWavpackEnc--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
<pre class="programlisting">  "mode"                     <span class="type">GstWavpackEncMode</span>     : Read / Write</pre>
<p>Speed versus compression tradeoff.</p>
<p>Default value: Normal Compression</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>