mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
117 lines
8.8 KiB
HTML
117 lines
8.8 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.5.8 -->
|
|
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Simple.html">Simple</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Simple Class Reference</h1><!-- doxytag: class="stk::Simple" --><!-- doxytag: inherits="stk::Instrmnt" -->STK wavetable/noise instrument.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Simple_8h-source.html">Simple.h</a>></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Simple:</div>
|
|
<div class="dynsection">
|
|
|
|
<p><center><img src="classstk_1_1Simple.png" usemap="#stk::Simple_map" border="0" alt=""></center>
|
|
<map name="stk::Simple_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,76,80">
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,76,24">
|
|
</map>
|
|
</div>
|
|
|
|
<p>
|
|
<a href="classstk_1_1Simple-members.html">List of all members.</a><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="classstk_1_1Simple.html#7fae7f883b6180e7d07c9e06b62e1283">Simple</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <a href="#7fae7f883b6180e7d07c9e06b62e1283"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fc1b20b362b5902d8a47ea889144601"></a><!-- doxytag: member="stk::Simple::~Simple" ref="7fc1b20b362b5902d8a47ea889144601" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Simple.html#7fc1b20b362b5902d8a47ea889144601">~Simple</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="8281297483ef2363a01590722dd739d8"></a><!-- doxytag: member="stk::Simple::clear" ref="8281297483ef2363a01590722dd739d8" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Simple.html#8281297483ef2363a01590722dd739d8">clear</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear internal states. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2dcec630c97fdafb2ba75e74194540d"></a><!-- doxytag: member="stk::Simple::setFrequency" ref="a2dcec630c97fdafb2ba75e74194540d" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Simple.html#a2dcec630c97fdafb2ba75e74194540d">setFrequency</a> (StkFloat frequency)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="44650c4b65de79d4bf0b04b908c207b2"></a><!-- doxytag: member="stk::Simple::keyOn" ref="44650c4b65de79d4bf0b04b908c207b2" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Simple.html#44650c4b65de79d4bf0b04b908c207b2">keyOn</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start envelope toward "on" target. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4183bd057f8bf3783c8b1812f3459d32"></a><!-- doxytag: member="stk::Simple::keyOff" ref="4183bd057f8bf3783c8b1812f3459d32" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Simple.html#4183bd057f8bf3783c8b1812f3459d32">keyOff</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start envelope toward "off" target. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eba26edadfba0dfe0f21834bd730fdad"></a><!-- doxytag: member="stk::Simple::noteOn" ref="eba26edadfba0dfe0f21834bd730fdad" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Simple.html#eba26edadfba0dfe0f21834bd730fdad">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given frequency and amplitude. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6fbdaba299b3733b7e81ec4de5073350"></a><!-- doxytag: member="stk::Simple::noteOff" ref="6fbdaba299b3733b7e81ec4de5073350" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Simple.html#6fbdaba299b3733b7e81ec4de5073350">noteOff</a> (StkFloat amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd14d5368545f5650aeebbbdad65fc52"></a><!-- doxytag: member="stk::Simple::controlChange" ref="cd14d5368545f5650aeebbbdad65fc52" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Simple.html#cd14d5368545f5650aeebbbdad65fc52">controlChange</a> (int number, StkFloat value)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a65326847f8b693f7b5549d18df6e882"></a><!-- doxytag: member="stk::Simple::tick" ref="a65326847f8b693f7b5549d18df6e882" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Simple.html#a65326847f8b693f7b5549d18df6e882">tick</a> (unsigned int channel=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK wavetable/noise instrument.
|
|
<p>
|
|
This class combines a looped wave, a noise source, a biquad resonance filter, a one-pole filter, and an <a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> envelope to create some interesting sounds.<p>
|
|
Control Change Numbers:<ul>
|
|
<li><a class="el" href="classstk_1_1Filter.html" title="STK abstract filter class.">Filter</a> Pole Position = 2</li><li>Noise/Pitched Cross-Fade = 4</li><li><a class="el" href="classstk_1_1Envelope.html" title="STK linear line envelope class.">Envelope</a> Rate = 11</li><li>Gain = 128</li></ul>
|
|
<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="7fae7f883b6180e7d07c9e06b62e1283"></a><!-- doxytag: member="stk::Simple::Simple" ref="7fae7f883b6180e7d07c9e06b62e1283" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">stk::Simple::Simple </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Class constructor.
|
|
<p>
|
|
An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if the rawwave path is incorrectly set.
|
|
</div>
|
|
</div><p>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Simple_8h-source.html">Simple.h</a></ul>
|
|
</div>
|
|
<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-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|