/usr/share/doc/libjuce/apiref/classMPESynthesiserVoice.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 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 | <!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: MPESynthesiserVoice 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="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classMPESynthesiserVoice-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MPESynthesiserVoice Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Represents an MPE voice that an <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> can use to play a sound.
<a href="classMPESynthesiserVoice.html#details">More...</a></p>
<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:ac249363fa7744946af9dbcc335479ffa"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#ac249363fa7744946af9dbcc335479ffa">MPESynthesiserVoice</a> ()</td></tr>
<tr class="memdesc:ac249363fa7744946af9dbcc335479ffa"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ac249363fa7744946af9dbcc335479ffa">More...</a><br /></td></tr>
<tr class="separator:ac249363fa7744946af9dbcc335479ffa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab347e2d6583493d04dce1d0cefe825ba"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#ab347e2d6583493d04dce1d0cefe825ba">~MPESynthesiserVoice</a> ()</td></tr>
<tr class="memdesc:ab347e2d6583493d04dce1d0cefe825ba"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ab347e2d6583493d04dce1d0cefe825ba">More...</a><br /></td></tr>
<tr class="separator:ab347e2d6583493d04dce1d0cefe825ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a073572535bfb518f0825b72ad52ddccb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMPENote.html">MPENote</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#a073572535bfb518f0825b72ad52ddccb">getCurrentlyPlayingNote</a> () const noexcept</td></tr>
<tr class="memdesc:a073572535bfb518f0825b72ad52ddccb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="structMPENote.html" title="This struct represents a playing MPE note. ">MPENote</a> that this voice is currently playing. <a href="#a073572535bfb518f0825b72ad52ddccb">More...</a><br /></td></tr>
<tr class="separator:a073572535bfb518f0825b72ad52ddccb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a930a864916a6278169e2a02f62058dc1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#a930a864916a6278169e2a02f62058dc1">isCurrentlyPlayingNote</a> (<a class="el" href="structMPENote.html">MPENote</a> note) const noexcept</td></tr>
<tr class="memdesc:a930a864916a6278169e2a02f62058dc1"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the voice is currently playing the given <a class="el" href="structMPENote.html" title="This struct represents a playing MPE note. ">MPENote</a> (as identified by the note's initial note number and MIDI channel). <a href="#a930a864916a6278169e2a02f62058dc1">More...</a><br /></td></tr>
<tr class="separator:a930a864916a6278169e2a02f62058dc1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afbb658b840fa1568fa2565c254ed9692"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#afbb658b840fa1568fa2565c254ed9692">isActive</a> () const</td></tr>
<tr class="memdesc:afbb658b840fa1568fa2565c254ed9692"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this voice is currently busy playing a sound. <a href="#afbb658b840fa1568fa2565c254ed9692">More...</a><br /></td></tr>
<tr class="separator:afbb658b840fa1568fa2565c254ed9692"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5ba4a685cf06eb2be693c237135ad0b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#af5ba4a685cf06eb2be693c237135ad0b">isPlayingButReleased</a> () const noexcept</td></tr>
<tr class="memdesc:af5ba4a685cf06eb2be693c237135ad0b"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a voice is sounding in its release phase. <a href="#af5ba4a685cf06eb2be693c237135ad0b">More...</a><br /></td></tr>
<tr class="separator:af5ba4a685cf06eb2be693c237135ad0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae10c1cdfb37208b96b56863d47a3a193"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#ae10c1cdfb37208b96b56863d47a3a193">noteStarted</a> ()=0</td></tr>
<tr class="memdesc:ae10c1cdfb37208b96b56863d47a3a193"><td class="mdescLeft"> </td><td class="mdescRight">Called by the <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> to let the voice know that a new note has started on it. <a href="#ae10c1cdfb37208b96b56863d47a3a193">More...</a><br /></td></tr>
<tr class="separator:ae10c1cdfb37208b96b56863d47a3a193"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60d75565bb6ef14262aa3e5ab5c94328"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#a60d75565bb6ef14262aa3e5ab5c94328">noteStopped</a> (bool allowTailOff)=0</td></tr>
<tr class="memdesc:a60d75565bb6ef14262aa3e5ab5c94328"><td class="mdescLeft"> </td><td class="mdescRight">Called by the <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> to let the voice know that its currently playing note has stopped. <a href="#a60d75565bb6ef14262aa3e5ab5c94328">More...</a><br /></td></tr>
<tr class="separator:a60d75565bb6ef14262aa3e5ab5c94328"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10d814de2c8a444040adfd90425a72d8"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#a10d814de2c8a444040adfd90425a72d8">notePressureChanged</a> ()=0</td></tr>
<tr class="memdesc:a10d814de2c8a444040adfd90425a72d8"><td class="mdescLeft"> </td><td class="mdescRight">Called by the <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> to let the voice know that its currently playing note has changed its pressure value. <a href="#a10d814de2c8a444040adfd90425a72d8">More...</a><br /></td></tr>
<tr class="separator:a10d814de2c8a444040adfd90425a72d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afef5b8e0cad53c4257ed78f6e7a04be5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#afef5b8e0cad53c4257ed78f6e7a04be5">notePitchbendChanged</a> ()=0</td></tr>
<tr class="memdesc:afef5b8e0cad53c4257ed78f6e7a04be5"><td class="mdescLeft"> </td><td class="mdescRight">Called by the <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> to let the voice know that its currently playing note has changed its pitchbend value. <a href="#afef5b8e0cad53c4257ed78f6e7a04be5">More...</a><br /></td></tr>
<tr class="separator:afef5b8e0cad53c4257ed78f6e7a04be5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2f36b71807fd1ac15c52f480702112f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#ad2f36b71807fd1ac15c52f480702112f">noteTimbreChanged</a> ()=0</td></tr>
<tr class="memdesc:ad2f36b71807fd1ac15c52f480702112f"><td class="mdescLeft"> </td><td class="mdescRight">Called by the <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> to let the voice know that its currently playing note has changed its timbre value. <a href="#ad2f36b71807fd1ac15c52f480702112f">More...</a><br /></td></tr>
<tr class="separator:ad2f36b71807fd1ac15c52f480702112f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2cd567d2206dad122b91f51cecce6e2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#aa2cd567d2206dad122b91f51cecce6e2">noteKeyStateChanged</a> ()=0</td></tr>
<tr class="memdesc:aa2cd567d2206dad122b91f51cecce6e2"><td class="mdescLeft"> </td><td class="mdescRight">Called by the <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> to let the voice know that its currently playing note has changed its key state. <a href="#aa2cd567d2206dad122b91f51cecce6e2">More...</a><br /></td></tr>
<tr class="separator:aa2cd567d2206dad122b91f51cecce6e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a204b1557448a7de667171620525d4023"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#a204b1557448a7de667171620525d4023">renderNextBlock</a> (<a class="el" href="classAudioBuffer.html">AudioBuffer</a>< float > &outputBuffer, int startSample, int numSamples)=0</td></tr>
<tr class="memdesc:a204b1557448a7de667171620525d4023"><td class="mdescLeft"> </td><td class="mdescRight">Renders the next block of data for this voice. <a href="#a204b1557448a7de667171620525d4023">More...</a><br /></td></tr>
<tr class="separator:a204b1557448a7de667171620525d4023"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22e7b9bd5d46036908641a7ae386b283"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#a22e7b9bd5d46036908641a7ae386b283">renderNextBlock</a> (<a class="el" href="classAudioBuffer.html">AudioBuffer</a>< double > &, int, int)</td></tr>
<tr class="memdesc:a22e7b9bd5d46036908641a7ae386b283"><td class="mdescLeft"> </td><td class="mdescRight">Renders the next block of 64-bit data for this voice. <a href="#a22e7b9bd5d46036908641a7ae386b283">More...</a><br /></td></tr>
<tr class="separator:a22e7b9bd5d46036908641a7ae386b283"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cc2f469d88ea14b0e48476017da70a7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#a0cc2f469d88ea14b0e48476017da70a7">setCurrentSampleRate</a> (double newRate)</td></tr>
<tr class="memdesc:a0cc2f469d88ea14b0e48476017da70a7"><td class="mdescLeft"> </td><td class="mdescRight">Changes the voice's reference sample rate. <a href="#a0cc2f469d88ea14b0e48476017da70a7">More...</a><br /></td></tr>
<tr class="separator:a0cc2f469d88ea14b0e48476017da70a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4a38948a044093709fcfa2295a8110a"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#ae4a38948a044093709fcfa2295a8110a">getSampleRate</a> () const noexcept</td></tr>
<tr class="memdesc:ae4a38948a044093709fcfa2295a8110a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current target sample rate at which rendering is being done. <a href="#ae4a38948a044093709fcfa2295a8110a">More...</a><br /></td></tr>
<tr class="separator:ae4a38948a044093709fcfa2295a8110a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1682e06d31bdb7fce2d4d692de9e6b8c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#a1682e06d31bdb7fce2d4d692de9e6b8c">wasStartedBefore</a> (const <a class="el" href="classMPESynthesiserVoice.html">MPESynthesiserVoice</a> &other) const noexcept</td></tr>
<tr class="memdesc:a1682e06d31bdb7fce2d4d692de9e6b8c"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this voice started playing its current note before the other voice did. <a href="#a1682e06d31bdb7fce2d4d692de9e6b8c">More...</a><br /></td></tr>
<tr class="separator:a1682e06d31bdb7fce2d4d692de9e6b8c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ac4c127e835481315ebd02421edf15bd5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#ac4c127e835481315ebd02421edf15bd5">clearCurrentNote</a> () noexcept</td></tr>
<tr class="memdesc:ac4c127e835481315ebd02421edf15bd5"><td class="mdescLeft"> </td><td class="mdescRight">Resets the state of this voice after a sound has finished playing. <a href="#ac4c127e835481315ebd02421edf15bd5">More...</a><br /></td></tr>
<tr class="separator:ac4c127e835481315ebd02421edf15bd5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a9310a73a44408ab65dfb9b875917c354"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#a9310a73a44408ab65dfb9b875917c354">currentSampleRate</a></td></tr>
<tr class="separator:a9310a73a44408ab65dfb9b875917c354"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea34fcbdb3fa0961f73d5f9a1f34e255"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMPENote.html">MPENote</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPESynthesiserVoice.html#aea34fcbdb3fa0961f73d5f9a1f34e255">currentlyPlayingNote</a></td></tr>
<tr class="separator:aea34fcbdb3fa0961f73d5f9a1f34e255"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents an MPE voice that an <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> can use to play a sound. </p>
<p>A voice plays a single sound at a time, and a synthesiser holds an array of voices so that it can play polyphonically.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a>, <a class="el" href="structMPENote.html" title="This struct represents a playing MPE note. ">MPENote</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ac249363fa7744946af9dbcc335479ffa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac249363fa7744946af9dbcc335479ffa">§ </a></span>MPESynthesiserVoice()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MPESynthesiserVoice::MPESynthesiserVoice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a id="ab347e2d6583493d04dce1d0cefe825ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab347e2d6583493d04dce1d0cefe825ba">§ </a></span>~MPESynthesiserVoice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual MPESynthesiserVoice::~MPESynthesiserVoice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a073572535bfb518f0825b72ad52ddccb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a073572535bfb518f0825b72ad52ddccb">§ </a></span>getCurrentlyPlayingNote()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMPENote.html">MPENote</a> MPESynthesiserVoice::getCurrentlyPlayingNote </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <a class="el" href="structMPENote.html" title="This struct represents a playing MPE note. ">MPENote</a> that this voice is currently playing. </p>
<p>Returns an invalid <a class="el" href="structMPENote.html" title="This struct represents a playing MPE note. ">MPENote</a> if no note is playing (you can check this using <a class="el" href="structMPENote.html#a7cc337facd416d2da4ff19a16af1f842" title="Checks whether the MPE note is valid. ">MPENote::isValid()</a> or MPEVoice::isActive()). </p>
</div>
</div>
<a id="a930a864916a6278169e2a02f62058dc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a930a864916a6278169e2a02f62058dc1">§ </a></span>isCurrentlyPlayingNote()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool MPESynthesiserVoice::isCurrentlyPlayingNote </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMPENote.html">MPENote</a> </td>
<td class="paramname"><em>note</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the voice is currently playing the given <a class="el" href="structMPENote.html" title="This struct represents a playing MPE note. ">MPENote</a> (as identified by the note's initial note number and MIDI channel). </p>
</div>
</div>
<a id="afbb658b840fa1568fa2565c254ed9692"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbb658b840fa1568fa2565c254ed9692">§ </a></span>isActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool MPESynthesiserVoice::isActive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this voice is currently busy playing a sound. </p>
<p>By default this just checks whether <a class="el" href="classMPESynthesiserVoice.html#a073572535bfb518f0825b72ad52ddccb" title="Returns the MPENote that this voice is currently playing. ">getCurrentlyPlayingNote()</a> returns a valid MPE note, but can be overridden for more advanced checking. </p>
</div>
</div>
<a id="af5ba4a685cf06eb2be693c237135ad0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5ba4a685cf06eb2be693c237135ad0b">§ </a></span>isPlayingButReleased()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool MPESynthesiserVoice::isPlayingButReleased </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if a voice is sounding in its release phase. </p>
</div>
</div>
<a id="ae10c1cdfb37208b96b56863d47a3a193"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae10c1cdfb37208b96b56863d47a3a193">§ </a></span>noteStarted()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void MPESynthesiserVoice::noteStarted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by the <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> to let the voice know that a new note has started on it. </p>
<p>This will be called during the rendering callback, so must be fast and thread-safe. </p>
</div>
</div>
<a id="a60d75565bb6ef14262aa3e5ab5c94328"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60d75565bb6ef14262aa3e5ab5c94328">§ </a></span>noteStopped()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void MPESynthesiserVoice::noteStopped </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>allowTailOff</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by the <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> to let the voice know that its currently playing note has stopped. </p>
<p>This will be called during the rendering callback, so must be fast and thread-safe.</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="classMPESynthesiserVoice.html#ac4c127e835481315ebd02421edf15bd5" 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="classMPESynthesiserVoice.html#ac4c127e835481315ebd02421edf15bd5" title="Resets the state of this voice after a sound has finished playing. ">clearCurrentNote()</a>. </p>
</div>
</div>
<a id="a10d814de2c8a444040adfd90425a72d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10d814de2c8a444040adfd90425a72d8">§ </a></span>notePressureChanged()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void MPESynthesiserVoice::notePressureChanged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by the <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> to let the voice know that its currently playing note has changed its pressure value. </p>
<p>This will be called during the rendering callback, so must be fast and thread-safe. </p>
</div>
</div>
<a id="afef5b8e0cad53c4257ed78f6e7a04be5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afef5b8e0cad53c4257ed78f6e7a04be5">§ </a></span>notePitchbendChanged()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void MPESynthesiserVoice::notePitchbendChanged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by the <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> to let the voice know that its currently playing note has changed its pitchbend value. </p>
<p>This will be called during the rendering callback, so must be fast and thread-safe.</p>
<p>Note: You can call currentlyPlayingNote.getFrequencyInHertz() to find out the effective frequency of the note, as a sum of the initial note number, the per-note pitchbend and the master pitchbend. </p>
</div>
</div>
<a id="ad2f36b71807fd1ac15c52f480702112f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2f36b71807fd1ac15c52f480702112f">§ </a></span>noteTimbreChanged()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void MPESynthesiserVoice::noteTimbreChanged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by the <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> to let the voice know that its currently playing note has changed its timbre value. </p>
<p>This will be called during the rendering callback, so must be fast and thread-safe. </p>
</div>
</div>
<a id="aa2cd567d2206dad122b91f51cecce6e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2cd567d2206dad122b91f51cecce6e2">§ </a></span>noteKeyStateChanged()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void MPESynthesiserVoice::noteKeyStateChanged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by the <a class="el" href="classMPESynthesiser.html" title="Base class for an MPE-compatible musical device that can play sounds. ">MPESynthesiser</a> to let the voice know that its currently playing note has changed its key state. </p>
<p>This typically happens when a sustain or sostenuto pedal is pressed or released (on an MPE channel relevant for this note), or if the note key is lifted while the sustained or sostenuto pedal is still held down. This will be called during the rendering callback, so must be fast and thread-safe. </p>
</div>
</div>
<a id="a204b1557448a7de667171620525d4023"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a204b1557448a7de667171620525d4023">§ </a></span>renderNextBlock() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void MPESynthesiserVoice::renderNextBlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAudioBuffer.html">AudioBuffer</a>< float > & </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">pure 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="classMPESynthesiserVoice.html#ac4c127e835481315ebd02421edf15bd5" 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>
</div>
</div>
<a id="a22e7b9bd5d46036908641a7ae386b283"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22e7b9bd5d46036908641a7ae386b283">§ </a></span>renderNextBlock() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void MPESynthesiserVoice::renderNextBlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAudioBuffer.html">AudioBuffer</a>< double > & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Renders the next block of 64-bit data for this voice. </p>
<p>Support for 64-bit audio is optional. You can choose to not override this method if you don't need it (the default implementation simply does nothing). </p>
</div>
</div>
<a id="a0cc2f469d88ea14b0e48476017da70a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cc2f469d88ea14b0e48476017da70a7">§ </a></span>setCurrentSampleRate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void MPESynthesiserVoice::setCurrentSampleRate </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>newRate</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the voice's reference sample rate. </p>
<p>The rate is set so that subclasses know the output rate and can set their pitch accordingly.</p>
<p>This method is called by the synth, and subclasses can access the current rate with the currentSampleRate member. </p>
</div>
</div>
<a id="ae4a38948a044093709fcfa2295a8110a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4a38948a044093709fcfa2295a8110a">§ </a></span>getSampleRate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double MPESynthesiserVoice::getSampleRate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current target sample rate at which rendering is being done. </p>
<p>Subclasses may need to know this so that they can pitch things correctly. </p>
</div>
</div>
<a id="a1682e06d31bdb7fce2d4d692de9e6b8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1682e06d31bdb7fce2d4d692de9e6b8c">§ </a></span>wasStartedBefore()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool MPESynthesiserVoice::wasStartedBefore </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classMPESynthesiserVoice.html">MPESynthesiserVoice</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this voice started playing its current note before the other voice did. </p>
</div>
</div>
<a id="ac4c127e835481315ebd02421edf15bd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4c127e835481315ebd02421edf15bd5">§ </a></span>clearCurrentNote()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MPESynthesiserVoice::clearCurrentNote </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the state of this voice after a sound has finished playing. </p>
<p>The subclass must call this when it finishes playing a note and becomes available to play new ones.</p>
<p>It must either call it in the stopNote() method, or if the voice is tailing off, then it should call it later during the renderNextBlock method, as soon as it finishes its tail-off.</p>
<p>It can also be called at any time during the render callback if the sound happens to have finished, e.g. if it's playing a sample and the sample finishes. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9310a73a44408ab65dfb9b875917c354"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9310a73a44408ab65dfb9b875917c354">§ </a></span>currentSampleRate</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double MPESynthesiserVoice::currentSampleRate</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aea34fcbdb3fa0961f73d5f9a1f34e255"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea34fcbdb3fa0961f73d5f9a1f34e255">§ </a></span>currentlyPlayingNote</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMPENote.html">MPENote</a> MPESynthesiserVoice::currentlyPlayingNote</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__MPESynthesiserVoice_8h.html">juce_MPESynthesiserVoice.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|