docs/plugins/html/gst-plugins-good-plugins-equalizer-3bands.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-3bands</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-equalizer-10bands.html" title="equalizer-10bands">
  10 <link rel="next" href="gst-plugins-good-plugins-equalizer-nbands.html" title="equalizer-nbands">
  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-equalizer-10bands.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-nbands.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-3bands.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-equalizer-3bands.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-equalizer-3bands.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-equalizer-3bands.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-equalizer-3bands.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-equalizer-3bands"></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-3bands.top_of_page"></a>equalizer-3bands</span></h2>
  40 <p>equalizer-3bands — Direct Form 3 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-3bands.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstIirEqualizer3Bands"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-equalizer-3bands.html#GstIirEqualizer3Bands-struct" title="struct GstIirEqualizer3Bands">GstIirEqualizer3Bands</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-equalizer-3bands.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                                  +----GstIirEqualizer3Bands
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gst-plugins-good-plugins-equalizer-3bands.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  63 <p>
  64 GstIirEqualizer3Bands 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-3bands.properties"></a><h2>Properties</h2>
  69 <pre class="synopsis">
  70   "<a class="link" href="gst-plugins-good-plugins-equalizer-3bands.html#GstIirEqualizer3Bands--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-3bands.html#GstIirEqualizer3Bands--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-3bands.html#GstIirEqualizer3Bands--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 </pre>
  74 </div>
  75 <div class="refsect1">
  76 <a name="gst-plugins-good-plugins-equalizer-3bands.description"></a><h2>Description</h2>
  77 <p>
  78 The 3-band equalizer element allows to change the gain of a low frequency,
  79 medium frequency and high frequency band.
  80 </p>
  81 <p>
  82 </p>
  83 <div class="refsect2">
  84 <a name="idp7040208"></a><h3>Example launch line</h3>
  85 <div class="informalexample">
  86   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  87     <tbody>
  88       <tr>
  89         <td class="listing_lines" align="right"><pre>1</pre></td>
  90         <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">3</span>bands band1<span class="gtkdoc opt">=</span><span class="number">6.0</span> <span class="gtkdoc opt">!</span> alsasink</pre></td>
  91       </tr>
  92     </tbody>
  93   </table>
  94 </div>
  95  This raises the volume of the 2nd band, which is at 1110 Hz, by 6 db.
  96 </div>
  97 <p>
  98 </p>
  99 <div class="refsynopsisdiv">
 100 <h2>Synopsis</h2>
 101 <div class="refsect2">
 102 <a name="idp10734992"></a><h3>Element Information</h3>
 103 <div class="variablelist"><table border="0">
 104 <col align="left" valign="top">
 105 <tbody>
 106 <tr>
 107 <td><p><span class="term">plugin</span></p></td>
 108 <td>
 109             <a class="link" href="gst-plugins-good-plugins-plugin-equalizer.html#plugin-equalizer">equalizer</a>
 110           </td>
 111 </tr>
 112 <tr>
 113 <td><p><span class="term">author</span></p></td>
 114 <td>Stefan Kost &lt;ensonic@users.sf.net&gt;</td>
 115 </tr>
 116 <tr>
 117 <td><p><span class="term">class</span></p></td>
 118 <td>Filter/Effect/Audio</td>
 119 </tr>
 120 </tbody>
 121 </table></div>
 122 </div>
 123 <hr>
 124 <div class="refsect2">
 125 <a name="idp8139952"></a><h3>Element Pads</h3>
 126 <div class="variablelist"><table border="0">
 127 <col align="left" valign="top">
 128 <tbody>
 129 <tr>
 130 <td><p><span class="term">name</span></p></td>
 131 <td>sink</td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term">direction</span></p></td>
 135 <td>sink</td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term">presence</span></p></td>
 139 <td>always</td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term">details</span></p></td>
 143 <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>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term"></span></p></td>
 147 <td> audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 <div class="variablelist"><table border="0">
 152 <col align="left" valign="top">
 153 <tbody>
 154 <tr>
 155 <td><p><span class="term">name</span></p></td>
 156 <td>src</td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term">direction</span></p></td>
 160 <td>source</td>
 161 </tr>
 162 <tr>
 163 <td><p><span class="term">presence</span></p></td>
 164 <td>always</td>
 165 </tr>
 166 <tr>
 167 <td><p><span class="term">details</span></p></td>
 168 <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>
 169 </tr>
 170 <tr>
 171 <td><p><span class="term"></span></p></td>
 172 <td> audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 173 </tr>
 174 </tbody>
 175 </table></div>
 176 </div>
 177 </div>
 178 <p>
 179 </p>
 180 </div>
 181 <div class="refsect1">
 182 <a name="gst-plugins-good-plugins-equalizer-3bands.details"></a><h2>Details</h2>
 183 <div class="refsect2">
 184 <a name="GstIirEqualizer3Bands-struct"></a><h3>struct GstIirEqualizer3Bands</h3>
 185 <pre class="programlisting">struct GstIirEqualizer3Bands;</pre>
 186 <p>
 187 </p>
 188 </div>
 189 </div>
 190 <div class="refsect1">
 191 <a name="gst-plugins-good-plugins-equalizer-3bands.property-details"></a><h2>Property Details</h2>
 192 <div class="refsect2">
 193 <a name="GstIirEqualizer3Bands--band0"></a><h3>The <code class="literal">"band0"</code> property</h3>
 194 <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>
 195 <p>gain for the frequency band 100 Hz, ranging from -24.0 to +12.0.</p>
 196 <p>Allowed values: [-24,12]</p>
 197 <p>Default value: 0</p>
 198 </div>
 199 <hr>
 200 <div class="refsect2">
 201 <a name="GstIirEqualizer3Bands--band1"></a><h3>The <code class="literal">"band1"</code> property</h3>
 202 <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>
 203 <p>gain for the frequency band 1100 Hz, ranging from -24.0 to +12.0.</p>
 204 <p>Allowed values: [-24,12]</p>
 205 <p>Default value: 0</p>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="GstIirEqualizer3Bands--band2"></a><h3>The <code class="literal">"band2"</code> property</h3>
 210 <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>
 211 <p>gain for the frequency band 11 kHz, ranging from -24.0 to +12.0.</p>
 212 <p>Allowed values: [-24,12]</p>
 213 <p>Default value: 0</p>
 214 </div>
 215 </div>
 216 </div>
 217 <div class="footer">
 218 <hr>
 219           Generated by GTK-Doc V1.17</div>
 220 </body>
 221 </html>