File: classstk_1_1Stk.html

package info (click to toggle)
stk 4.4.4-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 24,856 kB
  • sloc: cpp: 33,976; tcl: 2,375; sh: 2,319; ansic: 163; perl: 114; makefile: 37
file content (277 lines) | stat: -rw-r--r-- 25,566 bytes parent folder | download | duplicates (2)
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<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"> &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.6.2 -->
  <div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Stk.html">Stk</a>
  </div>
<div class="contents">
<h1>stk::Stk Class Reference</h1><!-- doxytag: class="stk::Stk" -->
<p>STK base class.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="Stk_8h_source.html">Stk.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::Stk:</div>
<div class="dynsection">
 <div class="center">
  <img src="classstk_1_1Stk.png" usemap="#stk::Stk_map" alt=""/>
  <map id="stk::Stk_map" name="stk::Stk_map">
<area href="classstk_1_1Effect.html" alt="stk::Effect" shape="rect" coords="101,56,192,80"/>
<area href="classstk_1_1FileRead.html" alt="stk::FileRead" shape="rect" coords="101,112,192,136"/>
<area href="classstk_1_1FileWrite.html" alt="stk::FileWrite" shape="rect" coords="101,168,192,192"/>
<area href="classstk_1_1Filter.html" alt="stk::Filter" shape="rect" coords="101,224,192,248"/>
<area href="classstk_1_1Function.html" alt="stk::Function" shape="rect" coords="101,280,192,304"/>
<area href="classstk_1_1Generator.html" alt="stk::Generator" shape="rect" coords="101,336,192,360"/>
<area href="classstk_1_1Guitar.html" alt="stk::Guitar" shape="rect" coords="101,392,192,416"/>
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="101,448,192,472"/>
<area href="classstk_1_1Messager.html" alt="stk::Messager" shape="rect" coords="101,504,192,528"/>
<area href="classstk_1_1MidiFileIn.html" alt="stk::MidiFileIn" shape="rect" coords="101,560,192,584"/>
<area href="classstk_1_1Mutex.html" alt="stk::Mutex" shape="rect" coords="101,616,192,640"/>
<area href="classstk_1_1Phonemes.html" alt="stk::Phonemes" shape="rect" coords="101,672,192,696"/>
<area href="classstk_1_1Skini.html" alt="stk::Skini" shape="rect" coords="101,728,192,752"/>
<area href="classstk_1_1Socket.html" alt="stk::Socket" shape="rect" coords="101,784,192,808"/>
<area href="classstk_1_1Sphere.html" alt="stk::Sphere" shape="rect" coords="101,840,192,864"/>
<area href="classstk_1_1Thread.html" alt="stk::Thread" shape="rect" coords="101,896,192,920"/>
<area href="classstk_1_1Twang.html" alt="stk::Twang" shape="rect" coords="101,952,192,976"/>
<area href="classstk_1_1Vector3D.html" alt="stk::Vector3D" shape="rect" coords="101,1008,192,1032"/>
<area href="classstk_1_1Voicer.html" alt="stk::Voicer" shape="rect" coords="101,1064,192,1088"/>
<area href="classstk_1_1WvIn.html" alt="stk::WvIn" shape="rect" coords="101,1120,192,1144"/>
<area href="classstk_1_1WvOut.html" alt="stk::WvOut" shape="rect" coords="101,1176,192,1200"/>
</map>
 </div>
</div>

