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-nbands: 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-equalizer-3bands.html" title="equalizer-3bands"> 10<link rel="next" href="gst-plugins-good-plugins-flacdec.html" title="flacdec"> 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-equalizer-nbands.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-good-plugins-equalizer-nbands.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-good-plugins-equalizer-nbands.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-good-plugins-equalizer-nbands.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-equalizer-3bands.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-flacdec.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-equalizer-nbands"></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-equalizer-nbands.top_of_page"></a>equalizer-nbands</span></h2> 33<p>equalizer-nbands</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-equalizer-nbands.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><tr> 46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-good-plugins-equalizer-nbands.html#GstIirEqualizerNBands--num-bands" title="The “num-bands” property">num-bands</a></td> 48<td class="property_flags">Read / Write / Construct</td> 49</tr></tbody> 50</table></div> 51</div> 52<a name="GstIirEqualizerNBands"></a><div class="refsect1"> 53<a name="gst-plugins-good-plugins-equalizer-nbands.other"></a><h2>Types and Values</h2> 54<div class="informaltable"><table class="informaltable" width="100%" border="0"> 55<colgroup> 56<col width="150px" class="name"> 57<col class="description"> 58</colgroup> 59<tbody><tr> 60<td class="datatype_keyword">struct</td> 61<td class="function_name"><a class="link" href="gst-plugins-good-plugins-equalizer-nbands.html#GstIirEqualizerNBands-struct" title="struct GstIirEqualizerNBands">GstIirEqualizerNBands</a></td> 62</tr></tbody> 63</table></div> 64</div> 65<div class="refsect1"> 66<a name="gst-plugins-good-plugins-equalizer-nbands.object-hierarchy"></a><h2>Object Hierarchy</h2> 67<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 68 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 69 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 70 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 71 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 72 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstAudioFilter.html#GstAudioFilter-struct">GstAudioFilter</a> 73 <span class="lineart">╰──</span> <a class="link" href="gst-plugins-good-plugins-iirequalizer.html#GstIirEqualizer">GstIirEqualizer</a> 74 <span class="lineart">╰──</span> GstIirEqualizerNBands 75</pre> 76</div> 77<div class="refsect1"> 78<a name="gst-plugins-good-plugins-equalizer-nbands.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 79<p> 80GstIirEqualizerNBands implements 81 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstChildProxy.html#GstChildProxy-struct">GstChildProxy</a> and <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPreset.html#GstPreset-struct">GstPreset</a>.</p> 82</div> 83<div class="refsect1"> 84<a name="gst-plugins-good-plugins-equalizer-nbands.description"></a><h2>Description</h2> 85<p>The n-band equalizer element is a fully parametric equalizer. It allows to 86select between 1 and 64 bands and has properties on each band to change 87the center frequency, band width and gain.</p> 88<div class="refsect2"> 89<a name="id-1.2.55.8.3"></a><h3>Example launch line</h3> 90<div class="informalexample"> 91 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 92 <tbody> 93 <tr> 94 <td class="listing_lines" align="right"><pre>1</pre></td> 95 <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> 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>nbands num<span class="gtkdoc opt">-</span>bands<span class="gtkdoc opt">=</span><span class="number">15</span> <span class="gtkdoc kwc">band5</span><span class="gtkdoc opt">::</span>gain<span class="gtkdoc opt">=</span><span class="number">6.0</span> <span class="gtkdoc opt">!</span> alsasink</pre></td> 96 </tr> 97 </tbody> 98 </table> 99</div> 100 This make the equalizer use 15 bands and raises the volume of the 5th band by 6 db. 101</div> 102<hr> 103<div class="refsect2"> 104<a name="id-1.2.55.8.4"></a><h3>Example code</h3> 105<div class="informalexample"> 106 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 107 <tbody> 108 <tr> 109 <td class="listing_lines" align="right"><pre>1 1102 1113 1124 1135 1146 1157 1168 1179 11810 11911 12012 12113 12214 12315 12416 12517 12618 12719 12820 12921 13022 13123 13224 13325 13426 13527 13628 13729 13830 13931 14032 14133 14234 14335 14436 14537 14638</pre></td> 147 <td class="listing_code"><pre class="programlisting"><span class="gtkdoc ppc">#include <gst/gst.h></span> 148 149<span class="gtkdoc opt">...</span> 150<span class="gtkdoc kwc">typedef</span> <span class="gtkdoc kwb">struct</span> <span class="gtkdoc opt">{</span> 151 gfloat freq<span class="gtkdoc opt">;</span> 152 gfloat width<span class="gtkdoc opt">;</span> 153 gfloat gain<span class="gtkdoc opt">;</span> 154<span class="gtkdoc opt">}</span> GstEqualizerBandState<span class="gtkdoc opt">;</span> 155 156<span class="gtkdoc opt">...</span> 157 158 GstElement <span class="gtkdoc opt">*</span>equalizer<span class="gtkdoc opt">;</span> 159 GObject <span class="gtkdoc opt">*</span>band<span class="gtkdoc opt">;</span> 160 gint i<span class="gtkdoc opt">;</span> 161 GstEqualizerBandState state<span class="gtkdoc opt">[] = {</span> 162 <span class="gtkdoc opt">{</span> <span class="number">120.0</span><span class="gtkdoc opt">,</span> <span class="number">50.0</span><span class="gtkdoc opt">, -</span> <span class="number">3.0</span><span class="gtkdoc opt">},</span> 163 <span class="gtkdoc opt">{</span> <span class="number">500.0</span><span class="gtkdoc opt">,</span> <span class="number">20.0</span><span class="gtkdoc opt">,</span> <span class="number">12.0</span><span class="gtkdoc opt">},</span> 164 <span class="gtkdoc opt">{</span><span class="number">1503.0</span><span class="gtkdoc opt">,</span> <span class="number">2.0</span><span class="gtkdoc opt">, -</span><span class="number">20.0</span><span class="gtkdoc opt">},</span> 165 <span class="gtkdoc opt">{</span><span class="number">6000.0</span><span class="gtkdoc opt">,</span> <span class="number">1000.0</span><span class="gtkdoc opt">,</span> <span class="number">6.0</span><span class="gtkdoc opt">},</span> 166 <span class="gtkdoc opt">{</span><span class="number">3000.0</span><span class="gtkdoc opt">,</span> <span class="number">120.0</span><span class="gtkdoc opt">,</span> <span class="number">2.0</span><span class="gtkdoc opt">}</span> 167 <span class="gtkdoc opt">};</span> 168 169<span class="gtkdoc opt">...</span> 170 171 equalizer <span class="gtkdoc opt">=</span> <span class="function"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElementFactory.html#gst-element-factory-make">gst_element_factory_make</a></span> <span class="gtkdoc opt">(</span><span class="string">"equalizer-nbands"</span><span class="gtkdoc opt">,</span> <span class="string">"equalizer"</span><span class="gtkdoc opt">);</span> 172 <span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-set">g_object_set</a></span> <span class="gtkdoc opt">(</span><span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#G-OBJECT:CAPS">G_OBJECT</a></span> <span class="gtkdoc opt">(</span>equalizer<span class="gtkdoc opt">),</span> <span class="string">"num-bands"</span><span class="gtkdoc opt">,</span> <span class="number">5</span><span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span> 173 174<span class="gtkdoc opt">...</span> 175 176 <span class="keyword">for</span> <span class="gtkdoc opt">(</span>i <span class="gtkdoc opt">=</span> <span class="number">0</span><span class="gtkdoc opt">;</span> i <span class="gtkdoc opt"><</span> <span class="number">5</span><span class="gtkdoc opt">;</span> i<span class="gtkdoc opt">++) {</span> 177 band <span class="gtkdoc opt">=</span> <span class="function"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstChildProxy.html#gst-child-proxy-get-child-by-index">gst_child_proxy_get_child_by_index</a></span> <span class="gtkdoc opt">(</span><span class="function">GST_CHILD_PROXY</span> <span class="gtkdoc opt">(</span>equalizer<span class="gtkdoc opt">),</span> i<span class="gtkdoc opt">);</span> 178 <span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-set">g_object_set</a></span> <span class="gtkdoc opt">(</span><span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#G-OBJECT:CAPS">G_OBJECT</a></span> <span class="gtkdoc opt">(</span>band<span class="gtkdoc opt">),</span> <span class="string">"freq"</span><span class="gtkdoc opt">,</span> state<span class="gtkdoc opt">[</span>i<span class="gtkdoc opt">].</span>freq<span class="gtkdoc opt">,</span> 179 <span class="string">"bandwidth"</span><span class="gtkdoc opt">,</span> state<span class="gtkdoc opt">[</span>i<span class="gtkdoc opt">].</span>width<span class="gtkdoc opt">,</span> 180 <span class="string">"gain"</span><span class="gtkdoc opt">,</span> state<span class="gtkdoc opt">[</span>i<span class="gtkdoc opt">].</span>gain<span class="gtkdoc opt">);</span> 181 <span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="gtkdoc opt">(</span><span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#G-OBJECT:CAPS">G_OBJECT</a></span> <span class="gtkdoc opt">(</span>band<span class="gtkdoc opt">));</span> 182 <span class="gtkdoc opt">}</span> 183 184<span class="gtkdoc opt">...</span></pre></td> 185 </tr> 186 </tbody> 187 </table> 188</div> 189 190</div> 191<div class="refsynopsisdiv"> 192<h2>Synopsis</h2> 193<div class="refsect2"> 194<a name="id-1.2.55.8.5.1"></a><h3>Element Information</h3> 195<div class="variablelist"><table border="0" class="variablelist"> 196<colgroup> 197<col align="left" valign="top"> 198<col> 199</colgroup> 200<tbody> 201<tr> 202<td><p><span class="term">plugin</span></p></td> 203<td> 204 <a class="link" href="gst-plugins-good-plugins-plugin-equalizer.html#plugin-equalizer">equalizer</a> 205 </td> 206</tr> 207<tr> 208<td><p><span class="term">author</span></p></td> 209<td>Benjamin Otte <otte@gnome.org>, Stefan Kost <ensonic@users.sf.net></td> 210</tr> 211<tr> 212<td><p><span class="term">class</span></p></td> 213<td>Filter/Effect/Audio</td> 214</tr> 215</tbody> 216</table></div> 217</div> 218<hr> 219<div class="refsect2"> 220<a name="id-1.2.55.8.5.2"></a><h3>Element Pads</h3> 221<div class="variablelist"><table border="0" class="variablelist"> 222<colgroup> 223<col align="left" valign="top"> 224<col> 225</colgroup> 226<tbody> 227<tr> 228<td><p><span class="term">name</span></p></td> 229<td>sink</td> 230</tr> 231<tr> 232<td><p><span class="term">direction</span></p></td> 233<td>sink</td> 234</tr> 235<tr> 236<td><p><span class="term">presence</span></p></td> 237<td>always</td> 238</tr> 239<tr> 240<td><p><span class="term">details</span></p></td> 241<td>audio/x-raw, format=(string){ S16LE, F32LE, F64LE }, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string)interleaved</td> 242</tr> 243</tbody> 244</table></div> 245<div class="variablelist"><table border="0" class="variablelist"> 246<colgroup> 247<col align="left" valign="top"> 248<col> 249</colgroup> 250<tbody> 251<tr> 252<td><p><span class="term">name</span></p></td> 253<td>src</td> 254</tr> 255<tr> 256<td><p><span class="term">direction</span></p></td> 257<td>source</td> 258</tr> 259<tr> 260<td><p><span class="term">presence</span></p></td> 261<td>always</td> 262</tr> 263<tr> 264<td><p><span class="term">details</span></p></td> 265<td>audio/x-raw, format=(string){ S16LE, F32LE, F64LE }, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string)interleaved</td> 266</tr> 267</tbody> 268</table></div> 269</div> 270</div> 271</div> 272<div class="refsect1"> 273<a name="gst-plugins-good-plugins-equalizer-nbands.functions_details"></a><h2>Functions</h2> 274<p></p> 275</div> 276<div class="refsect1"> 277<a name="gst-plugins-good-plugins-equalizer-nbands.other_details"></a><h2>Types and Values</h2> 278<div class="refsect2"> 279<a name="GstIirEqualizerNBands-struct"></a><h3>struct GstIirEqualizerNBands</h3> 280<pre class="programlisting">struct GstIirEqualizerNBands;</pre> 281</div> 282</div> 283<div class="refsect1"> 284<a name="gst-plugins-good-plugins-equalizer-nbands.property-details"></a><h2>Property Details</h2> 285<div class="refsect2"> 286<a name="GstIirEqualizerNBands--num-bands"></a><h3>The <code class="literal">“num-bands”</code> property</h3> 287<pre class="programlisting"> “num-bands” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 288<p>number of different bands to use.</p> 289<p>Flags: Read / Write / Construct</p> 290<p>Allowed values: [1,64]</p> 291<p>Default value: 10</p> 292</div> 293</div> 294</div> 295<div class="footer"> 296<hr>Generated by GTK-Doc V1.28</div> 297</body> 298</html>
