<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Async: Async::AudioAmp Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceAsync.html">Async</a>::<a class="el" href="classAsync_1_1AudioAmp.html">AudioAmp</a>
</div>
</div>
<div class="contents">
<h1>Async::AudioAmp Class Reference</h1><!-- doxytag: class="Async::AudioAmp" --><!-- doxytag: inherits="Async::AudioProcessor" -->
<p>An audio pipe class for amplification/attenuation of an audio stream.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="AsyncAudioAmp_8h_source.html">AsyncAudioAmp.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Async::AudioAmp:</div>
<div class="dynsection">
<div class="center">
<img src="classAsync_1_1AudioAmp.png" usemap="#Async::AudioAmp_map" alt=""/>
<map id="Async::AudioAmp_map" name="Async::AudioAmp_map">
<area href="classAsync_1_1AudioProcessor.html" alt="Async::AudioProcessor" shape="rect" coords="77,56,222,80"/>
<area href="classAsync_1_1AudioSink.html" alt="Async::AudioSink" shape="rect" coords="0,0,145,24"/>
<area href="classAsync_1_1AudioSource.html" alt="Async::AudioSource" shape="rect" coords="155,0,300,24"/>
</map>
</div>
</div>
<p><a href="classAsync_1_1AudioAmp-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classAsync_1_1AudioAmp.html#a40781b4768738d84f786b183339ae43e">AudioAmp</a> (void)
<dl class="el"><dd class="mdescRight">Default constuctor. <a href="#a40781b4768738d84f786b183339ae43e"></a><br/></dl><li><a class="el" href="classAsync_1_1AudioAmp.html#a7ed6ad83f1c4a67a9989cdc76eec4498">~AudioAmp</a> (void)
<dl class="el"><dd class="mdescRight">Destructor. <a href="#a7ed6ad83f1c4a67a9989cdc76eec4498"></a><br/></dl><li>void <a class="el" href="classAsync_1_1AudioAmp.html#adab176975efc5e32c7ae25e8ce1309ca">setGain</a> (float gain_db)
<dl class="el"><dd class="mdescRight">Set the gain to use. <a href="#adab176975efc5e32c7ae25e8ce1309ca"></a><br/></dl><li>float <a class="el" href="classAsync_1_1AudioAmp.html#af815357013b60721bdd683a5fc35cac7">gain</a> (void) const
<dl class="el"><dd class="mdescRight">Read the gain. <a href="#af815357013b60721bdd683a5fc35cac7"></a><br/></dl></ul>
<h2>Protected Member Functions</h2>
<ul>
<li>void <a class="el" href="classAsync_1_1AudioAmp.html#aa2a8e1111bd6b6c555e73fc2fa0561a4">processSamples</a> (float *dest, const float *src, int count)
<dl class="el"><dd class="mdescRight">Process incoming samples and put them into the output buffer. <a href="#aa2a8e1111bd6b6c555e73fc2fa0561a4"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An audio pipe class for amplification/attenuation of an audio stream. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Tobias Blomberg / SM0SVX </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2006-07-08</dd></dl>
<p>Use this class to amplify or attenuate an audio stream. </p>
<p>Definition at line <a class="el" href="AsyncAudioAmp_8h_source.html#l00112">112</a> of file <a class="el" href="AsyncAudioAmp_8h_source.html">AsyncAudioAmp.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a40781b4768738d84f786b183339ae43e"></a><!-- doxytag: member="Async::AudioAmp::AudioAmp" ref="a40781b4768738d84f786b183339ae43e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioAmp::AudioAmp </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constuctor. </p>
<p>Definition at line <a class="el" href="AsyncAudioAmp_8h_source.html#l00118">118</a> of file <a class="el" href="AsyncAudioAmp_8h_source.html">AsyncAudioAmp.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7ed6ad83f1c4a67a9989cdc76eec4498"></a><!-- doxytag: member="Async::AudioAmp::~AudioAmp" ref="a7ed6ad83f1c4a67a9989cdc76eec4498" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioAmp::~AudioAmp </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="AsyncAudioAmp_8h_source.html#l00123">123</a> of file <a class="el" href="AsyncAudioAmp_8h_source.html">AsyncAudioAmp.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af815357013b60721bdd683a5fc35cac7"></a><!-- doxytag: member="Async::AudioAmp::gain" ref="af815357013b60721bdd683a5fc35cac7" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Async::AudioAmp::gain </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read the gain. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Return the gain in dB </dd></dl>
<p>Definition at line <a class="el" href="AsyncAudioAmp_8h_source.html#l00135">135</a> of file <a class="el" href="AsyncAudioAmp_8h_source.html">AsyncAudioAmp.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa2a8e1111bd6b6c555e73fc2fa0561a4"></a><!-- doxytag: member="Async::AudioAmp::processSamples" ref="aa2a8e1111bd6b6c555e73fc2fa0561a4" args="(float *dest, const float *src, int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Async::AudioAmp::processSamples </td>
<td>(</td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Process incoming samples and put them into the output buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>Source buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>Number of samples in the source buffer</td></tr>
</table>
</dd>
</dl>
<p>This function should be reimplemented by the inheriting class to do the actual processing of the incoming samples. All samples must be processed, otherwise they are lost and the output buffer will contain garbage. </p>
<p>Implements <a class="el" href="classAsync_1_1AudioProcessor.html#a2d7e4ec25a7bd6a9c5c20ae35c1adee3">Async::AudioProcessor</a>.</p>
<p>Definition at line <a class="el" href="AsyncAudioAmp_8h_source.html#l00139">139</a> of file <a class="el" href="AsyncAudioAmp_8h_source.html">AsyncAudioAmp.h</a>.</p>
</div>
</div>
<a class="anchor" id="adab176975efc5e32c7ae25e8ce1309ca"></a><!-- doxytag: member="Async::AudioAmp::setGain" ref="adab176975efc5e32c7ae25e8ce1309ca" args="(float gain_db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Async::AudioAmp::setGain </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>gain_db</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the gain to use. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>gain_db</em> </td><td>The gain given in dB </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="AsyncAudioAmp_8h_source.html#l00129">129</a> of file <a class="el" href="AsyncAudioAmp_8h_source.html">AsyncAudioAmp.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="AsyncAudioAmp_8h_source.html">AsyncAudioAmp.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
os
>
by-pkgid
>
9c481c872fb0ae0cbadccdc2f4a18ab6
>
files
>
136
