mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
74 lines
5.6 KiB
HTML
74 lines
5.6 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>Sampler Class Reference</h1><!-- doxytag: class="Sampler" --><!-- doxytag: inherits="Instrmnt" --><code>#include <<a class="el" href="Sampler_8h-source.html">Sampler.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Sampler:
|
|
<p><center><img src="classSampler.png" usemap="#Sampler_map" border="0" alt=""></center>
|
|
<map name="Sampler_map">
|
|
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,58,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,58,24">
|
|
<area href="classMoog.html" alt="Moog" shape="rect" coords="0,168,58,192">
|
|
</map>
|
|
<a href="classSampler-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK sampling synthesis abstract base class.
|
|
<p>
|
|
This instrument provides an <a class="el" href="classADSR.html">ADSR</a> envelope, a one-pole filter, and structures for an arbitrary number of attack and loop waves.<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"><a class="anchor" name="a0"></a><!-- doxytag: member="Sampler::Sampler" ref="a0" args="()" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#a0">Sampler</a> ()</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="Sampler::~Sampler" ref="a1" args="()" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#a1">~Sampler</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="Sampler::clear" ref="a2" args="()" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.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="Sampler::setFrequency" ref="a3" args="(StkFloat frequency)=0" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#a3">setFrequency</a> (StkFloat frequency)=0</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="a4"></a><!-- doxytag: member="Sampler::keyOn" ref="a4" args="()" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#a4">keyOn</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initiate the envelopes with a key-on event and reset the attack waves. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="Sampler::keyOff" ref="a5" args="()" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#a5">keyOff</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal a key-off event to the envelopes. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="Sampler::noteOff" ref="a6" args="(StkFloat amplitude)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#a6">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="a7"></a><!-- doxytag: member="Sampler::controlChange" ref="a7" args="(int number, StkFloat value)=0" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#a7">controlChange</a> (int number, StkFloat value)=0</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>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Sampler_8h-source.html">Sampler.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>
|