mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
81 lines
7.4 KiB
HTML
81 lines
7.4 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.6.2 -->
|
|
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Sampler.html">Sampler</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Sampler Class Reference</h1><!-- doxytag: class="stk::Sampler" --><!-- doxytag: inherits="stk::Instrmnt" -->
|
|
<p>STK sampling synthesis abstract base class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Sampler_8h_source.html">Sampler.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Sampler:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Sampler.png" usemap="#stk::Sampler_map" alt=""/>
|
|
<map id="stk::Sampler_map" name="stk::Sampler_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,79,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,79,24"/>
|
|
<area href="classstk_1_1Moog.html" alt="stk::Moog" shape="rect" coords="0,168,79,192"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1Sampler-members.html">List of all members.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97dbec0c39f3307560736173b4ede4e1"></a><!-- doxytag: member="stk::Sampler::Sampler" ref="a97dbec0c39f3307560736173b4ede4e1" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sampler.html#a97dbec0c39f3307560736173b4ede4e1">Sampler</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9262914e25d4b9fd28a760621902fd74"></a><!-- doxytag: member="stk::Sampler::~Sampler" ref="a9262914e25d4b9fd28a760621902fd74" args="(void)" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sampler.html#a9262914e25d4b9fd28a760621902fd74">~Sampler</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c80aad733f5e90dfa63d29c6a5c88ac"></a><!-- doxytag: member="stk::Sampler::clear" ref="a6c80aad733f5e90dfa63d29c6a5c88ac" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sampler.html#a6c80aad733f5e90dfa63d29c6a5c88ac">clear</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a746eaab88793e3e8cdac9f6e59e00ca3"></a><!-- doxytag: member="stk::Sampler::setFrequency" ref="a746eaab88793e3e8cdac9f6e59e00ca3" args="(StkFloat frequency)=0" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sampler.html#a746eaab88793e3e8cdac9f6e59e00ca3">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" align="right" valign="top"><a class="anchor" id="ad277ac455b3434eeb21d628d6c70141a"></a><!-- doxytag: member="stk::Sampler::keyOn" ref="ad277ac455b3434eeb21d628d6c70141a" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sampler.html#ad277ac455b3434eeb21d628d6c70141a">keyOn</a> (void)</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" align="right" valign="top"><a class="anchor" id="a808aec2bf546b01e1ef53503c5a164e1"></a><!-- doxytag: member="stk::Sampler::keyOff" ref="a808aec2bf546b01e1ef53503c5a164e1" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sampler.html#a808aec2bf546b01e1ef53503c5a164e1">keyOff</a> (void)</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" align="right" valign="top"><a class="anchor" id="a36c3ed945fb3e8db300b7ae01a4a4a76"></a><!-- doxytag: member="stk::Sampler::noteOff" ref="a36c3ed945fb3e8db300b7ae01a4a4a76" args="(StkFloat amplitude)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sampler.html#a36c3ed945fb3e8db300b7ae01a4a4a76">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" align="right" valign="top"><a class="anchor" id="ad9c0789f033978165226beb7c8133cc3"></a><!-- doxytag: member="stk::Sampler::controlChange" ref="ad9c0789f033978165226beb7c8133cc3" args="(int number, StkFloat value)=0" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sampler.html#ad9c0789f033978165226beb7c8133cc3">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>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08502c96fa3e5f4c853c781354ed1965"></a><!-- doxytag: member="stk::Sampler::tick" ref="a08502c96fa3e5f4c853c781354ed1965" args="(unsigned int channel=0)=0" -->
|
|
virtual StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sampler.html#a08502c96fa3e5f4c853c781354ed1965">tick</a> (unsigned int channel=0)=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>
|
|
<p>STK sampling synthesis abstract base class. </p>
|
|
<p>This instrument provides an <a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> envelope, a one-pole filter, and structures for an arbitrary number of attack and looped files.</p>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
|
<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></li>
|
|
</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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|