1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>audioamplify</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-aspectratiocrop.html" title="aspectratiocrop">
10 <link rel="next" href="gst-plugins-good-plugins-audiochebband.html" title="audiochebband">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="gst-plugins-good-plugins-aspectratiocrop.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-audiochebband.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-good-plugins-audioamplify.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-good-plugins-audioamplify.description" class="shortcut">Description</a>
28 <a href="#gst-plugins-good-plugins-audioamplify.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#gst-plugins-good-plugins-audioamplify.properties" class="shortcut">Properties</a>
33 <div class="refentry">
34 <a name="gst-plugins-good-plugins-audioamplify"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
37 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-audioamplify.top_of_page"></a>audioamplify</span></h2>
38 <p>audioamplify — Amplifies an audio stream by a given factor</p>
40 <td valign="top" align="right"></td>
42 <div class="refsynopsisdiv">
43 <a name="gst-plugins-good-plugins-audioamplify.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstAudioAmplify"></a><pre class="synopsis">struct <a class="link" href="gst-plugins-good-plugins-audioamplify.html#GstAudioAmplify-struct" title="struct GstAudioAmplify">GstAudioAmplify</a>;
47 <div class="refsect1">
48 <a name="gst-plugins-good-plugins-audioamplify.object-hierarchy"></a><h2>Object Hierarchy</h2>
49 <pre class="synopsis">
50 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
51 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
52 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
53 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
54 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter">GstAudioFilter</a>
58 <div class="refsect1">
59 <a name="gst-plugins-good-plugins-audioamplify.properties"></a><h2>Properties</h2>
60 <pre class="synopsis">
61 "<a class="link" href="gst-plugins-good-plugins-audioamplify.html#GstAudioAmplify--amplification" title='The "amplification" property'>amplification</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
62 "<a class="link" href="gst-plugins-good-plugins-audioamplify.html#GstAudioAmplify--clipping-method" title='The "clipping-method" property'>clipping-method</a>" <span class="type">GstAudioPanoramaClippingMethod</span> : Read / Write
65 <div class="refsect1">
66 <a name="gst-plugins-good-plugins-audioamplify.description"></a><h2>Description</h2>
68 Amplifies an audio stream by a given factor and allows the selection of different clipping modes.
69 The difference between the clipping modes is best evaluated by testing.
73 <div class="refsect2">
74 <a name="idp5363600"></a><h3>Example launch line</h3>
75 <div class="informalexample">
76 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
79 <td class="listing_lines" align="right"><pre>1
82 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch audiotestsrc wave<span class="gtkdoc opt">=</span>saw <span class="gtkdoc opt">!</span> audioamplify amplification<span class="gtkdoc opt">=</span><span class="number">1.5</span> <span class="gtkdoc opt">!</span> alsasink
83 gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span><span class="string">"melo1.ogg"</span> <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> vorbisdec <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audioamplify amplification<span class="gtkdoc opt">=</span><span class="number">1.5</span> method<span class="gtkdoc opt">=</span>wrap<span class="gtkdoc opt">-</span>negative <span class="gtkdoc opt">!</span> alsasink
84 gst<span class="gtkdoc opt">-</span>launch audiotestsrc wave<span class="gtkdoc opt">=</span>saw <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audioamplify amplification<span class="gtkdoc opt">=</span><span class="number">1.5</span> method<span class="gtkdoc opt">=</span>wrap<span class="gtkdoc opt">-</span>positive <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink</pre></td>
93 <div class="refsynopsisdiv">
95 <div class="refsect2">
96 <a name="idp8426928"></a><h3>Element Information</h3>
97 <div class="variablelist"><table border="0">
98 <col align="left" valign="top">
101 <td><p><span class="term">plugin</span></p></td>
103 <a class="link" href="gst-plugins-good-plugins-plugin-audiofx.html#plugin-audiofx">audiofx</a>
107 <td><p><span class="term">author</span></p></td>
108 <td>Sebastian Dröge <slomo@circular-chaos.org></td>
111 <td><p><span class="term">class</span></p></td>
112 <td>Filter/Effect/Audio</td>
118 <div class="refsect2">
119 <a name="idp8618992"></a><h3>Element Pads</h3>
120 <div class="variablelist"><table border="0">
121 <col align="left" valign="top">
124 <td><p><span class="term">name</span></p></td>
128 <td><p><span class="term">direction</span></p></td>
132 <td><p><span class="term">presence</span></p></td>
136 <td><p><span class="term">details</span></p></td>
137 <td>audio/x-raw-int, depth=(int)8, width=(int)8, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
140 <td><p><span class="term"></span></p></td>
141 <td> audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
144 <td><p><span class="term"></span></p></td>
145 <td> audio/x-raw-int, depth=(int)32, width=(int)32, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
148 <td><p><span class="term"></span></p></td>
149 <td> audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
153 <div class="variablelist"><table border="0">
154 <col align="left" valign="top">
157 <td><p><span class="term">name</span></p></td>
161 <td><p><span class="term">direction</span></p></td>
165 <td><p><span class="term">presence</span></p></td>
169 <td><p><span class="term">details</span></p></td>
170 <td>audio/x-raw-int, depth=(int)8, width=(int)8, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
173 <td><p><span class="term"></span></p></td>
174 <td> audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
177 <td><p><span class="term"></span></p></td>
178 <td> audio/x-raw-int, depth=(int)32, width=(int)32, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
181 <td><p><span class="term"></span></p></td>
182 <td> audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
191 <div class="refsect1">
192 <a name="gst-plugins-good-plugins-audioamplify.details"></a><h2>Details</h2>
193 <div class="refsect2">
194 <a name="GstAudioAmplify-struct"></a><h3>struct GstAudioAmplify</h3>
195 <pre class="programlisting">struct GstAudioAmplify;</pre>
200 <div class="refsect1">
201 <a name="gst-plugins-good-plugins-audioamplify.property-details"></a><h2>Property Details</h2>
202 <div class="refsect2">
203 <a name="GstAudioAmplify--amplification"></a><h3>The <code class="literal">"amplification"</code> property</h3>
204 <pre class="programlisting"> "amplification" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
205 <p>Factor of amplification.</p>
206 <p>Default value: 1</p>
209 <div class="refsect2">
210 <a name="GstAudioAmplify--clipping-method"></a><h3>The <code class="literal">"clipping-method"</code> property</h3>
211 <pre class="programlisting"> "clipping-method" <span class="type">GstAudioPanoramaClippingMethod</span> : Read / Write</pre>
213 Clipping method: clip mode set values higher than the maximum to the
214 maximum. The wrap-negative mode pushes those values back from the
215 opposite side, wrap-positive pushes them back from the same side.
217 <p>Default value: Normal clipping (default)</p>
223 Generated by GTK-Doc V1.18</div>