docs/plugins/html/gst-plugins-good-plugins-speexenc.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>speexenc</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-spectrum.html" title="spectrum">
  10 <link rel="next" href="gst-plugins-good-plugins-speexdec.html" title="speexdec">
  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-spectrum.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-speexdec.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-speexenc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-speexenc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-speexenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-speexenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-speexenc.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-speexenc"></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-speexenc.top_of_page"></a>speexenc</span></h2>
  40 <p>speexenc — Encodes audio in Speex format</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-speexenc.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstSpeexEnc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc-struct" title="struct GstSpeexEnc">GstSpeexEnc</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-speexenc.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                +----GstSpeexEnc
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-good-plugins-speexenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  60 <p>
  61 GstSpeexEnc implements
  62  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagSetter.html">GstTagSetter</a> and  <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-speexenc.properties"></a><h2>Properties</h2>
  66 <pre class="synopsis">
  67   "<a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--abr" title='The "abr" property'>abr</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  68   "<a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--bitrate" title='The "bitrate" property'>bitrate</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  69   "<a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--complexity" title='The "complexity" property'>complexity</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  70   "<a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--dtx" title='The "dtx" property'>dtx</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  71   "<a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--last-message" title='The "last-message" property'>last-message</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  72   "<a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--nframes" title='The "nframes" property'>nframes</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  73   "<a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--quality" title='The "quality" property'>quality</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  74   "<a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--vad" title='The "vad" property'>vad</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  75   "<a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--vbr" title='The "vbr" property'>vbr</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  76   "<a class="link" href="gst-plugins-good-plugins-speexenc.html#GstSpeexEnc--mode" title='The "mode" property'>mode</a>"                     <span class="type">GstSpeexEncMode</span>       : Read / Write
  77 </pre>
  78 </div>
  79 <div class="refsect1">
  80 <a name="gst-plugins-good-plugins-speexenc.description"></a><h2>Description</h2>
  81 <p>
  82 This element encodes audio as a Speex stream.
  83 <a class="ulink" href="http://www.speex.org/" target="_top">Speex</a> is a royalty-free
  84 audio codec maintained by the <a class="ulink" href="http://www.xiph.org/" target="_top">Xiph.org
  85 Foundation</a>.
  86 </p>
  87 <p>
  88 </p>
  89 <div class="refsect2">
  90 <a name="idp17934432"></a><h3>Example pipelines</h3>
  91 <div class="informalexample">
  92   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  93     <tbody>
  94       <tr>
  95         <td class="listing_lines" align="right"><pre>1</pre></td>
  96         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch 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>
  97       </tr>
  98     </tbody>
  99   </table>
 100 </div>
 101  Encode an Ogg/Speex file.
 102 </div>
 103 <p>
 104 </p>
 105 <div class="refsynopsisdiv">
 106 <h2>Synopsis</h2>
 107 <div class="refsect2">
 108 <a name="idp21293088"></a><h3>Element Information</h3>
 109 <div class="variablelist"><table border="0">
 110 <col align="left" valign="top">
 111 <tbody>
 112 <tr>
 113 <td><p><span class="term">plugin</span></p></td>
 114 <td>
 115             <a class="link" href="gst-plugins-good-plugins-plugin-speex.html#plugin-speex">speex</a>
 116           </td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term">author</span></p></td>
 120 <td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
 121 </tr>
 122 <tr>
 123 <td><p><span class="term">class</span></p></td>
 124 <td>Codec/Encoder/Audio</td>
 125 </tr>
 126 </tbody>
 127 </table></div>
 128 </div>
 129 <hr>
 130 <div class="refsect2">
 131 <a name="idp18816368"></a><h3>Element Pads</h3>
 132 <div class="variablelist"><table border="0">
 133 <col align="left" valign="top">
 134 <tbody>
 135 <tr>
 136 <td><p><span class="term">name</span></p></td>
 137 <td>sink</td>
 138 </tr>
 139 <tr>
 140 <td><p><span class="term">direction</span></p></td>
 141 <td>sink</td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term">presence</span></p></td>
 145 <td>always</td>
 146 </tr>
 147 <tr>
 148 <td><p><span class="term">details</span></p></td>
 149 <td>audio/x-raw-int, rate=(int)[ 6000, 48000 ], channels=(int)[ 1, 2 ], endianness=(int)1234, signed=(boolean)true, width=(int)16, depth=(int)16</td>
 150 </tr>
 151 </tbody>
 152 </table></div>
 153 <div class="variablelist"><table border="0">
 154 <col align="left" valign="top">
 155 <tbody>
 156 <tr>
 157 <td><p><span class="term">name</span></p></td>
 158 <td>src</td>
 159 </tr>
 160 <tr>
 161 <td><p><span class="term">direction</span></p></td>
 162 <td>source</td>
 163 </tr>
 164 <tr>
 165 <td><p><span class="term">presence</span></p></td>
 166 <td>always</td>
 167 </tr>
 168 <tr>
 169 <td><p><span class="term">details</span></p></td>
 170 <td>audio/x-speex, rate=(int)[ 6000, 48000 ], channels=(int)[ 1, 2 ]</td>
 171 </tr>
 172 </tbody>
 173 </table></div>
 174 </div>
 175 </div>
 176 <p>
 177 </p>
 178 </div>
 179 <div class="refsect1">
 180 <a name="gst-plugins-good-plugins-speexenc.details"></a><h2>Details</h2>
 181 <div class="refsect2">
 182 <a name="GstSpeexEnc-struct"></a><h3>struct GstSpeexEnc</h3>
 183 <pre class="programlisting">struct GstSpeexEnc;</pre>
 184 <p>
 185 </p>
 186 </div>
 187 </div>
 188 <div class="refsect1">
 189 <a name="gst-plugins-good-plugins-speexenc.property-details"></a><h2>Property Details</h2>
 190 <div class="refsect2">
 191 <a name="GstSpeexEnc--abr"></a><h3>The <code class="literal">"abr"</code> property</h3>
 192 <pre class="programlisting">  "abr"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 193 <p>Enable average bit-rate (0 = disabled).</p>
 194 <p>Allowed values: &gt;= 0</p>
 195 <p>Default value: 0</p>
 196 </div>
 197 <hr>
 198 <div class="refsect2">
 199 <a name="GstSpeexEnc--bitrate"></a><h3>The <code class="literal">"bitrate"</code> property</h3>
 200 <pre class="programlisting">  "bitrate"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 201 <p>Specify an encoding bit-rate (in bps). (0 = automatic).</p>
 202 <p>Allowed values: &gt;= 0</p>
 203 <p>Default value: 0</p>
 204 </div>
 205 <hr>
 206 <div class="refsect2">
 207 <a name="GstSpeexEnc--complexity"></a><h3>The <code class="literal">"complexity"</code> property</h3>
 208 <pre class="programlisting">  "complexity"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 209 <p>Set encoding complexity.</p>
 210 <p>Allowed values: &gt;= 0</p>
 211 <p>Default value: 3</p>
 212 </div>
 213 <hr>
 214 <div class="refsect2">
 215 <a name="GstSpeexEnc--dtx"></a><h3>The <code class="literal">"dtx"</code> property</h3>
 216 <pre class="programlisting">  "dtx"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 217 <p>Enable discontinuous transmission.</p>
 218 <p>Default value: FALSE</p>
 219 </div>
 220 <hr>
 221 <div class="refsect2">
 222 <a name="GstSpeexEnc--last-message"></a><h3>The <code class="literal">"last-message"</code> property</h3>
 223 <pre class="programlisting">  "last-message"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 224 <p>The last status message.</p>
 225 <p>Default value: NULL</p>
 226 </div>
 227 <hr>
 228 <div class="refsect2">
 229 <a name="GstSpeexEnc--nframes"></a><h3>The <code class="literal">"nframes"</code> property</h3>
 230 <pre class="programlisting">  "nframes"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 231 <p>Number of frames per buffer.</p>
 232 <p>Allowed values: &gt;= 0</p>
 233 <p>Default value: 1</p>
 234 </div>
 235 <hr>
 236 <div class="refsect2">
 237 <a name="GstSpeexEnc--quality"></a><h3>The <code class="literal">"quality"</code> property</h3>
 238 <pre class="programlisting">  "quality"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 239 <p>Encoding quality.</p>
 240 <p>Allowed values: [0,10]</p>
 241 <p>Default value: 8</p>
 242 </div>
 243 <hr>
 244 <div class="refsect2">
 245 <a name="GstSpeexEnc--vad"></a><h3>The <code class="literal">"vad"</code> property</h3>
 246 <pre class="programlisting">  "vad"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 247 <p>Enable voice activity detection.</p>
 248 <p>Default value: FALSE</p>
 249 </div>
 250 <hr>
 251 <div class="refsect2">
 252 <a name="GstSpeexEnc--vbr"></a><h3>The <code class="literal">"vbr"</code> property</h3>
 253 <pre class="programlisting">  "vbr"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 254 <p>Enable variable bit-rate.</p>
 255 <p>Default value: FALSE</p>
 256 </div>
 257 <hr>
 258 <div class="refsect2">
 259 <a name="GstSpeexEnc--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
 260 <pre class="programlisting">  "mode"                     <span class="type">GstSpeexEncMode</span>       : Read / Write</pre>
 261 <p>The encoding mode.</p>
 262 <p>Default value: Auto</p>
 263 </div>
 264 </div>
 265 <div class="refsect1">
 266 <a name="gst-plugins-good-plugins-speexenc.see-also"></a><h2>See Also</h2>
 267 speexdec, oggmux
 268 </div>
 269 </div>
 270 <div class="footer">
 271 <hr>
 272           Generated by GTK-Doc V1.17</div>
 273 </body>
 274 </html>