Files
stk/doc/html/classEcho.html
2013-09-29 23:35:44 +02:00

67 lines
4.3 KiB
HTML

<HTML>
<HEAD>
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>Echo Class Reference</h1>STK echo effect class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Echo_8h-source.html">Echo.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Echo::
<p><center><img src="classEcho.gif" usemap="#Echo_map" border="0"></center>
<map name="Echo_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,41,24">
</map>
<a href="classEcho-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="Echo::Echo"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classEcho.html#a0">Echo</a> (MY_FLOAT longestDelay)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class constructor, taking the longest desired delay length.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Echo::~Echo"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classEcho.html#a1">~Echo</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="Echo::clear"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classEcho.html#a2">clear</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Reset and clear all internal state.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Echo::setDelay"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classEcho.html#a3">setDelay</a> (MY_FLOAT delay)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the delay line length in samples.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Echo::setEffectMix"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classEcho.html#a4">setEffectMix</a> (MY_FLOAT mix)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the mixture of input and processed levels in the output (0.0 = input only, 1.0 = processed only).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Echo::lastOut"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classEcho.html#a5">lastOut</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the last output value.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Echo::tick"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classEcho.html#a6">tick</a> (MY_FLOAT input)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Compute one output sample.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Echo::tick"></a>
MY_FLOAT*&nbsp;</td><td valign=bottom><a class="el" href="classEcho.html#a7">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Input <em>vectorSize</em> samples to the filter and return an equal number of outputs in <em>vector</em>.</em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK echo effect class.
<p>
This class implements a echo effect.
<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Echo_8h-source.html">Echo.h</a></ul>
<HR>
<table>
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>