docs/plugins/html/gst-plugins-good-plugins-equalizer-10bands.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>equalizer-10bands</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-edgetv.html" title="edgetv">
  10 <link rel="next" href="gst-plugins-good-plugins-equalizer-3bands.html" title="equalizer-3bands">
  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-edgetv.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-equalizer-3bands.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-equalizer-10bands.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-equalizer-10bands.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-equalizer-10bands.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-equalizer-10bands.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-equalizer-10bands.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-equalizer-10bands"></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-equalizer-10bands.top_of_page"></a>equalizer-10bands</span></h2>
  40 <p>equalizer-10bands — Direct Form 10 band IIR equalizer</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-equalizer-10bands.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstIirEqualizer10Bands"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-equalizer-10bands.html#GstIirEqualizer10Bands-struct" title="struct GstIirEqualizer10Bands">GstIirEqualizer10Bands</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-equalizer-10bands.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                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
  56                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter">GstAudioFilter</a>
  57                            +----<a class="link" href="GstIirEqualizer.html" title="GstIirEqualizer">GstIirEqualizer</a>
  58                                  +----GstIirEqualizer10Bands
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gst-plugins-good-plugins-equalizer-10bands.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  63 <p>
  64 GstIirEqualizer10Bands implements
  65  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstChildProxy.html">GstChildProxy</a> and  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPreset.html">GstPreset</a>.</p>
  66 </div>
  67 <div class="refsect1">
  68 <a name="gst-plugins-good-plugins-equalizer-10bands.properties"></a><h2>Properties</h2>
  69 <pre class="synopsis">
  70   "<a class="link" href="gst-plugins-good-plugins-equalizer-10bands.html#GstIirEqualizer10Bands--band0" title='The "band0" property'>band0</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  71   "<a class="link" href="gst-plugins-good-plugins-equalizer-10bands.html#GstIirEqualizer10Bands--band1" title='The "band1" property'>band1</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  72   "<a class="link" href="gst-plugins-good-plugins-equalizer-10bands.html#GstIirEqualizer10Bands--band2" title='The "band2" property'>band2</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  73   "<a class="link" href="gst-plugins-good-plugins-equalizer-10bands.html#GstIirEqualizer10Bands--band3" title='The "band3" property'>band3</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  74   "<a class="link" href="gst-plugins-good-plugins-equalizer-10bands.html#GstIirEqualizer10Bands--band4" title='The "band4" property'>band4</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  75   "<a class="link" href="gst-plugins-good-plugins-equalizer-10bands.html#GstIirEqualizer10Bands--band5" title='The "band5" property'>band5</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  76   "<a class="link" href="gst-plugins-good-plugins-equalizer-10bands.html#GstIirEqualizer10Bands--band6" title='The "band6" property'>band6</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  77   "<a class="link" href="gst-plugins-good-plugins-equalizer-10bands.html#GstIirEqualizer10Bands--band7" title='The "band7" property'>band7</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  78   "<a class="link" href="gst-plugins-good-plugins-equalizer-10bands.html#GstIirEqualizer10Bands--band8" title='The "band8" property'>band8</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  79   "<a class="link" href="gst-plugins-good-plugins-equalizer-10bands.html#GstIirEqualizer10Bands--band9" title='The "band9" property'>band9</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  80 </pre>
  81 </div>
  82 <div class="refsect1">
  83 <a name="gst-plugins-good-plugins-equalizer-10bands.description"></a><h2>Description</h2>
  84 <p>
  85 The 10 band equalizer element allows to change the gain of 10 equally distributed
  86 frequency bands between 30 Hz and 15 kHz.
  87 </p>
  88 <p>
  89 </p>
  90 <div class="refsect2">
  91 <a name="idp14017408"></a><h3>Example launch line</h3>
  92 <div class="informalexample">
  93   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  94     <tbody>
  95       <tr>
  96         <td class="listing_lines" align="right"><pre>1</pre></td>
  97         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span>song<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> vorbisdec <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> equalizer<span class="gtkdoc opt">-</span><span class="number">10</span>bands band2<span class="gtkdoc opt">=</span><span class="number">3.0</span> <span class="gtkdoc opt">!</span> alsasink</pre></td>
  98       </tr>
  99     </tbody>
 100   </table>
 101 </div>
 102  This raises the volume of the 3rd band which is at 119 Hz by 3 db.
 103 </div>
 104 <p>
 105 </p>
 106 <div class="refsynopsisdiv">
 107 <h2>Synopsis</h2>
 108 <div class="refsect2">
 109 <a name="idp8046320"></a><h3>Element Information</h3>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term">plugin</span></p></td>
 115 <td>
 116             <a class="link" href="gst-plugins-good-plugins-plugin-equalizer.html#plugin-equalizer">equalizer</a>
 117           </td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term">author</span></p></td>
 121 <td>Stefan Kost &lt;ensonic@users.sf.net&gt;</td>
 122 </tr>
 123 <tr>
 124 <td><p><span class="term">class</span></p></td>
 125 <td>Filter/Effect/Audio</td>
 126 </tr>
 127 </tbody>
 128 </table></div>
 129 </div>
 130 <hr>
 131 <div class="refsect2">
 132 <a name="idp13525664"></a><h3>Element Pads</h3>
 133 <div class="variablelist"><table border="0">
 134 <col align="left" valign="top">
 135 <tbody>
 136 <tr>
 137 <td><p><span class="term">name</span></p></td>
 138 <td>sink</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term">direction</span></p></td>
 142 <td>sink</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term">presence</span></p></td>
 146 <td>always</td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term">details</span></p></td>
 150 <td>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term"></span></p></td>
 154 <td> audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 155 </tr>
 156 </tbody>
 157 </table></div>
 158 <div class="variablelist"><table border="0">
 159 <col align="left" valign="top">
 160 <tbody>
 161 <tr>
 162 <td><p><span class="term">name</span></p></td>
 163 <td>src</td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term">direction</span></p></td>
 167 <td>source</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term">presence</span></p></td>
 171 <td>always</td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term">details</span></p></td>
 175 <td>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 176 </tr>
 177 <tr>
 178 <td><p><span class="term"></span></p></td>
 179 <td> audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 180 </tr>
 181 </tbody>
 182 </table></div>
 183 </div>
 184 </div>
 185 <p>
 186 </p>
 187 </div>
 188 <div class="refsect1">
 189 <a name="gst-plugins-good-plugins-equalizer-10bands.details"></a><h2>Details</h2>
 190 <div class="refsect2">
 191 <a name="GstIirEqualizer10Bands-struct"></a><h3>struct GstIirEqualizer10Bands</h3>
 192 <pre class="programlisting">struct GstIirEqualizer10Bands;</pre>
 193 <p>
 194 </p>
 195 </div>
 196 </div>
 197 <div class="refsect1">
 198 <a name="gst-plugins-good-plugins-equalizer-10bands.property-details"></a><h2>Property Details</h2>
 199 <div class="refsect2">
 200 <a name="GstIirEqualizer10Bands--band0"></a><h3>The <code class="literal">"band0"</code> property</h3>
 201 <pre class="programlisting">  "band0"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 202 <p>gain for the frequency band 29 Hz, ranging from -24 dB to +12 dB.</p>
 203 <p>Allowed values: [-24,12]</p>
 204 <p>Default value: 0</p>
 205 </div>
 206 <hr>
 207 <div class="refsect2">
 208 <a name="GstIirEqualizer10Bands--band1"></a><h3>The <code class="literal">"band1"</code> property</h3>
 209 <pre class="programlisting">  "band1"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 210 <p>gain for the frequency band 59 Hz, ranging from -24 dB to +12 dB.</p>
 211 <p>Allowed values: [-24,12]</p>
 212 <p>Default value: 0</p>
 213 </div>
 214 <hr>
 215 <div class="refsect2">
 216 <a name="GstIirEqualizer10Bands--band2"></a><h3>The <code class="literal">"band2"</code> property</h3>
 217 <pre class="programlisting">  "band2"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 218 <p>gain for the frequency band 119 Hz, ranging from -24 dB to +12 dB.</p>
 219 <p>Allowed values: [-24,12]</p>
 220 <p>Default value: 0</p>
 221 </div>
 222 <hr>
 223 <div class="refsect2">
 224 <a name="GstIirEqualizer10Bands--band3"></a><h3>The <code class="literal">"band3"</code> property</h3>
 225 <pre class="programlisting">  "band3"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 226 <p>gain for the frequency band 237 Hz, ranging from -24 dB to +12 dB.</p>
 227 <p>Allowed values: [-24,12]</p>
 228 <p>Default value: 0</p>
 229 </div>
 230 <hr>
 231 <div class="refsect2">
 232 <a name="GstIirEqualizer10Bands--band4"></a><h3>The <code class="literal">"band4"</code> property</h3>
 233 <pre class="programlisting">  "band4"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 234 <p>gain for the frequency band 474 Hz, ranging from -24 dB to +12 dB.</p>
 235 <p>Allowed values: [-24,12]</p>
 236 <p>Default value: 0</p>
 237 </div>
 238 <hr>
 239 <div class="refsect2">
 240 <a name="GstIirEqualizer10Bands--band5"></a><h3>The <code class="literal">"band5"</code> property</h3>
 241 <pre class="programlisting">  "band5"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 242 <p>gain for the frequency band 947 Hz, ranging from -24 dB to +12 dB.</p>
 243 <p>Allowed values: [-24,12]</p>
 244 <p>Default value: 0</p>
 245 </div>
 246 <hr>
 247 <div class="refsect2">
 248 <a name="GstIirEqualizer10Bands--band6"></a><h3>The <code class="literal">"band6"</code> property</h3>
 249 <pre class="programlisting">  "band6"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 250 <p>gain for the frequency band 1889 Hz, ranging from -24 dB to +12 dB.</p>
 251 <p>Allowed values: [-24,12]</p>
 252 <p>Default value: 0</p>
 253 </div>
 254 <hr>
 255 <div class="refsect2">
 256 <a name="GstIirEqualizer10Bands--band7"></a><h3>The <code class="literal">"band7"</code> property</h3>
 257 <pre class="programlisting">  "band7"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 258 <p>gain for the frequency band 3770 Hz, ranging from -24 dB to +12 dB.</p>
 259 <p>Allowed values: [-24,12]</p>
 260 <p>Default value: 0</p>
 261 </div>
 262 <hr>
 263 <div class="refsect2">
 264 <a name="GstIirEqualizer10Bands--band8"></a><h3>The <code class="literal">"band8"</code> property</h3>
 265 <pre class="programlisting">  "band8"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 266 <p>gain for the frequency band 7523 Hz, ranging from -24 dB to +12 dB.</p>
 267 <p>Allowed values: [-24,12]</p>
 268 <p>Default value: 0</p>
 269 </div>
 270 <hr>
 271 <div class="refsect2">
 272 <a name="GstIirEqualizer10Bands--band9"></a><h3>The <code class="literal">"band9"</code> property</h3>
 273 <pre class="programlisting">  "band9"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 274 <p>gain for the frequency band 15011 Hz, ranging from -24 dB to +12 dB.</p>
 275 <p>Allowed values: [-24,12]</p>
 276 <p>Default value: 0</p>
 277 </div>
 278 </div>
 279 </div>
 280 <div class="footer">
 281 <hr>
 282           Generated by GTK-Doc V1.17</div>
 283 </body>
 284 </html>