amuse/classamuse_1_1_effect_delay...

286 lines
14 KiB
HTML
Raw Permalink Normal View History

2016-05-19 06:09:10 +00:00
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Amuse: amuse::EffectDelay 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">Amuse
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</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>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classamuse_1_1_effect_delay.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classamuse_1_1_effect_delay-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">amuse::EffectDelay Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_effect_delay_8hpp_source.html">EffectDelay.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for amuse::EffectDelay:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_effect_delay__inherit__graph.png" border="0" usemap="#amuse_1_1_effect_delay_inherit__map" alt="Inheritance graph"/></div>
<map name="amuse_1_1_effect_delay_inherit__map" id="amuse_1_1_effect_delay_inherit__map">
<area shape="rect" id="node2" href="classamuse_1_1_effect_delay_imp.html" title="{amuse::EffectDelayImp\&lt; T \&gt;\n||+ EffectDelayImp()\l+ applyEffect()\l}" alt="" coords="5,248,203,340"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for amuse::EffectDelay:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_effect_delay__coll__graph.png" border="0" usemap="#amuse_1_1_effect_delay_coll__map" alt="Collaboration graph"/></div>
<map name="amuse_1_1_effect_delay_coll__map" id="amuse_1_1_effect_delay_coll__map">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a9eef638b5ee9e6ebf482563769d4fb8b"><td class="memTemplParams" colspan="2"><a class="anchor" id="a9eef638b5ee9e6ebf482563769d4fb8b"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a9eef638b5ee9e6ebf482563769d4fb8b"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><b>ImpType</b> = <a class="el" href="classamuse_1_1_effect_delay_imp.html">EffectDelayImp</a>&lt; T &gt;</td></tr>
<tr class="separator:a9eef638b5ee9e6ebf482563769d4fb8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:af38887136ffce3c7032b5f0629f40680"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af38887136ffce3c7032b5f0629f40680"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setDelay</b> (uint32_t delay)</td></tr>
<tr class="separator:af38887136ffce3c7032b5f0629f40680"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cb26db788c87d22d8cd59c0841fb113"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cb26db788c87d22d8cd59c0841fb113"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setChanDelay</b> (int chanIdx, uint32_t delay)</td></tr>
<tr class="separator:a6cb26db788c87d22d8cd59c0841fb113"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a683fcdecefb90d183df681b0e2bb000c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a683fcdecefb90d183df681b0e2bb000c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setFeedback</b> (uint32_t feedback)</td></tr>
<tr class="separator:a683fcdecefb90d183df681b0e2bb000c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae89b8e41377fb8365065b69dc94bdbd5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae89b8e41377fb8365065b69dc94bdbd5"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setChanFeedback</b> (int chanIdx, uint32_t feedback)</td></tr>
<tr class="separator:ae89b8e41377fb8365065b69dc94bdbd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f9f4a0870bee44d6e0f1180bc9bf821"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f9f4a0870bee44d6e0f1180bc9bf821"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setOutput</b> (uint32_t output)</td></tr>
<tr class="separator:a7f9f4a0870bee44d6e0f1180bc9bf821"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a0e95979652d1f9b3c32a05866ee534"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a0e95979652d1f9b3c32a05866ee534"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setChanOutput</b> (int chanIdx, uint32_t output)</td></tr>
<tr class="separator:a7a0e95979652d1f9b3c32a05866ee534"><td class="memSeparator" colspan="2">&#160;</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:ade2163d943f5610e6c5f32f1d6398ed2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_effect_delay.html#ade2163d943f5610e6c5f32f1d6398ed2">x3c_delay</a> [8]</td></tr>
<tr class="separator:ade2163d943f5610e6c5f32f1d6398ed2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef905ec7d2212c04f2beb2077fb087df"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_effect_delay.html#aef905ec7d2212c04f2beb2077fb087df">x48_feedback</a> [8]</td></tr>
<tr class="separator:aef905ec7d2212c04f2beb2077fb087df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d04328d834a3996ce31b2d59d04d75a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_effect_delay.html#a9d04328d834a3996ce31b2d59d04d75a">x54_output</a> [8]</td></tr>
<tr class="separator:a9d04328d834a3996ce31b2d59d04d75a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdfb395ee9e7d6cbaf3f432646e4ca2e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_effect_delay.html#acdfb395ee9e7d6cbaf3f432646e4ca2e">m_dirty</a> = true</td></tr>
<tr class="separator:acdfb395ee9e7d6cbaf3f432646e4ca2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Mixes the audio back into itself after specified delay </p>
<p>Definition at line <a class="el" href="_effect_delay_8hpp_source.html#l00015">15</a> of file <a class="el" href="_effect_delay_8hpp_source.html">EffectDelay.hpp</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="acdfb395ee9e7d6cbaf3f432646e4ca2e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool amuse::EffectDelay::m_dirty = true</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>needs update of internal parameter data </p>
<p>Definition at line <a class="el" href="_effect_delay_8hpp_source.html#l00021">21</a> of file <a class="el" href="_effect_delay_8hpp_source.html">EffectDelay.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ade2163d943f5610e6c5f32f1d6398ed2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t amuse::EffectDelay::x3c_delay[8]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>[10, 5000] time in ms of each channel's delay </p>
<p>Definition at line <a class="el" href="_effect_delay_8hpp_source.html#l00018">18</a> of file <a class="el" href="_effect_delay_8hpp_source.html">EffectDelay.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="aef905ec7d2212c04f2beb2077fb087df"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t amuse::EffectDelay::x48_feedback[8]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>[0, 100] percent to mix delayed signal with input signal </p>
<p>Definition at line <a class="el" href="_effect_delay_8hpp_source.html#l00019">19</a> of file <a class="el" href="_effect_delay_8hpp_source.html">EffectDelay.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9d04328d834a3996ce31b2d59d04d75a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t amuse::EffectDelay::x54_output[8]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>[0, 100] total output percent </p>
<p>Definition at line <a class="el" href="_effect_delay_8hpp_source.html#l00020">20</a> of file <a class="el" href="_effect_delay_8hpp_source.html">EffectDelay.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/amuse/<a class="el" href="_effect_delay_8hpp_source.html">EffectDelay.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>amuse</b></li><li class="navelem"><a class="el" href="classamuse_1_1_effect_delay.html">EffectDelay</a></li>
<li class="footer">Generated on Wed May 18 2016 20:05:19 for Amuse by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>