1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
<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>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sampler.html#a30ef51142f99faf0586e2da78bc6daf6">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames, unsigned int channel=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. <a href="#a30ef51142f99faf0586e2da78bc6daf6"></a><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-2012. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a30ef51142f99faf0586e2da78bc6daf6"></a><!-- doxytag: member="stk::Sampler::tick" ref="a30ef51142f99faf0586e2da78bc6daf6" args="(StkFrames &frames, unsigned int channel=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a>& stk::Sampler::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
<td class="paramname"> <em>frames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>channel</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. </p>
<p>The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
<p>Implements <a class="el" href="classstk_1_1Instrmnt.html#a34c6733ca145763462d9e44ae3c772b6">stk::Instrmnt</a>.</p>
<p>Implemented in <a class="el" href="classstk_1_1Moog.html#aee6aa6373c424e941f963b2709310f4e">stk::Moog</a>.</p>
</div>
</div>
<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-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
|
