<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audaspace: Effect Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Audaspace
 <span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">A high level audio library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classEffect-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Effect Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This sound is a base class for all effect factories that take one other sound as input.
<a href="classEffect.html#details">More...</a></p>
<p><code>#include <<a class="el" href="Effect_8h_source.html">Effect.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Effect:</div>
<div class="dyncontent">
<div class="center"><img src="classEffect__inherit__graph.png" border="0" usemap="#Effect_inherit__map" alt="Inheritance graph"/></div>
<map name="Effect_inherit__map" id="Effect_inherit__map">
<area shape="rect" title="This sound is a base class for all effect factories that take one other sound as input." alt="" coords="119,360,176,387"/>
<area shape="rect" href="classAccumulator.html" title="This sound creates an accumulator reader." alt="" coords="236,5,335,32"/>
<area shape="rect" href="classADSR.html" title="The ADSR effect implements the Attack-Delay-Sustain-Release behaviour of a sound." alt="" coords="256,56,315,83"/>
<area shape="rect" href="classDelay.html" title="This sound plays another sound delayed." alt="" coords="257,107,313,133"/>
<area shape="rect" href="classDynamicIIRFilter.html" title="This sound creates a IIR filter reader." alt="" coords="224,157,347,184"/>
<area shape="rect" href="classEnvelope.html" title="This sound creates an envelope follower reader." alt="" coords="246,208,325,235"/>
<area shape="rect" href="classFader.html" title="This sound fades another sound." alt="" coords="257,259,314,285"/>
<area shape="rect" href="classIIRFilter.html" title="This sound creates a IIR filter reader." alt="" coords="250,309,321,336"/>
<area shape="rect" href="classLimiter.html" title="This sound limits another sound in start and end time." alt="" coords="253,360,317,387"/>
<area shape="rect" href="classLoop.html" title="This sound loops another sound." alt="" coords="259,411,312,437"/>
<area shape="rect" href="classPingPong.html" title="This sound plays another sound first normal, then reversed." alt="" coords="245,461,326,488"/>
<area shape="rect" href="classPitch.html" title="This sound changes the pitch of another sound." alt="" coords="259,512,311,539"/>
<area shape="rect" href="classReverse.html" title="This sound reads another sound reverted." alt="" coords="251,563,320,589"/>
<area shape="rect" href="classSum.html" title="This sound creates a sum reader." alt="" coords="261,613,310,640"/>
<area shape="rect" href="classThreshold.html" title="This sound Transforms any signal to a square signal by thresholding." alt="" coords="243,664,327,691"/>
<area shape="rect" href="classVolume.html" title="This sound changes the volume of another sound." alt="" coords="251,715,320,741"/>
<area shape="rect" href="classISound.html" title="This class represents a type of sound source and saves the necessary values for it." alt="" coords="5,360,71,387"/>
<area shape="rect" href="classButterworth.html" title="This sound creates a butterworth lowpass filter reader." alt="" coords="395,107,491,133"/>
<area shape="rect" href="classHighpass.html" title="This sound creates a highpass filter reader." alt="" coords="403,157,482,184"/>
<area shape="rect" href="classLowpass.html" title="This sound creates a lowpass filter reader." alt="" coords="405,208,480,235"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad8de39127487ac7e110026805043077a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffect.html#ad8de39127487ac7e110026805043077a">Effect</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound)</td></tr>
<tr class="memdesc:ad8de39127487ac7e110026805043077a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new sound. <a href="#ad8de39127487ac7e110026805043077a">More...</a><br /></td></tr>
<tr class="separator:ad8de39127487ac7e110026805043077a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0f471df484d3ef351b704fef39a7072"><td class="memItemLeft" align="right" valign="top"><a id="ab0f471df484d3ef351b704fef39a7072"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffect.html#ab0f471df484d3ef351b704fef39a7072">~Effect</a> ()</td></tr>
<tr class="memdesc:ab0f471df484d3ef351b704fef39a7072"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the sound. <br /></td></tr>
<tr class="separator:ab0f471df484d3ef351b704fef39a7072"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad513f63dd87ce3d5023b276e8290a2fd"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffect.html#ad513f63dd87ce3d5023b276e8290a2fd">getSound</a> () const</td></tr>
<tr class="memdesc:ad513f63dd87ce3d5023b276e8290a2fd"><td class="mdescLeft"> </td><td class="mdescRight">Returns the saved sound. <a href="#ad513f63dd87ce3d5023b276e8290a2fd">More...</a><br /></td></tr>
<tr class="separator:ad513f63dd87ce3d5023b276e8290a2fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classISound"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classISound')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classISound.html">ISound</a></td></tr>
<tr class="memitem:ad968d59f5fdb16f050b3c74108c693b5 inherit pub_methods_classISound"><td class="memItemLeft" align="right" valign="top"><a id="ad968d59f5fdb16f050b3c74108c693b5"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classISound.html#ad968d59f5fdb16f050b3c74108c693b5">~ISound</a> ()</td></tr>
<tr class="memdesc:ad968d59f5fdb16f050b3c74108c693b5 inherit pub_methods_classISound"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the sound. <br /></td></tr>
<tr class="separator:ad968d59f5fdb16f050b3c74108c693b5 inherit pub_methods_classISound"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a194d09ea3b22f1cb0a49b89cfcf02d63 inherit pub_methods_classISound"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classISound.html#a194d09ea3b22f1cb0a49b89cfcf02d63">createReader</a> ()=0</td></tr>
<tr class="memdesc:a194d09ea3b22f1cb0a49b89cfcf02d63 inherit pub_methods_classISound"><td class="mdescLeft"> </td><td class="mdescRight">Creates a reader for playback of the sound source. <a href="classISound.html#a194d09ea3b22f1cb0a49b89cfcf02d63">More...</a><br /></td></tr>
<tr class="separator:a194d09ea3b22f1cb0a49b89cfcf02d63 inherit pub_methods_classISound"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:acbc6e32d24b20c2f753b9b3fc7026a2d"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffect.html#acbc6e32d24b20c2f753b9b3fc7026a2d">getReader</a> () const</td></tr>
<tr class="memdesc:acbc6e32d24b20c2f753b9b3fc7026a2d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the reader created out of the sound. <a href="#acbc6e32d24b20c2f753b9b3fc7026a2d">More...</a><br /></td></tr>
<tr class="separator:acbc6e32d24b20c2f753b9b3fc7026a2d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:acc48a8fc2f5e83e74deb81b3d220451c"><td class="memItemLeft" align="right" valign="top"><a id="acc48a8fc2f5e83e74deb81b3d220451c"></a>
std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffect.html#acc48a8fc2f5e83e74deb81b3d220451c">m_sound</a></td></tr>
<tr class="memdesc:acc48a8fc2f5e83e74deb81b3d220451c"><td class="mdescLeft"> </td><td class="mdescRight">If there is no reader it is created out of this sound. <br /></td></tr>
<tr class="separator:acc48a8fc2f5e83e74deb81b3d220451c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This sound is a base class for all effect factories that take one other sound as input. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ad8de39127487ac7e110026805043077a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8de39127487ac7e110026805043077a">◆ </a></span>Effect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Effect::Effect </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > </td>
<td class="paramname"><em>sound</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new sound. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sound</td><td>The input sound. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acbc6e32d24b20c2f753b9b3fc7026a2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbc6e32d24b20c2f753b9b3fc7026a2d">◆ </a></span>getReader()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr<<a class="el" href="classIReader.html">IReader</a>> Effect::getReader </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the reader created out of the sound. </p>
<p>This method can be used for the createReader function of the implementing classes. </p><dl class="section return"><dt>Returns</dt><dd>The reader created out of the sound. </dd></dl>
</div>
</div>
<a id="ad513f63dd87ce3d5023b276e8290a2fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad513f63dd87ce3d5023b276e8290a2fd">◆ </a></span>getSound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr<<a class="el" href="classISound.html">ISound</a>> Effect::getSound </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the saved sound. </p>
<dl class="section return"><dt>Returns</dt><dd>The sound or nullptr if there has no sound been saved. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>fx/<a class="el" href="Effect_8h_source.html">Effect.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
948