<p><a href="classstk_1_1Stk-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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#ab8a52e4897bea5c0f5e66adf37a8e39b">ignoreSampleRateChange</a> (bool ignore=true)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A function to enable/disable the automatic updating of class data when the STK sample rate changes.  <a href="#ab8a52e4897bea5c0f5e66adf37a8e39b"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5fbe37000a611ce56075ee7d8936472d"></a><!-- doxytag: member="stk::Stk::sampleRate" ref="a5fbe37000a611ce56075ee7d8936472d" args="(void)" -->
static StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a5fbe37000a611ce56075ee7d8936472d">sampleRate</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method that returns the current STK sample rate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a46e2f55e5a92c717c3893fe23dde88a5">setSampleRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method that sets the STK sample rate.  <a href="#a46e2f55e5a92c717c3893fe23dde88a5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f3fd05b709788213549fe2cbaf4a52a"></a><!-- doxytag: member="stk::Stk::rawwavePath" ref="a5f3fd05b709788213549fe2cbaf4a52a" args="(void)" -->
static std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a5f3fd05b709788213549fe2cbaf4a52a">rawwavePath</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method that returns the current rawwave path. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f641ad194f9d8ce1f9d1ae56af5686b"></a><!-- doxytag: member="stk::Stk::setRawwavePath" ref="a4f641ad194f9d8ce1f9d1ae56af5686b" args="(std::string path)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a4f641ad194f9d8ce1f9d1ae56af5686b">setRawwavePath</a> (std::string path)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method that sets the STK rawwave path. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2dc4c9e67317eb0753868a89c8095f6"></a><!-- doxytag: member="stk::Stk::swap16" ref="ab2dc4c9e67317eb0753868a89c8095f6" args="(unsigned char *ptr)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#ab2dc4c9e67317eb0753868a89c8095f6">swap16</a> (unsigned char *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method that byte-swaps a 16-bit data type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a820631139e6f7e23d328d387c0f530fd"></a><!-- doxytag: member="stk::Stk::swap32" ref="a820631139e6f7e23d328d387c0f530fd" args="(unsigned char *ptr)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a820631139e6f7e23d328d387c0f530fd">swap32</a> (unsigned char *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method that byte-swaps a 32-bit data type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f744eadf29ecbfbeddfdf7ceb5853c9"></a><!-- doxytag: member="stk::Stk::swap64" ref="a5f744eadf29ecbfbeddfdf7ceb5853c9" args="(unsigned char *ptr)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a5f744eadf29ecbfbeddfdf7ceb5853c9">swap64</a> (unsigned char *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method that byte-swaps a 64-bit data type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad75619ab92a0c19b5a52cb68884511e3"></a><!-- doxytag: member="stk::Stk::sleep" ref="ad75619ab92a0c19b5a52cb68884511e3" args="(unsigned long milliseconds)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#ad75619ab92a0c19b5a52cb68884511e3">sleep</a> (unsigned long milliseconds)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static cross-platform method to sleep for a number of milliseconds. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7dd617f6bf20e55d3ab97b86d8200b2e"></a><!-- doxytag: member="stk::Stk::inRange" ref="a7dd617f6bf20e55d3ab97b86d8200b2e" args="(StkFloat value, StkFloat min, StkFloat max)" -->
static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a7dd617f6bf20e55d3ab97b86d8200b2e">inRange</a> (StkFloat value, StkFloat min, StkFloat max)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method to check whether a value is within a specified range. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48ac73a0d8ca28445ba1a054e1f061ff"></a><!-- doxytag: member="stk::Stk::handleError" ref="a48ac73a0d8ca28445ba1a054e1f061ff" args="(const char *message, StkError::Type type)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff">handleError</a> (const char *message, StkError::Type type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static function for error reporting and handling using c-strings. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc18b8fc8ed5b992bd2efef162a40777"></a><!-- doxytag: member="stk::Stk::handleError" ref="abc18b8fc8ed5b992bd2efef162a40777" args="(std::string message, StkError::Type type)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#abc18b8fc8ed5b992bd2efef162a40777">handleError</a> (std::string message, StkError::Type type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static function for error reporting and handling using c++ strings. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d8b38b9f808fb7c5e65c228b4b7dbbb"></a><!-- doxytag: member="stk::Stk::showWarnings" ref="a2d8b38b9f808fb7c5e65c228b4b7dbbb" args="(bool status)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a2d8b38b9f808fb7c5e65c228b4b7dbbb">showWarnings</a> (bool status)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Toggle display of WARNING and STATUS messages. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affb98f8f1f65ddc9e4af8440056b1504"></a><!-- doxytag: member="stk::Stk::printErrors" ref="affb98f8f1f65ddc9e4af8440056b1504" args="(bool status)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#affb98f8f1f65ddc9e4af8440056b1504">printErrors</a> (bool status)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Toggle display of error messages before throwing exceptions. <br/></td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const StkFormat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#adec863631653693af8f1ed5c0cfc5c4c">STK_SINT8</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const StkFormat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a5a807971b7fc3c8985d97823be079a7b">STK_SINT16</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const StkFormat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#afbe8049756ea88bdd8cebad65305dd52">STK_SINT24</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const StkFormat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a605c96894e1b0f1f08a80214a08012ad">STK_SINT32</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const StkFormat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a079e62be7093d593498e9d2ba4ac20fa">STK_FLOAT32</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const StkFormat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a57b00150ae559b6f099be117b2e53af4">STK_FLOAT64</a></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bff83b5a318ff171f94a218ad52226b"></a><!-- doxytag: member="stk::Stk::Stk" ref="a9bff83b5a318ff171f94a218ad52226b" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a9bff83b5a318ff171f94a218ad52226b">Stk</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0d5c6ab745ad2841a59032addae3905"></a><!-- doxytag: member="stk::Stk::~Stk" ref="ad0d5c6ab745ad2841a59032addae3905" args="(void)" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#ad0d5c6ab745ad2841a59032addae3905">~Stk</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"><a class="anchor" id="a740e872daa4b2ad1c918163e7c5ab56b"></a><!-- doxytag: member="stk::Stk::sampleRateChanged" ref="a740e872daa4b2ad1c918163e7c5ab56b" args="(StkFloat newRate, StkFloat oldRate)" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a740e872daa4b2ad1c918163e7c5ab56b">sampleRateChanged</a> (StkFloat newRate, StkFloat oldRate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This function should be implemented in subclasses that depend on the sample rate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ab0e88856708f65887295ad4ad90340"></a><!-- doxytag: member="stk::Stk::addSampleRateAlert" ref="a5ab0e88856708f65887295ad4ad90340" args="(Stk *ptr)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a5ab0e88856708f65887295ad4ad90340">addSampleRateAlert</a> (<a class="el" href="classstk_1_1Stk.html">Stk</a> *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add class pointer to list for sample rate change notification. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a349865986f712f58087cb72603a6ced8"></a><!-- doxytag: member="stk::Stk::removeSampleRateAlert" ref="a349865986f712f58087cb72603a6ced8" args="(Stk *ptr)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a349865986f712f58087cb72603a6ced8">removeSampleRateAlert</a> (<a class="el" href="classstk_1_1Stk.html">Stk</a> *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove class pointer from list for sample rate change notification. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a577656590baea0d65057b221f050f83d"></a><!-- doxytag: member="stk::Stk::handleError" ref="a577656590baea0d65057b221f050f83d" args="(StkError::Type type)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Stk.html#a577656590baea0d65057b221f050f83d">handleError</a> (StkError::Type type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal function for error reporting that assumes message in <code>oStream_</code> variable. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK base class. </p>
<p>Nearly all STK classes inherit from this class. The global sample rate and rawwave path variables can be queried and modified via <a class="el" href="classstk_1_1Stk.html" title="STK base class.">Stk</a>. In addition, this class provides error handling and byte-swapping functions.</p>
<p>The Synthesis ToolKit in C++ (STK) is a set of open source audio signal processing and algorithmic synthesis classes written in the C++ programming language. STK was designed to facilitate rapid development of music synthesis and audio processing software, with an emphasis on cross-platform functionality, realtime control, ease of use, and educational example code. STK currently runs with realtime support (audio and MIDI) on Linux, Macintosh OS X, and Windows computer platforms. Generic, non-realtime support has been tested under NeXTStep, Sun, and other platforms and should work with any standard C++ compiler.</p>
<p>STK WWW site: <a href="http://ccrma.stanford.edu/software/stk/">http://ccrma.stanford.edu/software/stk/</a></p>
<p>The Synthesis ToolKit in C++ (STK) Copyright (c) 1995-2012 Perry R. Cook and Gary P. Scavone</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>Any person wishing to distribute modifications to the Software is asked to send the modifications to the original developer so that they can be incorporated into the canonical version. This is, however, not a binding provision of this license.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a46e2f55e5a92c717c3893fe23dde88a5"></a><!-- doxytag: member="stk::Stk::setSampleRate" ref="a46e2f55e5a92c717c3893fe23dde88a5" args="(StkFloat rate)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void stk::Stk::setSampleRate </td>
          <td>(</td>
          <td class="paramtype">StkFloat&nbsp;</td>
          <td class="paramname"> <em>rate</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Static method that sets the STK sample rate. </p>
<p>The sample rate set using this method is queried by all STK classes that depend on its value. It is initialized to the default SRATE set in <a class="el" href="Stk_8h_source.html">Stk.h</a>. Many STK classes use the sample rate during instantiation. Therefore, if you wish to use a rate that is different from the default rate, it is imperative that it be set <em>BEFORE</em> STK objects are instantiated. A few classes that make use of the global STK sample rate are automatically notified when the rate changes so that internal class data can be appropriately updated. However, this has not been fully implemented. Specifically, classes that appropriately update their own data when either a setFrequency() or noteOn() function is called do not currently receive the automatic notification of rate change. If the user wants a specific class instance to ignore such notifications, perhaps in a multi-rate context, the function <a class="el" href="classstk_1_1Stk.html#ab8a52e4897bea5c0f5e66adf37a8e39b" title="A function to enable/disable the automatic updating of class data when the STK sample...">Stk::ignoreSampleRateChange()</a> should be called. </p>

</div>
</div>
<a class="anchor" id="ab8a52e4897bea5c0f5e66adf37a8e39b"></a><!-- doxytag: member="stk::Stk::ignoreSampleRateChange" ref="ab8a52e4897bea5c0f5e66adf37a8e39b" args="(bool ignore=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void stk::Stk::ignoreSampleRateChange </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>ignore</em> = <code>true</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A function to enable/disable the automatic updating of class data when the STK sample rate changes. </p>
<p>This function allows the user to enable or disable class data updates in response to global sample rate changes on a class by class basis. </p>

<p>Reimplemented in <a class="el" href="classstk_1_1BiQuad.html#aab468cd1aa79b95442b15bb04d8bb211">stk::BiQuad</a>, <a class="el" href="classstk_1_1FormSwep.html#a91096ebd684df25fc36a759f642b2200">stk::FormSwep</a>, <a class="el" href="classstk_1_1TwoPole.html#ad0a3ac1b5d4e651a7ff1efb1d5362c0b">stk::TwoPole</a>, and <a class="el" href="classstk_1_1TwoZero.html#aa1a1568aae3cd3d53011b3fc344cb086">stk::TwoZero</a>.</p>

<p><div class="fragment"><pre class="fragment"><a name="l00172"></a>00172 { ignoreSampleRateChange_ = ignore; };
</pre></div></p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="adec863631653693af8f1ed5c0cfc5c4c"></a><!-- doxytag: member="stk::Stk::STK_SINT8" ref="adec863631653693af8f1ed5c0cfc5c4c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const StkFormat <a class="el" href="classstk_1_1Stk.html#adec863631653693af8f1ed5c0cfc5c4c">stk::Stk::STK_SINT8</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>-128 to +127 </p>

</div>
</div>
<a class="anchor" id="a5a807971b7fc3c8985d97823be079a7b"></a><!-- doxytag: member="stk::Stk::STK_SINT16" ref="a5a807971b7fc3c8985d97823be079a7b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const StkFormat <a class="el" href="classstk_1_1Stk.html#a5a807971b7fc3c8985d97823be079a7b">stk::Stk::STK_SINT16</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>-32768 to +32767 </p>

</div>
</div>
<a class="anchor" id="afbe8049756ea88bdd8cebad65305dd52"></a><!-- doxytag: member="stk::Stk::STK_SINT24" ref="afbe8049756ea88bdd8cebad65305dd52" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const StkFormat <a class="el" href="classstk_1_1Stk.html#afbe8049756ea88bdd8cebad65305dd52">stk::Stk::STK_SINT24</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Lower 3 bytes of 32-bit signed integer. </p>

</div>
</div>
<a class="anchor" id="a605c96894e1b0f1f08a80214a08012ad"></a><!-- doxytag: member="stk::Stk::STK_SINT32" ref="a605c96894e1b0f1f08a80214a08012ad" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const StkFormat <a class="el" href="classstk_1_1Stk.html#a605c96894e1b0f1f08a80214a08012ad">stk::Stk::STK_SINT32</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>-2147483648 to +2147483647. </p>

</div>
</div>
<a class="anchor" id="a079e62be7093d593498e9d2ba4ac20fa"></a><!-- doxytag: member="stk::Stk::STK_FLOAT32" ref="a079e62be7093d593498e9d2ba4ac20fa" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const StkFormat <a class="el" href="classstk_1_1Stk.html#a079e62be7093d593498e9d2ba4ac20fa">stk::Stk::STK_FLOAT32</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Normalized between plus/minus 1.0. </p>

</div>
</div>
<a class="anchor" id="a57b00150ae559b6f099be117b2e53af4"></a><!-- doxytag: member="stk::Stk::STK_FLOAT64" ref="a57b00150ae559b6f099be117b2e53af4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const StkFormat <a class="el" href="classstk_1_1Stk.html#a57b00150ae559b6f099be117b2e53af4">stk::Stk::STK_FLOAT64</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Normalized between plus/minus 1.0. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Stk_8h_source.html">Stk.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-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>

</BODY>
</HTML>