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>speexenc: GStreamer Good Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-good Elements"> 9<link rel="prev" href="gst-plugins-good-plugins-speexdec.html" title="speexdec"> 10<link rel="next" href="gst-plugins-good-plugins-splitfilesrc.html" title="splitfilesrc"> 11<meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-good-plugins-speexenc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-good-plugins-speexenc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-good-plugins-speexenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-good-plugins-speexenc.properties" class="shortcut">Properties</a></span> 22</td> 23<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 24<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 25<td><a accesskey="p" href="gst-plugins-good-plugins-speexdec.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-good-plugins-splitfilesrc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 27</tr></table> 28<div class="refentry"> 29<a name="gst-plugins-good-plugins-speexenc"></a><div class="titlepage"></div> 30<div class="refnamediv"><table width="100%"><tr> 31<td valign="top"> 32<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-speexenc.top_of_page"></a>speexenc</span></h2> 33<p>speexenc</p> 34</td> 35<td class="gallery_image" valign="top" align="right"></td> 36</tr></table></div> 37<div class="refsect1"> 38<a name="gst-plugins-good-plugins-speexenc.properties"></a><h2>Properties</h2> 39<div class="informaltable"><table class="informaltable" border="0"> 40<colgroup> 41<col width="150px" class="properties_type"> 42<col width="300px" class="properties_name"> 43<col width="200px" class="properties_flags"> 44</colgroup> 45<tbody> 46<tr> 47<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 48<td class="property_name"><a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--abr" title="The “abr” property">abr</a></td> 49<td class="property_flags">Read / Write / Construct</td> 50</tr> 51<tr> 52<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 53<td class="property_name"><a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--bitrate" title="The “bitrate” property">bitrate</a></td> 54<td class="property_flags">Read / Write / Construct</td> 55</tr> 56<tr> 57<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 58<td class="property_name"><a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--complexity" title="The “complexity” property">complexity</a></td> 59<td class="property_flags">Read / Write / Construct</td> 60</tr> 61<tr> 62<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 63<td class="property_name"><a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--dtx" title="The “dtx” property">dtx</a></td> 64<td class="property_flags">Read / Write / Construct</td> 65</tr> 66<tr> 67<td class="property_type"> 68<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 69<td class="property_name"><a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--last-message" title="The “last-message” property">last-message</a></td> 70<td class="property_flags">Read</td> 71</tr> 72<tr> 73<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 74<td class="property_name"><a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--nframes" title="The “nframes” property">nframes</a></td> 75<td class="property_flags">Read / Write / Construct</td> 76</tr> 77<tr> 78<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 79<td class="property_name"><a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--quality" title="The “quality” property">quality</a></td> 80<td class="property_flags">Read / Write / Construct</td> 81</tr> 82<tr> 83<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 84<td class="property_name"><a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--vad" title="The “vad” property">vad</a></td> 85<td class="property_flags">Read / Write / Construct</td> 86</tr> 87<tr> 88<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 89<td class="property_name"><a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--vbr" title="The “vbr” property">vbr</a></td> 90<td class="property_flags">Read / Write / Construct</td> 91</tr> 92<tr> 93<td class="property_type"><span class="type">GstSpeexEncMode</span></td> 94<td class="property_name"><a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--mode" title="The “mode” property">mode</a></td> 95<td class="property_flags">Read / Write / Construct</td> 96</tr> 97</tbody> 98</table></div> 99</div> 100<a name="GstSpeexEnc"></a><div class="refsect1"> 101<a name="gst-plugins-good-plugins-speexenc.other"></a><h2>Types and Values</h2> 102<div class="informaltable"><table class="informaltable" width="100%" border="0"> 103<colgroup> 104<col width="150px" class="name"> 105<col class="description"> 106</colgroup> 107<tbody><tr> 108<td class="datatype_keyword">struct</td> 109<td class="function_name"><a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc-struct" title="struct GstSpeexEnc">GstSpeexEnc</a></td> 110</tr></tbody> 111</table></div> 112</div> 113<div class="refsect1"> 114<a name="gst-plugins-good-plugins-speexenc.object-hierarchy"></a><h2>Object Hierarchy</h2> 115<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 116 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 117 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 118 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 119 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstAudioEncoder.html#GstAudioEncoder-struct">GstAudioEncoder</a> 120 <span class="lineart">╰──</span> GstSpeexEnc 121</pre> 122</div> 123<div class="refsect1"> 124<a name="gst-plugins-good-plugins-speexenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 125<p> 126GstSpeexEnc implements 127 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstTagSetter.html#GstTagSetter-struct">GstTagSetter</a> and <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPreset.html#GstPreset-struct">GstPreset</a>.</p> 128</div> 129<div class="refsect1"> 130<a name="gst-plugins-good-plugins-speexenc.description"></a><h2>Description</h2> 131<p>This element encodes audio as a Speex stream.</p> 132<a class="ulink" href="http://www.speex.org/" target="_top">Speex</a> is a royalty-free 133<p>audio codec maintained by the <a class="ulink" href="http://www.xiph.org/" target="_top">Xiph.org 134Foundation</a>.</p> 135<div class="refsect2"> 136<a name="id-1.2.251.8.5"></a><h3>Example pipelines</h3> 137<div class="informalexample"> 138 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 139 <tbody> 140 <tr> 141 <td class="listing_lines" align="right"><pre>1</pre></td> 142 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> audiotestsrc num<span class="gtkdoc opt">-</span>buffers<span class="gtkdoc opt">=</span><span class="number">100</span> <span class="gtkdoc opt">!</span> speexenc <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>beep<span class="gtkdoc opt">.</span>ogg</pre></td> 143 </tr> 144 </tbody> 145 </table> 146</div> 147 Encode an Ogg/Speex file. 148</div> 149<div class="refsynopsisdiv"> 150<h2>Synopsis</h2> 151<div class="refsect2"> 152<a name="id-1.2.251.8.6.1"></a><h3>Element Information</h3> 153<div class="variablelist"><table border="0" class="variablelist"> 154<colgroup> 155<col align="left" valign="top"> 156<col> 157</colgroup> 158<tbody> 159<tr> 160<td><p><span class="term">plugin</span></p></td> 161<td> 162 <a class="link" href="gst-plugins-good-plugins-plugin-speex.html#plugin-speex">speex</a> 163 </td> 164</tr> 165<tr> 166<td><p><span class="term">author</span></p></td> 167<td>Wim Taymans <wim@fluendo.com></td> 168</tr> 169<tr> 170<td><p><span class="term">class</span></p></td> 171<td>Codec/Encoder/Audio</td> 172</tr> 173</tbody> 174</table></div> 175</div> 176<hr> 177<div class="refsect2"> 178<a name="id-1.2.251.8.6.2"></a><h3>Element Pads</h3> 179<div class="variablelist"><table border="0" class="variablelist"> 180<colgroup> 181<col align="left" valign="top"> 182<col> 183</colgroup> 184<tbody> 185<tr> 186<td><p><span class="term">name</span></p></td> 187<td>sink</td> 188</tr> 189<tr> 190<td><p><span class="term">direction</span></p></td> 191<td>sink</td> 192</tr> 193<tr> 194<td><p><span class="term">presence</span></p></td> 195<td>always</td> 196</tr> 197<tr> 198<td><p><span class="term">details</span></p></td> 199<td>audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int)[ 6000, 48000 ], channels=(int)1</td> 200</tr> 201<tr> 202<td><p><span class="term"></span></p></td> 203<td> audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int)[ 6000, 48000 ], channels=(int)2, channel-mask=(bitmask)0x0000000000000003</td> 204</tr> 205</tbody> 206</table></div> 207<div class="variablelist"><table border="0" class="variablelist"> 208<colgroup> 209<col align="left" valign="top"> 210<col> 211</colgroup> 212<tbody> 213<tr> 214<td><p><span class="term">name</span></p></td> 215<td>src</td> 216</tr> 217<tr> 218<td><p><span class="term">direction</span></p></td> 219<td>source</td> 220</tr> 221<tr> 222<td><p><span class="term">presence</span></p></td> 223<td>always</td> 224</tr> 225<tr> 226<td><p><span class="term">details</span></p></td> 227<td>audio/x-speex, rate=(int)[ 6000, 48000 ], channels=(int)[ 1, 2 ]</td> 228</tr> 229</tbody> 230</table></div> 231</div> 232</div> 233</div> 234<div class="refsect1"> 235<a name="gst-plugins-good-plugins-speexenc.functions_details"></a><h2>Functions</h2> 236<p></p> 237</div> 238<div class="refsect1"> 239<a name="gst-plugins-good-plugins-speexenc.other_details"></a><h2>Types and Values</h2> 240<div class="refsect2"> 241<a name="GstSpeexEnc-struct"></a><h3>struct GstSpeexEnc</h3> 242<pre class="programlisting">struct GstSpeexEnc;</pre> 243</div> 244</div> 245<div class="refsect1"> 246<a name="gst-plugins-good-plugins-speexenc.property-details"></a><h2>Property Details</h2> 247<div class="refsect2"> 248<a name="GstSpeexEnc--abr"></a><h3>The <code class="literal">“abr”</code> property</h3> 249<pre class="programlisting"> “abr” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 250<p>Enable average bit-rate (0 = disabled).</p> 251<p>Flags: Read / Write / Construct</p> 252<p>Allowed values: >= 0</p> 253<p>Default value: 0</p> 254</div> 255<hr> 256<div class="refsect2"> 257<a name="GstSpeexEnc--bitrate"></a><h3>The <code class="literal">“bitrate”</code> property</h3> 258<pre class="programlisting"> “bitrate” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 259<p>Specify an encoding bit-rate (in bps). (0 = automatic).</p> 260<p>Flags: Read / Write / Construct</p> 261<p>Allowed values: >= 0</p> 262<p>Default value: 0</p> 263</div> 264<hr> 265<div class="refsect2"> 266<a name="GstSpeexEnc--complexity"></a><h3>The <code class="literal">“complexity”</code> property</h3> 267<pre class="programlisting"> “complexity” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 268<p>Set encoding complexity.</p> 269<p>Flags: Read / Write / Construct</p> 270<p>Allowed values: >= 0</p> 271<p>Default value: 3</p> 272</div> 273<hr> 274<div class="refsect2"> 275<a name="GstSpeexEnc--dtx"></a><h3>The <code class="literal">“dtx”</code> property</h3> 276<pre class="programlisting"> “dtx” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 277<p>Enable discontinuous transmission.</p> 278<p>Flags: Read / Write / Construct</p> 279<p>Default value: FALSE</p> 280</div> 281<hr> 282<div class="refsect2"> 283<a name="GstSpeexEnc--last-message"></a><h3>The <code class="literal">“last-message”</code> property</h3> 284<pre class="programlisting"> “last-message” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 285<p>The last status message.</p> 286<p>Flags: Read</p> 287<p>Default value: NULL</p> 288</div> 289<hr> 290<div class="refsect2"> 291<a name="GstSpeexEnc--nframes"></a><h3>The <code class="literal">“nframes”</code> property</h3> 292<pre class="programlisting"> “nframes” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 293<p>Number of frames per buffer.</p> 294<p>Flags: Read / Write / Construct</p> 295<p>Allowed values: >= 0</p> 296<p>Default value: 1</p> 297</div> 298<hr> 299<div class="refsect2"> 300<a name="GstSpeexEnc--quality"></a><h3>The <code class="literal">“quality”</code> property</h3> 301<pre class="programlisting"> “quality” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 302<p>Encoding quality.</p> 303<p>Flags: Read / Write / Construct</p> 304<p>Allowed values: [0,10]</p> 305<p>Default value: 8</p> 306</div> 307<hr> 308<div class="refsect2"> 309<a name="GstSpeexEnc--vad"></a><h3>The <code class="literal">“vad”</code> property</h3> 310<pre class="programlisting"> “vad” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 311<p>Enable voice activity detection.</p> 312<p>Flags: Read / Write / Construct</p> 313<p>Default value: FALSE</p> 314</div> 315<hr> 316<div class="refsect2"> 317<a name="GstSpeexEnc--vbr"></a><h3>The <code class="literal">“vbr”</code> property</h3> 318<pre class="programlisting"> “vbr” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 319<p>Enable variable bit-rate.</p> 320<p>Flags: Read / Write / Construct</p> 321<p>Default value: FALSE</p> 322</div> 323<hr> 324<div class="refsect2"> 325<a name="GstSpeexEnc--mode"></a><h3>The <code class="literal">“mode”</code> property</h3> 326<pre class="programlisting"> “mode” <span class="type">GstSpeexEncMode</span></pre> 327<p>The encoding mode.</p> 328<p>Flags: Read / Write / Construct</p> 329<p>Default value: Auto</p> 330</div> 331</div> 332<div class="refsect1"> 333<a name="gst-plugins-good-plugins-speexenc.see-also"></a><h2>See Also</h2> 334<p>speexdec, oggmux</p> 335</div> 336</div> 337<div class="footer"> 338<hr>Generated by GTK-Doc V1.28</div> 339</body> 340</html>
