mirror of
https://github.com/thestk/stk
synced 2026-01-14 13:31:53 +00:00
91 lines
5.0 KiB
HTML
91 lines
5.0 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"> <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="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.4.4 -->
|
|
<h1>Chorus Class Reference</h1><!-- doxytag: class="Chorus" --><!-- doxytag: inherits="Effect" --><code>#include <<a class="el" href="Chorus_8h-source.html">Chorus.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Chorus:
|
|
<p><center><img src="classChorus.png" usemap="#Chorus_map" border="0" alt=""></center>
|
|
<map name="Chorus_map">
|
|
<area href="classEffect.html" alt="Effect" shape="rect" coords="0,56,53,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,53,24">
|
|
</map>
|
|
<a href="classChorus-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK chorus effect class.
|
|
<p>
|
|
This class implements a chorus effect.<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2007.
|
|
<p>
|
|
<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="classChorus.html#a0">Chorus</a> (StkFloat baseDelay=6000)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the median desired delay length. <a href="#a0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Chorus::~Chorus" ref="a1" args="()" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classChorus.html#a1">~Chorus</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="Chorus::clear" ref="a2" args="()" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChorus.html#a2">clear</a> ()</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="Chorus::setModDepth" ref="a3" args="(StkFloat depth)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChorus.html#a3">setModDepth</a> (StkFloat depth)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set modulation depth. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="Chorus::setModFrequency" ref="a4" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChorus.html#a4">setModFrequency</a> (StkFloat frequency)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set modulation frequency. <br></td></tr>
|
|
</table>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="a0"></a><!-- doxytag: member="Chorus::Chorus" ref="a0" args="(StkFloat baseDelay=6000)" --><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">Chorus::Chorus </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">StkFloat </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>baseDelay</em> = <code>6000</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">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Class constructor, taking the median desired delay length.
|
|
<p>
|
|
An <a class="el" href="classStkError.html">StkError</a> can be thrown if the rawwave path is incorrect. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Chorus_8h-source.html">Chorus.h</a></ul>
|
|
<HR>
|
|
|
|
<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-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|