mirror of
https://github.com/thestk/stk
synced 2026-04-20 14:36:55 +00:00
Release 4.2.1 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
11cf5faa0a
commit
21b93795e7
@@ -8,8 +8,8 @@
|
||||
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
|
||||
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
||||
<HR>
|
||||
<!-- Generated by Doxygen 1.3.4 -->
|
||||
<h1>Echo Class Reference</h1><code>#include <<a class="el" href="Echo_8h-source.html">Echo.h</a>></code>
|
||||
<!-- Generated by Doxygen 1.4.4 -->
|
||||
<h1>Echo Class Reference</h1><!-- doxytag: class="Echo" --><!-- doxytag: inherits="Effect" --><code>#include <<a class="el" href="Echo_8h-source.html">Echo.h</a>></code>
|
||||
<p>
|
||||
<p>Inheritance diagram for Echo:
|
||||
<p><center><img src="classEcho.png" usemap="#Echo_map" border="0" alt=""></center>
|
||||
@@ -21,64 +21,50 @@
|
||||
STK echo effect class.
|
||||
<p>
|
||||
This class implements an echo effect.<p>
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
|
||||
<p>
|
||||
|
||||
<p>
|
||||
Definition at line <a class="el" href="Echo_8h-source.html#l00017">17</a> of file <a class="el" href="Echo_8h-source.html">Echo.h</a>.<table border=0 cellpadding=0 cellspacing=0>
|
||||
<table border="0" cellpadding="0" cellspacing="0">
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classEcho.html#a0">Echo</a> (unsigned long maximumDelay=(unsigned long) Stk::sampleRate())</td></tr>
|
||||
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEcho.html#a0">Echo</a> (unsigned long maximumDelay=(unsigned long) Stk::sampleRate())</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the longest desired delay length (one second default value). </em> <a href="#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Echo::~Echo" ></a>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classEcho.html#a1">~Echo</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the longest desired delay length (one second default value). <a href="#a0"></a><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Echo::~Echo" ref="a1" args="()" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classEcho.html#a1">~Echo</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="Echo::clear" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classEcho.html#a2">clear</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="Echo::clear" ref="a2" args="()" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEcho.html#a2">clear</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="Echo::setMaximumDelay" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classEcho.html#a3">setMaximumDelay</a> (unsigned long delay)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Echo::setMaximumDelay" ref="a3" args="(unsigned long delay)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEcho.html#a3">setMaximumDelay</a> (unsigned long delay)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum delay line length in samples. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Echo::setDelay" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classEcho.html#a4">setDelay</a> (unsigned long delay)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum delay line length in samples. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="Echo::setDelay" ref="a4" args="(unsigned long delay)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEcho.html#a4">setDelay</a> (unsigned long delay)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the delay line length in samples. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Echo::tick" ></a>
|
||||
StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classEcho.html#a5">tick</a> (StkFloat input)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute one output sample. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Echo::tick" ></a>
|
||||
StkFloat * </td><td class="memItemRight" valign=bottom><a class="el" href="classEcho.html#a6">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take <em>vectorSize</em> inputs, compute the same number of outputs and return them in <em>vector</em>. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classStkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classEcho.html#a7">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &frames, unsigned int channel=1)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the effect and replace with corresponding outputs. </em> <a href="#a7"></a><em><br><br></td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the delay line length in samples. <br></td></tr>
|
||||
</table>
|
||||
<hr><h2>Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" name="a0" doxytag="Echo::Echo" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<a class="anchor" name="a0"></a><!-- doxytag: member="Echo::Echo" ref="a0" args="(unsigned long maximumDelay=(unsigned long) Stk::sampleRate())" --><p>
|
||||
<table class="mdTable" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> Echo::Echo </td>
|
||||
<td class="md" nowrap valign="top">Echo::Echo </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">unsigned long </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>maximumDelay</em> = (unsigned long) Stk::sampleRate() </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>maximumDelay</em> = <code>(unsigned long) Stk::sampleRate()</code> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<table cellspacing="5" cellpadding="0" border="0">
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@@ -88,50 +74,7 @@ StkFloat * </td><td class="memItemRight" valign=bottom><a class="el" href="
|
||||
<p>
|
||||
Class constructor, taking the longest desired delay length (one second default value).
|
||||
<p>
|
||||
The default delay value is set to 1/2 the maximum delay length. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" name="a7" doxytag="Echo::tick" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> <a class="el" href="classStkFrames.html">StkFrames</a>& Echo::tick </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> & </td>
|
||||
<td class="mdname" nowrap> <em>frames</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>unsigned int </td>
|
||||
<td class="mdname" nowrap> <em>channel</em> = 1</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"><code> [virtual]</code></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the effect and replace with corresponding outputs.
|
||||
<p>
|
||||
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
|
||||
<p>
|
||||
Reimplemented from <a class="el" href="classEffect.html#a9">Effect</a>. </td>
|
||||
The default delay value is set to 1/2 the maximum delay length. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr>The documentation for this class was generated from the following file:<ul>
|
||||
@@ -140,7 +83,7 @@ Reimplemented from <a class="el" href="classEffect.html#a9">Effect</a>. </td>
|
||||
|
||||
<table>
|
||||
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
||||
<tr><td>©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
<tr><td>©1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user