mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
106 lines
9.0 KiB
HTML
106 lines
9.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>ADSR Class Reference</h1><!-- doxytag: class="ADSR" --><!-- doxytag: inherits="Envelope" --><code>#include <<a class="el" href="ADSR_8h-source.html">ADSR.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for ADSR:
|
|
<p><center><img src="classADSR.png" usemap="#ADSR_map" border="0" alt=""></center>
|
|
<map name="ADSR_map">
|
|
<area href="classEnvelope.html" alt="Envelope" shape="rect" coords="0,112,69,136">
|
|
<area href="classGenerator.html" alt="Generator" shape="rect" coords="0,56,69,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,69,24">
|
|
</map>
|
|
<a href="classADSR-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK ADSR envelope class.
|
|
<p>
|
|
This <a class="el" href="classEnvelope.html">Envelope</a> subclass implements a traditional ADSR (Attack, Decay, Sustain, Release) envelope. It responds to simple keyOn and keyOff messages, keeping track of its state. The <em>state</em> = ADSR::DONE after the envelope value reaches 0.0 in the ADSR::RELEASE state.<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 Types</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classEnvelope.html">Envelope</a> states. <br></td></tr>
|
|
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="ADSR::ADSR" ref="a0" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a0">ADSR</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="ADSR::~ADSR" ref="a1" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a1">~ADSR</a> (void)</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="ADSR::keyOn" ref="a2" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a2">keyOn</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set target = 1, state = <em>ADSR::ATTACK</em>. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="ADSR::keyOff" ref="a3" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a3">keyOff</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set target = 0, state = <em>ADSR::RELEASE</em>. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="ADSR::setAttackRate" ref="a4" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a4">setAttackRate</a> (StkFloat rate)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the attack rate. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="ADSR::setDecayRate" ref="a5" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a5">setDecayRate</a> (StkFloat rate)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the decay rate. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="ADSR::setSustainLevel" ref="a6" args="(StkFloat level)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a6">setSustainLevel</a> (StkFloat level)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the sustain level. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7"></a><!-- doxytag: member="ADSR::setReleaseRate" ref="a7" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a7">setReleaseRate</a> (StkFloat rate)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the release rate. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="ADSR::setAttackTime" ref="a8" args="(StkFloat time)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a8">setAttackTime</a> (StkFloat time)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the attack rate based on a time duration. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9"></a><!-- doxytag: member="ADSR::setDecayTime" ref="a9" args="(StkFloat time)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a9">setDecayTime</a> (StkFloat time)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the decay rate based on a time duration. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10"></a><!-- doxytag: member="ADSR::setReleaseTime" ref="a10" args="(StkFloat time)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a10">setReleaseTime</a> (StkFloat time)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the release rate based on a time duration. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11"></a><!-- doxytag: member="ADSR::setAllTimes" ref="a11" args="(StkFloat aTime, StkFloat dTime, StkFloat sLevel, StkFloat rTime)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a11">setAllTimes</a> (StkFloat aTime, StkFloat dTime, StkFloat sLevel, StkFloat rTime)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set sustain level and attack, decay, and release time durations. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12"></a><!-- doxytag: member="ADSR::setTarget" ref="a12" args="(StkFloat target)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a12">setTarget</a> (StkFloat target)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the target value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13"></a><!-- doxytag: member="ADSR::getState" ref="a13" args="(void) const " -->
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a13">getState</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current envelope <em>state</em> (ATTACK, DECAY, SUSTAIN, RELEASE, DONE). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14"></a><!-- doxytag: member="ADSR::setValue" ref="a14" args="(StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classADSR.html#a14">setValue</a> (StkFloat value)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set to state = ADSR::SUSTAIN with current and target values of <em>aValue</em>. <br></td></tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="ADSR_8h-source.html">ADSR.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>
|