/usr/share/doc/libjuce/apiref/classSamplerVoice.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: SamplerVoice Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classSamplerVoice-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SamplerVoice Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A subclass of <a class="el" href="classSynthesiserVoice.html" title="Represents a voice that a Synthesiser can use to play a SynthesiserSound. ">SynthesiserVoice</a> that can play a <a class="el" href="classSamplerSound.html" title="A subclass of SynthesiserSound that represents a sampled audio clip. ">SamplerSound</a>.
<a href="classSamplerVoice.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for SamplerVoice:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classSamplerVoice.png" usemap="#SamplerVoice_map" alt=""/>
<map id="SamplerVoice_map" name="SamplerVoice_map">
<area href="classSynthesiserVoice.html" title="Represents a voice that a Synthesiser can use to play a SynthesiserSound. " alt="SynthesiserVoice" shape="rect" coords="0,0,111,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa1614529f047ba46473645216f58d9ac"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSamplerVoice.html#aa1614529f047ba46473645216f58d9ac">SamplerVoice</a> ()</td></tr>
<tr class="memdesc:aa1614529f047ba46473645216f58d9ac"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classSamplerVoice.html" title="A subclass of SynthesiserVoice that can play a SamplerSound. ">SamplerVoice</a>. <a href="#aa1614529f047ba46473645216f58d9ac">More...</a><br /></td></tr>
<tr class="separator:aa1614529f047ba46473645216f58d9ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf89d1cb1e5c67c1daf562ec227d09ef"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSamplerVoice.html#acf89d1cb1e5c67c1daf562ec227d09ef">~SamplerVoice</a> ()</td></tr>
<tr class="memdesc:acf89d1cb1e5c67c1daf562ec227d09ef"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#acf89d1cb1e5c67c1daf562ec227d09ef">More...</a><br /></td></tr>
<tr class="separator:acf89d1cb1e5c67c1daf562ec227d09ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29685cd1bd8a1d7955c16434034bfeb1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSamplerVoice.html#a29685cd1bd8a1d7955c16434034bfeb1">canPlaySound</a> (<a class="el" href="classSynthesiserSound.html">SynthesiserSound</a> *) override</td></tr>
<tr class="memdesc:a29685cd1bd8a1d7955c16434034bfeb1"><td class="mdescLeft"> </td><td class="mdescRight">Must return true if this voice object is capable of playing the given sound. <a href="#a29685cd1bd8a1d7955c16434034bfeb1">More...</a><br /></td></tr>
<tr class="separator:a29685cd1bd8a1d7955c16434034bfeb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace2f7f448b19e026989e627729d7c35c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSamplerVoice.html#ace2f7f448b19e026989e627729d7c35c">startNote</a> (int midiNoteNumber, float velocity, <a class="el" href="classSynthesiserSound.html">SynthesiserSound</a> *, int pitchWheel) override</td></tr>
<tr class="memdesc:ace2f7f448b19e026989e627729d7c35c"><td class="mdescLeft"> </td><td class="mdescRight">Called to start a new note. <a href="#ace2f7f448b19e026989e627729d7c35c">More...</a><br /></td></tr>
<tr class="separator:ace2f7f448b19e026989e627729d7c35c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae123962ddd9c090cc53c702544a21e27"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSamplerVoice.html#ae123962ddd9c090cc53c702544a21e27">stopNote</a> (float velocity, bool allowTailOff) override</td></tr>
<tr class="memdesc:ae123962ddd9c090cc53c702544a21e27"><td class="mdescLeft"> </td><td class="mdescRight">Called to stop a note. <a href="#ae123962ddd9c090cc53c702544a21e27">More...</a><br /></td></tr>
<tr class="separator:ae123962ddd9c090cc53c702544a21e27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ec973f877597dba170806ec3afbbae4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSamplerVoice.html#a5ec973f877597dba170806ec3afbbae4">pitchWheelMoved</a> (int newValue) override</td></tr>
<tr class="memdesc:a5ec973f877597dba170806ec3afbbae4"><td class="mdescLeft"> </td><td class="mdescRight">Called to let the voice know that the pitch wheel has been moved. <a href="#a5ec973f877597dba170806ec3afbbae4">More...</a><br /></td></tr>
<tr class="separator:a5ec973f877597dba170806ec3afbbae4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a416b14c55e39696fb86fb3fa0113eafa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSamplerVoice.html#a416b14c55e39696fb86fb3fa0113eafa">controllerMoved</a> (int controllerNumber, int newValue) override</td></tr>
<tr class="memdesc:a416b14c55e39696fb86fb3fa0113eafa"><td class="mdescLeft"> </td><td class="mdescRight">Called to let the voice know that a midi controller has been moved. <a href="#a416b14c55e39696fb86fb3fa0113eafa">More...</a><br /></td></tr>
<tr class="separator:a416b14c55e39696fb86fb3fa0113eafa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a282d620c059aa9d0408c64c89c1c456b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSamplerVoice.html#a282d620c059aa9d0408c64c89c1c456b">renderNextBlock</a> (<a class="el" href="juce__AudioSampleBuffer_8h.html#a97a2916214efbd76c6b870f9c48efba0">AudioSampleBuffer</a> &, int startSample, int numSamples) override</td></tr>
<tr class="memdesc:a282d620c059aa9d0408c64c89c1c456b"><td class="mdescLeft"> </td><td class="mdescRight">Renders the next block of data for this voice. <a href="#a282d620c059aa9d0408c64c89c1c456b">More...</a><br /></td></tr>
<tr class="separator:a282d620c059aa9d0408c64c89c1c456b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classSynthesiserVoice"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSynthesiserVoice')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classSynthesiserVoice.html">SynthesiserVoice</a></td></tr>
<tr class="memitem:a365e31ac75ed304f623cb20d3dcc31fb inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#a365e31ac75ed304f623cb20d3dcc31fb">SynthesiserVoice</a> ()</td></tr>
<tr class="memdesc:a365e31ac75ed304f623cb20d3dcc31fb inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Creates a voice. <a href="classSynthesiserVoice.html#a365e31ac75ed304f623cb20d3dcc31fb">More...</a><br /></td></tr>
<tr class="separator:a365e31ac75ed304f623cb20d3dcc31fb inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a34687ca1d7fc823ad27b64eb4b508c07 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#a34687ca1d7fc823ad27b64eb4b508c07">~SynthesiserVoice</a> ()</td></tr>
<tr class="memdesc:a34687ca1d7fc823ad27b64eb4b508c07 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classSynthesiserVoice.html#a34687ca1d7fc823ad27b64eb4b508c07">More...</a><br /></td></tr>
<tr class="separator:a34687ca1d7fc823ad27b64eb4b508c07 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7e8ff1dc70d3ff90b4a96dae9dd7757 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#ac7e8ff1dc70d3ff90b4a96dae9dd7757">getCurrentlyPlayingNote</a> () const noexcept</td></tr>
<tr class="memdesc:ac7e8ff1dc70d3ff90b4a96dae9dd7757 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Returns the midi note that this voice is currently playing. <a href="classSynthesiserVoice.html#ac7e8ff1dc70d3ff90b4a96dae9dd7757">More...</a><br /></td></tr>
<tr class="separator:ac7e8ff1dc70d3ff90b4a96dae9dd7757 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45d0d2b22eb7da9f21cb63b18336de73 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSynthesiserSound.html#a602e767cdfca63dd73df1f0d5c723ef8">SynthesiserSound::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#a45d0d2b22eb7da9f21cb63b18336de73">getCurrentlyPlayingSound</a> () const noexcept</td></tr>
<tr class="memdesc:a45d0d2b22eb7da9f21cb63b18336de73 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Returns the sound that this voice is currently playing. <a href="classSynthesiserVoice.html#a45d0d2b22eb7da9f21cb63b18336de73">More...</a><br /></td></tr>
<tr class="separator:a45d0d2b22eb7da9f21cb63b18336de73 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa40b621fd776f6568325a0597ba1931 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#aaa40b621fd776f6568325a0597ba1931">isVoiceActive</a> () const</td></tr>
<tr class="memdesc:aaa40b621fd776f6568325a0597ba1931 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this voice is currently busy playing a sound. <a href="classSynthesiserVoice.html#aaa40b621fd776f6568325a0597ba1931">More...</a><br /></td></tr>
<tr class="separator:aaa40b621fd776f6568325a0597ba1931 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b5ada8bbf89e4be218b6ffecb770b30 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#a9b5ada8bbf89e4be218b6ffecb770b30">aftertouchChanged</a> (int newAftertouchValue)</td></tr>
<tr class="memdesc:a9b5ada8bbf89e4be218b6ffecb770b30 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Called to let the voice know that the aftertouch has changed. <a href="classSynthesiserVoice.html#a9b5ada8bbf89e4be218b6ffecb770b30">More...</a><br /></td></tr>
<tr class="separator:a9b5ada8bbf89e4be218b6ffecb770b30 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ec285dd9db207415f64ac83efe86859 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#a5ec285dd9db207415f64ac83efe86859">channelPressureChanged</a> (int newChannelPressureValue)</td></tr>
<tr class="memdesc:a5ec285dd9db207415f64ac83efe86859 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Called to let the voice know that the channel pressure has changed. <a href="classSynthesiserVoice.html#a5ec285dd9db207415f64ac83efe86859">More...</a><br /></td></tr>
<tr class="separator:a5ec285dd9db207415f64ac83efe86859 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac61fa7d3dd5180a561fc1c0ab418077e inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#ac61fa7d3dd5180a561fc1c0ab418077e">renderNextBlock</a> (<a class="el" href="classAudioBuffer.html">AudioBuffer</a>< double > &outputBuffer, int startSample, int numSamples)</td></tr>
<tr class="separator:ac61fa7d3dd5180a561fc1c0ab418077e inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31a423708524f139af52bd5771006b14 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#a31a423708524f139af52bd5771006b14">setCurrentPlaybackSampleRate</a> (double newRate)</td></tr>
<tr class="memdesc:a31a423708524f139af52bd5771006b14 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Changes the voice's reference sample rate. <a href="classSynthesiserVoice.html#a31a423708524f139af52bd5771006b14">More...</a><br /></td></tr>
<tr class="separator:a31a423708524f139af52bd5771006b14 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a020299094e0263dffb028450e9424272 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#a020299094e0263dffb028450e9424272">isPlayingChannel</a> (int midiChannel) const</td></tr>
<tr class="memdesc:a020299094e0263dffb028450e9424272 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the voice is currently playing a sound which is mapped to the given midi channel. <a href="classSynthesiserVoice.html#a020299094e0263dffb028450e9424272">More...</a><br /></td></tr>
<tr class="separator:a020299094e0263dffb028450e9424272 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a149385fe43164bbfd2659391aebc7ee4 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#a149385fe43164bbfd2659391aebc7ee4">getSampleRate</a> () const noexcept</td></tr>
<tr class="memdesc:a149385fe43164bbfd2659391aebc7ee4 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current target sample rate at which rendering is being done. <a href="classSynthesiserVoice.html#a149385fe43164bbfd2659391aebc7ee4">More...</a><br /></td></tr>
<tr class="separator:a149385fe43164bbfd2659391aebc7ee4 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0f9adb8d02f26099dea4467fd6fc170 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#ae0f9adb8d02f26099dea4467fd6fc170">isKeyDown</a> () const noexcept</td></tr>
<tr class="memdesc:ae0f9adb8d02f26099dea4467fd6fc170 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the key that triggered this voice is still held down. <a href="classSynthesiserVoice.html#ae0f9adb8d02f26099dea4467fd6fc170">More...</a><br /></td></tr>
<tr class="separator:ae0f9adb8d02f26099dea4467fd6fc170 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6524e841fc7ebb1936690f8be147417 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#ab6524e841fc7ebb1936690f8be147417">isSustainPedalDown</a> () const noexcept</td></tr>
<tr class="memdesc:ab6524e841fc7ebb1936690f8be147417 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the sustain pedal is currently active for this voice. <a href="classSynthesiserVoice.html#ab6524e841fc7ebb1936690f8be147417">More...</a><br /></td></tr>
<tr class="separator:ab6524e841fc7ebb1936690f8be147417 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8011b7b9c2cb7641fe99e94427a95717 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#a8011b7b9c2cb7641fe99e94427a95717">isSostenutoPedalDown</a> () const noexcept</td></tr>
<tr class="memdesc:a8011b7b9c2cb7641fe99e94427a95717 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the sostenuto pedal is currently active for this voice. <a href="classSynthesiserVoice.html#a8011b7b9c2cb7641fe99e94427a95717">More...</a><br /></td></tr>
<tr class="separator:a8011b7b9c2cb7641fe99e94427a95717 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa928c0b5d570b8b82f8d86b60e2a6597 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#aa928c0b5d570b8b82f8d86b60e2a6597">isPlayingButReleased</a> () const noexcept</td></tr>
<tr class="memdesc:aa928c0b5d570b8b82f8d86b60e2a6597 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a voice is sounding in its release phase. <a href="classSynthesiserVoice.html#aa928c0b5d570b8b82f8d86b60e2a6597">More...</a><br /></td></tr>
<tr class="separator:aa928c0b5d570b8b82f8d86b60e2a6597 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9421602c148978426c98bf173d5e5c7 inherit pub_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#aa9421602c148978426c98bf173d5e5c7">wasStartedBefore</a> (const <a class="el" href="classSynthesiserVoice.html">SynthesiserVoice</a> &other) const noexcept</td></tr>
<tr class="memdesc:aa9421602c148978426c98bf173d5e5c7 inherit pub_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this voice started playing its current note before the other voice did. <a href="classSynthesiserVoice.html#aa9421602c148978426c98bf173d5e5c7">More...</a><br /></td></tr>
<tr class="separator:aa9421602c148978426c98bf173d5e5c7 inherit pub_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classSynthesiserVoice"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classSynthesiserVoice')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classSynthesiserVoice.html">SynthesiserVoice</a></td></tr>
<tr class="memitem:a55d1e7a062f8dc9a6cd78526b0da049c inherit pro_methods_classSynthesiserVoice"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserVoice.html#a55d1e7a062f8dc9a6cd78526b0da049c">clearCurrentNote</a> ()</td></tr>
<tr class="memdesc:a55d1e7a062f8dc9a6cd78526b0da049c inherit pro_methods_classSynthesiserVoice"><td class="mdescLeft"> </td><td class="mdescRight">Resets the state of this voice after a sound has finished playing. <a href="classSynthesiserVoice.html#a55d1e7a062f8dc9a6cd78526b0da049c">More...</a><br /></td></tr>
<tr class="separator:a55d1e7a062f8dc9a6cd78526b0da049c inherit pro_methods_classSynthesiserVoice"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A subclass of <a class="el" href="classSynthesiserVoice.html" title="Represents a voice that a Synthesiser can use to play a SynthesiserSound. ">SynthesiserVoice</a> that can play a <a class="el" href="classSamplerSound.html" title="A subclass of SynthesiserSound that represents a sampled audio clip. ">SamplerSound</a>. </p>
<p>To use it, create a <a class="el" href="classSynthesiser.html" title="Base class for a musical device that can play sounds. ">Synthesiser</a>, add some <a class="el" href="classSamplerVoice.html" title="A subclass of SynthesiserVoice that can play a SamplerSound. ">SamplerVoice</a> objects to it, then give it some SampledSound objects to play.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classSamplerSound.html" title="A subclass of SynthesiserSound that represents a sampled audio clip. ">SamplerSound</a>, <a class="el" href="classSynthesiser.html" title="Base class for a musical device that can play sounds. ">Synthesiser</a>, <a class="el" href="classSynthesiserVoice.html" title="Represents a voice that a Synthesiser can use to play a SynthesiserSound. ">SynthesiserVoice</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aa1614529f047ba46473645216f58d9ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1614529f047ba46473645216f58d9ac">§ </a></span>SamplerVoice()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SamplerVoice::SamplerVoice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classSamplerVoice.html" title="A subclass of SynthesiserVoice that can play a SamplerSound. ">SamplerVoice</a>. </p>
</div>
</div>
<a id="acf89d1cb1e5c67c1daf562ec227d09ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf89d1cb1e5c67c1daf562ec227d09ef">§ </a></span>~SamplerVoice()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SamplerVoice::~SamplerVoice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a29685cd1bd8a1d7955c16434034bfeb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29685cd1bd8a1d7955c16434034bfeb1">§ </a></span>canPlaySound()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool SamplerVoice::canPlaySound </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSynthesiserSound.html">SynthesiserSound</a> * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Must return true if this voice object is capable of playing the given sound. </p>
<p>If there are different classes of sound, and different classes of voice, a voice can choose which ones it wants to take on.</p>
<p>A typical implementation of this method may just return true if there's only one type of voice and sound, or it might check the type of the sound object passed-in and see if it's one that it understands. </p>
<p>Implements <a class="el" href="classSynthesiserVoice.html#aa9fb097ca96dc39fae8e6f7b9139df9f">SynthesiserVoice</a>.</p>
</div>
</div>
<a id="ace2f7f448b19e026989e627729d7c35c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace2f7f448b19e026989e627729d7c35c">§ </a></span>startNote()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SamplerVoice::startNote </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>midiNoteNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>velocity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classSynthesiserSound.html">SynthesiserSound</a> * </td>
<td class="paramname"><em>sound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>currentPitchWheelPosition</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to start a new note. </p>
<p>This will be called during the rendering callback, so must be fast and thread-safe. </p>
<p>Implements <a class="el" href="classSynthesiserVoice.html#af3b872622dd9bb540030420189175762">SynthesiserVoice</a>.</p>
</div>
</div>
<a id="ae123962ddd9c090cc53c702544a21e27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae123962ddd9c090cc53c702544a21e27">§ </a></span>stopNote()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SamplerVoice::stopNote </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>velocity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>allowTailOff</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to stop a note. </p>
<p>This will be called during the rendering callback, so must be fast and thread-safe.</p>
<p>The velocity indicates how quickly the note was released - 0 is slowly, 1 is quickly.</p>
<p>If allowTailOff is false or the voice doesn't want to tail-off, then it must stop all sound immediately, and must call <a class="el" href="classSynthesiserVoice.html#a55d1e7a062f8dc9a6cd78526b0da049c" title="Resets the state of this voice after a sound has finished playing. ">clearCurrentNote()</a> to reset the state of this voice and allow the synth to reassign it another sound.</p>
<p>If allowTailOff is true and the voice decides to do a tail-off, then it's allowed to begin fading out its sound, and it can stop playing until it's finished. As soon as it finishes playing (during the rendering callback), it must make sure that it calls <a class="el" href="classSynthesiserVoice.html#a55d1e7a062f8dc9a6cd78526b0da049c" title="Resets the state of this voice after a sound has finished playing. ">clearCurrentNote()</a>. </p>
<p>Implements <a class="el" href="classSynthesiserVoice.html#ae1faf9289de24cdeb1d42289754601e6">SynthesiserVoice</a>.</p>
</div>
</div>
<a id="a5ec973f877597dba170806ec3afbbae4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ec973f877597dba170806ec3afbbae4">§ </a></span>pitchWheelMoved()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SamplerVoice::pitchWheelMoved </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>newPitchWheelValue</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to let the voice know that the pitch wheel has been moved. </p>
<p>This will be called during the rendering callback, so must be fast and thread-safe. </p>
<p>Implements <a class="el" href="classSynthesiserVoice.html#aca1eda7413a8709c1fc70a9255e48e91">SynthesiserVoice</a>.</p>
</div>
</div>
<a id="a416b14c55e39696fb86fb3fa0113eafa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a416b14c55e39696fb86fb3fa0113eafa">§ </a></span>controllerMoved()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SamplerVoice::controllerMoved </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>controllerNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>newControllerValue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to let the voice know that a midi controller has been moved. </p>
<p>This will be called during the rendering callback, so must be fast and thread-safe. </p>
<p>Implements <a class="el" href="classSynthesiserVoice.html#a25b23c8ce57b394d0d037eef0f314ac0">SynthesiserVoice</a>.</p>
</div>
</div>
<a id="a282d620c059aa9d0408c64c89c1c456b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a282d620c059aa9d0408c64c89c1c456b">§ </a></span>renderNextBlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SamplerVoice::renderNextBlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__AudioSampleBuffer_8h.html#a97a2916214efbd76c6b870f9c48efba0">AudioSampleBuffer</a> & </td>
<td class="paramname"><em>outputBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>startSample</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numSamples</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Renders the next block of data for this voice. </p>
<p>The output audio data must be added to the current contents of the buffer provided. Only the region of the buffer between startSample and (startSample + numSamples) should be altered by this method.</p>
<p>If the voice is currently silent, it should just return without doing anything.</p>
<p>If the sound that the voice is playing finishes during the course of this rendered block, it must call <a class="el" href="classSynthesiserVoice.html#a55d1e7a062f8dc9a6cd78526b0da049c" title="Resets the state of this voice after a sound has finished playing. ">clearCurrentNote()</a>, to tell the synthesiser that it has finished.</p>
<p>The size of the blocks that are rendered can change each time it is called, and may involve rendering as little as 1 sample at a time. In between rendering callbacks, the voice's methods will be called to tell it about note and controller events. </p>
<p>Implements <a class="el" href="classSynthesiserVoice.html#a72ab7856c1e7651b1ce955388645a0a1">SynthesiserVoice</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__Sampler_8h.html">juce_Sampler.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|