e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-21 06:56:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.4.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:48:48 +02:00
committed by Stephen Sinclair
parent c37de52787
commit 7fcf920d3e
711 changed files with 28790 additions and 16452 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
doc/html/classstk_1_1Drummer.html
View File

@@ -8,63 +8,58 @@
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.5.8 -->
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Drummer.html">Drummer</a>
</div>
<div class="contents">
<h1>stk::Drummer Class Reference</h1><!-- doxytag: class="stk::Drummer" --><!-- doxytag: inherits="stk::Instrmnt" -->STK drum sample player class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Drummer_8h-source.html">Drummer.h</a>&gt;</code>
<p>
<h1>stk::Drummer Class Reference</h1><!-- doxytag: class="stk::Drummer" --><!-- doxytag: inherits="stk::Instrmnt" -->
<p>STK drum sample player class.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Drummer_8h_source.html">Drummer.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::Drummer:</div>
<div class="dynsection">
<p><center><img src="classstk_1_1Drummer.png" usemap="#stk::Drummer_map" border="0" alt=""></center>
<map name="stk::Drummer_map">
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,84,80">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,84,24">
<div class="center">
<img src="classstk_1_1Drummer.png" usemap="#stk::Drummer_map" alt=""/>
<map id="stk::Drummer_map" name="stk::Drummer_map">
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,84,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,84,24"/>
</map>
</div>
</div>
<p>
<a href="classstk_1_1Drummer-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Drummer.html#f5262dd2b29ae453323c0a514d79d26a">Drummer</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <a href="#f5262dd2b29ae453323c0a514d79d26a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="365fb4b2c501129f2efd6edfad1f5453"></a><!-- doxytag: member="stk::Drummer::~Drummer" ref="365fb4b2c501129f2efd6edfad1f5453" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Drummer.html#365fb4b2c501129f2efd6edfad1f5453">~Drummer</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Drummer.html#5ea03a0ef9a3db02942799b5cbca2ea2">noteOn</a> (StkFloat instrument, StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note with the given drum type and amplitude. <a href="#5ea03a0ef9a3db02942799b5cbca2ea2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a735313fbdf7f1201fcb167874ecc7cc"></a><!-- doxytag: member="stk::Drummer::noteOff" ref="a735313fbdf7f1201fcb167874ecc7cc" args="(StkFloat amplitude)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Drummer.html#a735313fbdf7f1201fcb167874ecc7cc">noteOff</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="d65c63bfad0ffac03db7f56cf706e4ba"></a><!-- doxytag: member="stk::Drummer::tick" ref="d65c63bfad0ffac03db7f56cf706e4ba" args="(unsigned int channel=0)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Drummer.html#d65c63bfad0ffac03db7f56cf706e4ba">tick</a> (unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute and return one output sample. <br></td></tr>
<p><a href="classstk_1_1Drummer-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Drummer.html#af5262dd2b29ae453323c0a514d79d26a">Drummer</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <a href="#af5262dd2b29ae453323c0a514d79d26a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a365fb4b2c501129f2efd6edfad1f5453"></a><!-- doxytag: member="stk::Drummer::~Drummer" ref="a365fb4b2c501129f2efd6edfad1f5453" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Drummer.html#a365fb4b2c501129f2efd6edfad1f5453">~Drummer</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Drummer.html#a5ea03a0ef9a3db02942799b5cbca2ea2">noteOn</a> (StkFloat instrument, StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note with the given drum type and amplitude. <a href="#a5ea03a0ef9a3db02942799b5cbca2ea2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa735313fbdf7f1201fcb167874ecc7cc"></a><!-- doxytag: member="stk::Drummer::noteOff" ref="aa735313fbdf7f1201fcb167874ecc7cc" args="(StkFloat amplitude)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Drummer.html#aa735313fbdf7f1201fcb167874ecc7cc">noteOff</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="ad65c63bfad0ffac03db7f56cf706e4ba"></a><!-- doxytag: member="stk::Drummer::tick" ref="ad65c63bfad0ffac03db7f56cf706e4ba" args="(unsigned int channel=0)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Drummer.html#ad65c63bfad0ffac03db7f56cf706e4ba">tick</a> (unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute and return one output sample. <br/></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK drum sample player class.
<p>
This class implements a drum sampling synthesizer using <a class="el" href="classstk_1_1WvIn.html" title="STK audio input abstract base class.">WvIn</a> objects and one-pole filters. The drum rawwave files are sampled at 22050 Hz, but will be appropriately interpolated for other sample rates. You can specify the maximum polyphony (maximum number of simultaneous voices) via a define in the <a class="el" href="Drummer_8h-source.html">Drummer.h</a>.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="f5262dd2b29ae453323c0a514d79d26a"></a><!-- doxytag: member="stk::Drummer::Drummer" ref="f5262dd2b29ae453323c0a514d79d26a" args="(void)" -->
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK drum sample player class. </p>
<p>This class implements a drum sampling synthesizer using <a class="el" href="classstk_1_1WvIn.html" title="STK audio input abstract base class.">WvIn</a> objects and one-pole filters. The drum rawwave files are sampled at 22050 Hz, but will be appropriately interpolated for other sample rates. You can specify the maximum polyphony (maximum number of simultaneous voices) via a define in the <a class="el" href="Drummer_8h_source.html">Drummer.h</a>.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af5262dd2b29ae453323c0a514d79d26a"></a><!-- doxytag: member="stk::Drummer::Drummer" ref="af5262dd2b29ae453323c0a514d79d26a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">stk::Drummer::Drummer </td>
<td class="memname">stk::Drummer::Drummer </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"> </td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
@@ -72,19 +67,18 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Constructor &amp; Des
</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.
<p>Class constructor. </p>
<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. </p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5ea03a0ef9a3db02942799b5cbca2ea2"></a><!-- doxytag: member="stk::Drummer::noteOn" ref="5ea03a0ef9a3db02942799b5cbca2ea2" args="(StkFloat instrument, StkFloat amplitude)" -->
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5ea03a0ef9a3db02942799b5cbca2ea2"></a><!-- doxytag: member="stk::Drummer::noteOn" ref="a5ea03a0ef9a3db02942799b5cbca2ea2" args="(StkFloat instrument, StkFloat amplitude)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::Drummer::noteOn </td>
<td class="memname">void stk::Drummer::noteOn </td>
<td>(</td>
<td class="paramtype">StkFloat&nbsp;</td>
<td class="paramname"> <em>instrument</em>, </td>
@@ -104,22 +98,22 @@ An <a class="el" href="classstk_1_1StkError.html" title="STK error handling clas
</div>
<div class="memdoc">
<p>
Start a note with the given drum type and amplitude.
<p>
Use general MIDI drum instrument numbers, converted to frequency values as if MIDI note numbers, to select a particular instrument. 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.
<p>Implements <a class="el" href="classstk_1_1Instrmnt.html#0736ccd253b446660938d51909a32f44">stk::Instrmnt</a>.</p>
<p>Start a note with the given drum type and amplitude. </p>
<p>Use general MIDI drum instrument numbers, converted to frequency values as if MIDI note numbers, to select a particular instrument. 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. </p>
<p>Implements <a class="el" href="classstk_1_1Instrmnt.html#a0736ccd253b446660938d51909a32f44">stk::Instrmnt</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Drummer_8h-source.html">Drummer.h</a></ul>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Drummer_8h_source.html">Drummer.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>&copy;1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>