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.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-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.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-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                +----GstAudioEncoder
  56                      +----GstSpeexEnc
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="gst-plugins-good-plugins-speexenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  61 <p>
  62 GstSpeexEnc implements
  63  <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>
  64 </div>
  65 <div class="refsect1">
  66 <a name="gst-plugins-good-plugins-speexenc.properties"></a><h2>Properties</h2>
  67 <pre class="synopsis">
  68   "<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 / Construct
  69   "<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 / Construct
  70   "<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 / Construct
  71   "<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 / Construct
  72   "<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
  73   "<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 / Construct
  74   "<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 / Construct
  75   "<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 / Construct
  76   "<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 / Construct
  77   "<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 / Construct
  78 </pre>
  79 </div>
  80 <div class="refsect1">
  81 <a name="gst-plugins-good-plugins-speexenc.description"></a><h2>Description</h2>
  82 <div class="refsynopsisdiv">
  83 <h2>Synopsis</h2>
  84 <div class="refsect2">
  85 <a name="idp22043536"></a><h3>Element Information</h3>
  86 <div class="variablelist"><table border="0">
  87 <col align="left" valign="top">
  88 <tbody>
  89 <tr>
  90 <td><p><span class="term">plugin</span></p></td>
  91 <td>
  92             <a class="link" href="gst-plugins-good-plugins-plugin-speex.html#plugin-speex">speex</a>
  93           </td>
  94 </tr>
  95 <tr>
  96 <td><p><span class="term">author</span></p></td>
  97 <td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
  98 </tr>
  99 <tr>
 100 <td><p><span class="term">class</span></p></td>
 101 <td>Codec/Encoder/Audio</td>
 102 </tr>
 103 </tbody>
 104 </table></div>
 105 </div>
 106 <hr>
 107 <div class="refsect2">
 108 <a name="idp19670400"></a><h3>Element Pads</h3>
 109 <div class="variablelist"><table border="0">
 110 <col align="left" valign="top">
 111 <tbody>
 112 <tr>
 113 <td><p><span class="term">name</span></p></td>
 114 <td>sink</td>
 115 </tr>
 116 <tr>
 117 <td><p><span class="term">direction</span></p></td>
 118 <td>sink</td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term">presence</span></p></td>
 122 <td>always</td>
 123 </tr>
 124 <tr>
 125 <td><p><span class="term">details</span></p></td>
 126 <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>
 127 </tr>
 128 </tbody>
 129 </table></div>
 130 <div class="variablelist"><table border="0">
 131 <col align="left" valign="top">
 132 <tbody>
 133 <tr>
 134 <td><p><span class="term">name</span></p></td>
 135 <td>src</td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term">direction</span></p></td>
 139 <td>source</td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term">presence</span></p></td>
 143 <td>always</td>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term">details</span></p></td>
 147 <td>audio/x-speex, rate=(int)[ 6000, 48000 ], channels=(int)[ 1, 2 ]</td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 </div>
 152 </div>
 153 <p>
 154 </p>
 155 </div>
 156 <div class="refsect1">
 157 <a name="gst-plugins-good-plugins-speexenc.details"></a><h2>Details</h2>
 158 <div class="refsect2">
 159 <a name="GstSpeexEnc-struct"></a><h3>struct GstSpeexEnc</h3>
 160 <pre class="programlisting">struct GstSpeexEnc;</pre>
 161 <p>
 162 </p>
 163 </div>
 164 </div>
 165 <div class="refsect1">
 166 <a name="gst-plugins-good-plugins-speexenc.property-details"></a><h2>Property Details</h2>
 167 <div class="refsect2">
 168 <a name="GstSpeexEnc--abr"></a><h3>The <code class="literal">"abr"</code> property</h3>
 169 <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 / Construct</pre>
 170 <p>Enable average bit-rate (0 = disabled).</p>
 171 <p>Allowed values: &gt;= 0</p>
 172 <p>Default value: 0</p>
 173 </div>
 174 <hr>
 175 <div class="refsect2">
 176 <a name="GstSpeexEnc--bitrate"></a><h3>The <code class="literal">"bitrate"</code> property</h3>
 177 <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 / Construct</pre>
 178 <p>Specify an encoding bit-rate (in bps). (0 = automatic).</p>
 179 <p>Allowed values: &gt;= 0</p>
 180 <p>Default value: 0</p>
 181 </div>
 182 <hr>
 183 <div class="refsect2">
 184 <a name="GstSpeexEnc--complexity"></a><h3>The <code class="literal">"complexity"</code> property</h3>
 185 <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 / Construct</pre>
 186 <p>Set encoding complexity.</p>
 187 <p>Allowed values: &gt;= 0</p>
 188 <p>Default value: 3</p>
 189 </div>
 190 <hr>
 191 <div class="refsect2">
 192 <a name="GstSpeexEnc--dtx"></a><h3>The <code class="literal">"dtx"</code> property</h3>
 193 <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 / Construct</pre>
 194 <p>Enable discontinuous transmission.</p>
 195 <p>Default value: FALSE</p>
 196 </div>
 197 <hr>
 198 <div class="refsect2">
 199 <a name="GstSpeexEnc--last-message"></a><h3>The <code class="literal">"last-message"</code> property</h3>
 200 <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>
 201 <p>The last status message.</p>
 202 <p>Default value: NULL</p>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="GstSpeexEnc--nframes"></a><h3>The <code class="literal">"nframes"</code> property</h3>
 207 <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 / Construct</pre>
 208 <p>Number of frames per buffer.</p>
 209 <p>Allowed values: &gt;= 0</p>
 210 <p>Default value: 1</p>
 211 </div>
 212 <hr>
 213 <div class="refsect2">
 214 <a name="GstSpeexEnc--quality"></a><h3>The <code class="literal">"quality"</code> property</h3>
 215 <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 / Construct</pre>
 216 <p>Encoding quality.</p>
 217 <p>Allowed values: [0,10]</p>
 218 <p>Default value: 8</p>
 219 </div>
 220 <hr>
 221 <div class="refsect2">
 222 <a name="GstSpeexEnc--vad"></a><h3>The <code class="literal">"vad"</code> property</h3>
 223 <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 / Construct</pre>
 224 <p>Enable voice activity detection.</p>
 225 <p>Default value: FALSE</p>
 226 </div>
 227 <hr>
 228 <div class="refsect2">
 229 <a name="GstSpeexEnc--vbr"></a><h3>The <code class="literal">"vbr"</code> property</h3>
 230 <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 / Construct</pre>
 231 <p>Enable variable bit-rate.</p>
 232 <p>Default value: FALSE</p>
 233 </div>
 234 <hr>
 235 <div class="refsect2">
 236 <a name="GstSpeexEnc--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
 237 <pre class="programlisting">  "mode"                     <span class="type">GstSpeexEncMode</span>       : Read / Write / Construct</pre>
 238 <p>The encoding mode.</p>
 239 <p>Default value: Auto</p>
 240 </div>
 241 </div>
 242 </div>
 243 <div class="footer">
 244 <hr>
 245           Generated by GTK-Doc V1.18</div>
 246 </body>
 247 </html>