• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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: 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-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.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">|</span18                  <a href="#gst-plugins-good-plugins-equalizer-3bands.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-good-plugins-equalizer-3bands.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span20                  <a href="#gst-plugins-good-plugins-equalizer-3bands.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span21                  <a href="#gst-plugins-good-plugins-equalizer-3bands.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-10bands.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-equalizer-nbands.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-3bands"></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-3bands.top_of_page"></a>equalizer-3bands</span></h2>
33<p>equalizer-3bands</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-3bands.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>
46<tr>
47<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
48<td class="property_name"><a class="link" href="gst-plugins-good-plugins-equalizer-3bands.html#GstIirEqualizer3Bands--band0" title="The “band0” property">band0</a></td>
49<td class="property_flags">Read / Write</td>
50</tr>
51<tr>
52<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
53<td class="property_name"><a class="link" href="gst-plugins-good-plugins-equalizer-3bands.html#GstIirEqualizer3Bands--band1" title="The “band1” property">band1</a></td>
54<td class="property_flags">Read / Write</td>
55</tr>
56<tr>
57<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
58<td class="property_name"><a class="link" href="gst-plugins-good-plugins-equalizer-3bands.html#GstIirEqualizer3Bands--band2" title="The “band2” property">band2</a></td>
59<td class="property_flags">Read / Write</td>
60</tr>
61</tbody>
62</table></div>
63</div>
64<a name="GstIirEqualizer3Bands"></a><div class="refsect1">
65<a name="gst-plugins-good-plugins-equalizer-3bands.other"></a><h2>Types and Values</h2>
66<div class="informaltable"><table class="informaltable" width="100%" border="0">
67<colgroup>
68<col width="150px" class="name">
69<col class="description">
70</colgroup>
71<tbody><tr>
72<td class="datatype_keyword">struct</td>
73<td class="function_name"><a class="link" href="gst-plugins-good-plugins-equalizer-3bands.html#GstIirEqualizer3Bands-struct" title="struct GstIirEqualizer3Bands">GstIirEqualizer3Bands</a></td>
74</tr></tbody>
75</table></div>
76</div>
77<div class="refsect1">
78<a name="gst-plugins-good-plugins-equalizer-3bands.object-hierarchy"></a><h2>Object Hierarchy</h2>
79<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
80    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
81        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
82            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
83                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a>
84                    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstAudioFilter.html#GstAudioFilter-struct">GstAudioFilter</a>
85                        <span class="lineart">╰──</span> <a class="link" href="gst-plugins-good-plugins-iirequalizer.html#GstIirEqualizer">GstIirEqualizer</a>
86                            <span class="lineart">╰──</span> GstIirEqualizer3Bands
87</pre>
88</div>
89<div class="refsect1">
90<a name="gst-plugins-good-plugins-equalizer-3bands.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
91<p>
92GstIirEqualizer3Bands implements
93 <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>
94</div>
95<div class="refsect1">
96<a name="gst-plugins-good-plugins-equalizer-3bands.description"></a><h2>Description</h2>
97<p>The 3-band equalizer element allows to change the gain of a low frequency,
98medium frequency and high frequency band.</p>
99<div class="refsect2">
100<a name="id-1.2.54.8.3"></a><h3>Example launch line</h3>
101<div class="informalexample">
102  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
103    <tbody>
104      <tr>
105        <td class="listing_lines" align="right"><pre>1</pre></td>
106        <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><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>
107      </tr>
108    </tbody>
109  </table>
110</div>
111 This raises the volume of the 2nd band, which is at 1110 Hz, by 6 db.
112</div>
113<div class="refsynopsisdiv">
114<h2>Synopsis</h2>
115<div class="refsect2">
116<a name="id-1.2.54.8.4.1"></a><h3>Element Information</h3>
117<div class="variablelist"><table border="0" class="variablelist">
118<colgroup>
119<col align="left" valign="top">
120<col>
121</colgroup>
122<tbody>
123<tr>
124<td><p><span class="term">plugin</span></p></td>
125<td>
126            <a class="link" href="gst-plugins-good-plugins-plugin-equalizer.html#plugin-equalizer">equalizer</a>
127          </td>
128</tr>
129<tr>
130<td><p><span class="term">author</span></p></td>
131<td>Stefan Kost &lt;ensonic@users.sf.net&gt;</td>
132</tr>
133<tr>
134<td><p><span class="term">class</span></p></td>
135<td>Filter/Effect/Audio</td>
136</tr>
137</tbody>
138</table></div>
139</div>
140<hr>
141<div class="refsect2">
142<a name="id-1.2.54.8.4.2"></a><h3>Element Pads</h3>
143<div class="variablelist"><table border="0" class="variablelist">
144<colgroup>
145<col align="left" valign="top">
146<col>
147</colgroup>
148<tbody>
149<tr>
150<td><p><span class="term">name</span></p></td>
151<td>sink</td>
152</tr>
153<tr>
154<td><p><span class="term">direction</span></p></td>
155<td>sink</td>
156</tr>
157<tr>
158<td><p><span class="term">presence</span></p></td>
159<td>always</td>
160</tr>
161<tr>
162<td><p><span class="term">details</span></p></td>
163<td>audio/x-raw, format=(string){ S16LE, F32LE, F64LE }, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string)interleaved</td>
164</tr>
165</tbody>
166</table></div>
167<div class="variablelist"><table border="0" class="variablelist">
168<colgroup>
169<col align="left" valign="top">
170<col>
171</colgroup>
172<tbody>
173<tr>
174<td><p><span class="term">name</span></p></td>
175<td>src</td>
176</tr>
177<tr>
178<td><p><span class="term">direction</span></p></td>
179<td>source</td>
180</tr>
181<tr>
182<td><p><span class="term">presence</span></p></td>
183<td>always</td>
184</tr>
185<tr>
186<td><p><span class="term">details</span></p></td>
187<td>audio/x-raw, format=(string){ S16LE, F32LE, F64LE }, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string)interleaved</td>
188</tr>
189</tbody>
190</table></div>
191</div>
192</div>
193</div>
194<div class="refsect1">
195<a name="gst-plugins-good-plugins-equalizer-3bands.functions_details"></a><h2>Functions</h2>
196<p></p>
197</div>
198<div class="refsect1">
199<a name="gst-plugins-good-plugins-equalizer-3bands.other_details"></a><h2>Types and Values</h2>
200<div class="refsect2">
201<a name="GstIirEqualizer3Bands-struct"></a><h3>struct GstIirEqualizer3Bands</h3>
202<pre class="programlisting">struct GstIirEqualizer3Bands;</pre>
203</div>
204</div>
205<div class="refsect1">
206<a name="gst-plugins-good-plugins-equalizer-3bands.property-details"></a><h2>Property Details</h2>
207<div class="refsect2">
208<a name="GstIirEqualizer3Bands--band0"></a><h3>The <code class="literal">“band0”</code> property</h3>
209<pre class="programlisting">  “band0”                    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
210<p>gain for the frequency band 100 Hz, ranging from -24.0 to +12.0.</p>
211<p>Flags: Read / Write</p>
212<p>Allowed values: [-24,12]</p>
213<p>Default value: 0</p>
214</div>
215<hr>
216<div class="refsect2">
217<a name="GstIirEqualizer3Bands--band1"></a><h3>The <code class="literal">“band1”</code> property</h3>
218<pre class="programlisting">  “band1”                    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
219<p>gain for the frequency band 1100 Hz, ranging from -24.0 to +12.0.</p>
220<p>Flags: Read / Write</p>
221<p>Allowed values: [-24,12]</p>
222<p>Default value: 0</p>
223</div>
224<hr>
225<div class="refsect2">
226<a name="GstIirEqualizer3Bands--band2"></a><h3>The <code class="literal">“band2”</code> property</h3>
227<pre class="programlisting">  “band2”                    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
228<p>gain for the frequency band 11 kHz, ranging from -24.0 to +12.0.</p>
229<p>Flags: Read / Write</p>
230<p>Allowed values: [-24,12]</p>
231<p>Default value: 0</p>
232</div>
233</div>
234</div>
235<div class="footer">
236<hr>Generated by GTK-Doc V1.28</div>
237</body>
238</html>