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>audioamplify: 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-asteriskh263.html" title="asteriskh263"> 10<link rel="next" href="gst-plugins-good-plugins-audiochebband.html" title="audiochebband"> 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-audioamplify.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-good-plugins-audioamplify.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-good-plugins-audioamplify.properties" class="shortcut">Properties</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-good-plugins-asteriskh263.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-good-plugins-audiochebband.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="gst-plugins-good-plugins-audioamplify"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-audioamplify.top_of_page"></a>audioamplify</span></h2> 32<p>audioamplify</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="gst-plugins-good-plugins-audioamplify.properties"></a><h2>Properties</h2> 38<div class="informaltable"><table class="informaltable" border="0"> 39<colgroup> 40<col width="150px" class="properties_type"> 41<col width="300px" class="properties_name"> 42<col width="200px" class="properties_flags"> 43</colgroup> 44<tbody> 45<tr> 46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-good-plugins-audioamplify.html#GstAudioAmplify--amplification" title="The “amplification” property">amplification</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"><span class="type">GstAudioAmplifyClippingMethod</span></td> 52<td class="property_name"><a class="link" href="gst-plugins-good-plugins-audioamplify.html#GstAudioAmplify--clipping-method" title="The “clipping-method” property">clipping-method</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55</tbody> 56</table></div> 57</div> 58<a name="GstAudioAmplify"></a><div class="refsect1"> 59<a name="gst-plugins-good-plugins-audioamplify.other"></a><h2>Types and Values</h2> 60<div class="informaltable"><table class="informaltable" width="100%" border="0"> 61<colgroup> 62<col width="150px" class="name"> 63<col class="description"> 64</colgroup> 65<tbody><tr> 66<td class="datatype_keyword">struct</td> 67<td class="function_name"><a class="link" href="gst-plugins-good-plugins-audioamplify.html#GstAudioAmplify-struct" title="struct GstAudioAmplify">GstAudioAmplify</a></td> 68</tr></tbody> 69</table></div> 70</div> 71<div class="refsect1"> 72<a name="gst-plugins-good-plugins-audioamplify.object-hierarchy"></a><h2>Object Hierarchy</h2> 73<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 74 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 75 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 76 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 77 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 78 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstAudioFilter.html#GstAudioFilter-struct">GstAudioFilter</a> 79 <span class="lineart">╰──</span> GstAudioAmplify 80</pre> 81</div> 82<div class="refsect1"> 83<a name="gst-plugins-good-plugins-audioamplify.description"></a><h2>Description</h2> 84<p>Amplifies an audio stream by a given factor and allows the selection of different clipping modes. 85The difference between the clipping modes is best evaluated by testing.</p> 86<div class="refsect2"> 87<a name="id-1.2.16.7.3"></a><h3>Example launch line</h3> 88<div class="informalexample"> 89 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 90 <tbody> 91 <tr> 92 <td class="listing_lines" align="right"><pre>1 932 943</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> 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 96gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> 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> clipping<span class="gtkdoc opt">-</span>method<span class="gtkdoc opt">=</span>wrap<span class="gtkdoc opt">-</span>negative <span class="gtkdoc opt">!</span> alsasink 97gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> 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> clipping<span class="gtkdoc opt">-</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> 98 </tr> 99 </tbody> 100 </table> 101</div> 102 103</div> 104<div class="refsynopsisdiv"> 105<h2>Synopsis</h2> 106<div class="refsect2"> 107<a name="id-1.2.16.7.4.1"></a><h3>Element Information</h3> 108<div class="variablelist"><table border="0" class="variablelist"> 109<colgroup> 110<col align="left" valign="top"> 111<col> 112</colgroup> 113<tbody> 114<tr> 115<td><p><span class="term">plugin</span></p></td> 116<td> 117 <a class="link" href="gst-plugins-good-plugins-plugin-audiofx.html#plugin-audiofx">audiofx</a> 118 </td> 119</tr> 120<tr> 121<td><p><span class="term">author</span></p></td> 122<td>Sebastian Dröge <slomo@circular-chaos.org></td> 123</tr> 124<tr> 125<td><p><span class="term">class</span></p></td> 126<td>Filter/Effect/Audio</td> 127</tr> 128</tbody> 129</table></div> 130</div> 131<hr> 132<div class="refsect2"> 133<a name="id-1.2.16.7.4.2"></a><h3>Element Pads</h3> 134<div class="variablelist"><table border="0" class="variablelist"> 135<colgroup> 136<col align="left" valign="top"> 137<col> 138</colgroup> 139<tbody> 140<tr> 141<td><p><span class="term">name</span></p></td> 142<td>sink</td> 143</tr> 144<tr> 145<td><p><span class="term">direction</span></p></td> 146<td>sink</td> 147</tr> 148<tr> 149<td><p><span class="term">presence</span></p></td> 150<td>always</td> 151</tr> 152<tr> 153<td><p><span class="term">details</span></p></td> 154<td>audio/x-raw, format=(string){ S8, S16LE, S32LE, F32LE, F64LE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string){ interleaved, non-interleaved }</td> 155</tr> 156</tbody> 157</table></div> 158<div class="variablelist"><table border="0" class="variablelist"> 159<colgroup> 160<col align="left" valign="top"> 161<col> 162</colgroup> 163<tbody> 164<tr> 165<td><p><span class="term">name</span></p></td> 166<td>src</td> 167</tr> 168<tr> 169<td><p><span class="term">direction</span></p></td> 170<td>source</td> 171</tr> 172<tr> 173<td><p><span class="term">presence</span></p></td> 174<td>always</td> 175</tr> 176<tr> 177<td><p><span class="term">details</span></p></td> 178<td>audio/x-raw, format=(string){ S8, S16LE, S32LE, F32LE, F64LE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string){ interleaved, non-interleaved }</td> 179</tr> 180</tbody> 181</table></div> 182</div> 183</div> 184</div> 185<div class="refsect1"> 186<a name="gst-plugins-good-plugins-audioamplify.functions_details"></a><h2>Functions</h2> 187<p></p> 188</div> 189<div class="refsect1"> 190<a name="gst-plugins-good-plugins-audioamplify.other_details"></a><h2>Types and Values</h2> 191<div class="refsect2"> 192<a name="GstAudioAmplify-struct"></a><h3>struct GstAudioAmplify</h3> 193<pre class="programlisting">struct GstAudioAmplify;</pre> 194</div> 195</div> 196<div class="refsect1"> 197<a name="gst-plugins-good-plugins-audioamplify.property-details"></a><h2>Property Details</h2> 198<div class="refsect2"> 199<a name="GstAudioAmplify--amplification"></a><h3>The <code class="literal">“amplification”</code> property</h3> 200<pre class="programlisting"> “amplification” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 201<p>Factor of amplification.</p> 202<p>Flags: Read / Write</p> 203<p>Default value: 1</p> 204</div> 205<hr> 206<div class="refsect2"> 207<a name="GstAudioAmplify--clipping-method"></a><h3>The <code class="literal">“clipping-method”</code> property</h3> 208<pre class="programlisting"> “clipping-method” <span class="type">GstAudioAmplifyClippingMethod</span></pre> 209<p>Clipping method: clip mode set values higher than the maximum to the 210maximum. The wrap-negative mode pushes those values back from the 211opposite side, wrap-positive pushes them back from the same side.</p> 212<p>Flags: Read / Write</p> 213<p>Default value: Normal clipping (default)</p> 214</div> 215</div> 216</div> 217<div class="footer"> 218<hr>Generated by GTK-Doc V1.28</div> 219</body> 220</html>
