e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-19 15:41:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.1.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:37:27 +02:00
committed by Stephen Sinclair
parent d12ef806ac
commit 5d63b50e85
436 changed files with 17966 additions and 14506 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
doc/html/classDrummer.html
View File

@@ -5,64 +5,74 @@
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
<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="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>Drummer Class Reference</h1>STK drum sample player class.
<!-- Generated by Doxygen 1.3.6 -->
<h1>Drummer Class Reference</h1>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>
<p>Inheritance diagram for Drummer::
<p><center><img src="classDrummer.gif" usemap="#Drummer_map" border="0"></center>
<p>Inheritance diagram for Drummer:
<p><center><img src="classDrummer.png" usemap="#Drummer_map" border="0" alt=""></center>
<map name="Drummer_map">
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,63,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,63,24">
</map>
<a href="classDrummer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="Drummer::Drummer"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classDrummer.html#a0">Drummer</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class constructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Drummer::~Drummer"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classDrummer.html#a1">~Drummer</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classDrummer.html#a2">noteOn</a> (MY_FLOAT instrument, MY_FLOAT amplitude)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Start a note with the given drum type and amplitude.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Drummer::noteOff"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classDrummer.html#a3">noteOff</a> (MY_FLOAT amplitude)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Stop a note with the given amplitude (speed of decay).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Drummer::tick"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classDrummer.html#a4">tick</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Compute one output sample.</em></font><br><br></td></tr>
<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" doxytag="Drummer::Drummer" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDrummer.html#a0">Drummer</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Drummer::~Drummer" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDrummer.html#a1">~Drummer</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDrummer.html#a2">noteOn</a> (MY_FLOAT instrument, MY_FLOAT amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note with the given drum type and amplitude. <a href="#a2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="Drummer::noteOff" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDrummer.html#a3">noteOff</a> (MY_FLOAT amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Drummer::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classDrummer.html#a4">tick</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute one output sample. <br><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="classWvIn.html">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 Drummer.h.
STK drum sample player class.
<p>
This class implements a drum sampling synthesizer using <a class="el" href="classWvIn.html">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.html">Drummer.h</a>.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="Drummer::noteOn"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<p>
Definition at line <a class="el" href="Drummer_8h-source.html#l00028">28</a> of file <a class="el" href="Drummer_8h-source.html">Drummer.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="Drummer::noteOn" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="md">
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void Drummer::noteOn (
</b></td>
<td valign="bottom"><b>
MY_FLOAT <em>instrument</em>,
</b></td>
<td class="md" nowrap valign="top"> void Drummer::noteOn </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">MY_FLOAT&nbsp;</td>
<td class="mdname" nowrap> <em>instrument</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>MY_FLOAT&nbsp;</td>
<td class="mdname" nowrap> <em>amplitude</em></td>
</tr>
<tr>
<td></td>
<td><b>
MY_FLOAT <em>amplitude</em>&nbsp;)<code> [virtual]</code>
</b></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
@@ -77,11 +87,11 @@ MY_FLOAT <em>amplitude</em>&nbsp;)<code> [virtual]</code>
<td>
<p>
Start a note with the given drum type and amplitude.
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.
<p>
Reimplemented from <a class="el" href="classInstrmnt.html#a2">Instrmnt</a>. </td>
Implements <a class="el" href="classInstrmnt.html#a2">Instrmnt</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
@@ -90,7 +100,7 @@ Reimplemented from <a class="el" href="classInstrmnt.html#a2">Instrmnt</a>. <
<table>
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>