/usr/share/doc/libjuce/apiref/classAudioIODevice.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 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 | <!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: AudioIODevice 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="classAudioIODevice-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AudioIODevice Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for an audio device with synchronised input and output channels.
<a href="classAudioIODevice.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:a0af67fc5598fb5fd9b033d3938968a51"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a0af67fc5598fb5fd9b033d3938968a51">~AudioIODevice</a> ()</td></tr>
<tr class="memdesc:a0af67fc5598fb5fd9b033d3938968a51"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a0af67fc5598fb5fd9b033d3938968a51">More...</a><br /></td></tr>
<tr class="separator:a0af67fc5598fb5fd9b033d3938968a51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb1c4b56c8aa943f0507ed1776369a80"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#abb1c4b56c8aa943f0507ed1776369a80">getName</a> () const noexcept</td></tr>
<tr class="memdesc:abb1c4b56c8aa943f0507ed1776369a80"><td class="mdescLeft"> </td><td class="mdescRight">Returns the device's name, (as set in the constructor). <a href="#abb1c4b56c8aa943f0507ed1776369a80">More...</a><br /></td></tr>
<tr class="separator:abb1c4b56c8aa943f0507ed1776369a80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb989e3b415936f70fb68e8a37bdb813"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#acb989e3b415936f70fb68e8a37bdb813">getTypeName</a> () const noexcept</td></tr>
<tr class="memdesc:acb989e3b415936f70fb68e8a37bdb813"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of the device. <a href="#acb989e3b415936f70fb68e8a37bdb813">More...</a><br /></td></tr>
<tr class="separator:acb989e3b415936f70fb68e8a37bdb813"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49d09c50d23685dfeb881594c6e8a621"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classStringArray.html">StringArray</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a49d09c50d23685dfeb881594c6e8a621">getOutputChannelNames</a> ()=0</td></tr>
<tr class="memdesc:a49d09c50d23685dfeb881594c6e8a621"><td class="mdescLeft"> </td><td class="mdescRight">Returns the names of all the available output channels on this device. <a href="#a49d09c50d23685dfeb881594c6e8a621">More...</a><br /></td></tr>
<tr class="separator:a49d09c50d23685dfeb881594c6e8a621"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabb8e29146abb9aeb60dea604288c8a7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classStringArray.html">StringArray</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#aabb8e29146abb9aeb60dea604288c8a7">getInputChannelNames</a> ()=0</td></tr>
<tr class="memdesc:aabb8e29146abb9aeb60dea604288c8a7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the names of all the available input channels on this device. <a href="#aabb8e29146abb9aeb60dea604288c8a7">More...</a><br /></td></tr>
<tr class="separator:aabb8e29146abb9aeb60dea604288c8a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18f3fef68c17f7d1b8e6d79493b0422c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classArray.html">Array</a>< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a18f3fef68c17f7d1b8e6d79493b0422c">getAvailableSampleRates</a> ()=0</td></tr>
<tr class="memdesc:a18f3fef68c17f7d1b8e6d79493b0422c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of sample-rates this device supports. <a href="#a18f3fef68c17f7d1b8e6d79493b0422c">More...</a><br /></td></tr>
<tr class="separator:a18f3fef68c17f7d1b8e6d79493b0422c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a3c62edc30e0b7c1ff0ddd8a789f5da"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classArray.html">Array</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a9a3c62edc30e0b7c1ff0ddd8a789f5da">getAvailableBufferSizes</a> ()=0</td></tr>
<tr class="memdesc:a9a3c62edc30e0b7c1ff0ddd8a789f5da"><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of buffer sizes that are available. <a href="#a9a3c62edc30e0b7c1ff0ddd8a789f5da">More...</a><br /></td></tr>
<tr class="separator:a9a3c62edc30e0b7c1ff0ddd8a789f5da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71384f0310a9f6850cd826d0fd91f8f4"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a71384f0310a9f6850cd826d0fd91f8f4">getDefaultBufferSize</a> ()=0</td></tr>
<tr class="memdesc:a71384f0310a9f6850cd826d0fd91f8f4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the default buffer-size to use. <a href="#a71384f0310a9f6850cd826d0fd91f8f4">More...</a><br /></td></tr>
<tr class="separator:a71384f0310a9f6850cd826d0fd91f8f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a519b91efd6bf7bf88fbe85eb5510629f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a519b91efd6bf7bf88fbe85eb5510629f">open</a> (const <a class="el" href="classBigInteger.html">BigInteger</a> &inputChannels, const <a class="el" href="classBigInteger.html">BigInteger</a> &outputChannels, double sampleRate, int bufferSizeSamples)=0</td></tr>
<tr class="memdesc:a519b91efd6bf7bf88fbe85eb5510629f"><td class="mdescLeft"> </td><td class="mdescRight">Tries to open the device ready to play. <a href="#a519b91efd6bf7bf88fbe85eb5510629f">More...</a><br /></td></tr>
<tr class="separator:a519b91efd6bf7bf88fbe85eb5510629f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ca9104dc82d77961b3dfcc005810004"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a7ca9104dc82d77961b3dfcc005810004">close</a> ()=0</td></tr>
<tr class="memdesc:a7ca9104dc82d77961b3dfcc005810004"><td class="mdescLeft"> </td><td class="mdescRight">Closes and releases the device if it's open. <a href="#a7ca9104dc82d77961b3dfcc005810004">More...</a><br /></td></tr>
<tr class="separator:a7ca9104dc82d77961b3dfcc005810004"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebfdd9a70545dd500041cd7e5cd736c1"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#aebfdd9a70545dd500041cd7e5cd736c1">isOpen</a> ()=0</td></tr>
<tr class="memdesc:aebfdd9a70545dd500041cd7e5cd736c1"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the device is still open. <a href="#aebfdd9a70545dd500041cd7e5cd736c1">More...</a><br /></td></tr>
<tr class="separator:aebfdd9a70545dd500041cd7e5cd736c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3a17cf757a6297aab23a1327579347f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#aa3a17cf757a6297aab23a1327579347f">start</a> (<a class="el" href="classAudioIODeviceCallback.html">AudioIODeviceCallback</a> *callback)=0</td></tr>
<tr class="memdesc:aa3a17cf757a6297aab23a1327579347f"><td class="mdescLeft"> </td><td class="mdescRight">Starts the device actually playing. <a href="#aa3a17cf757a6297aab23a1327579347f">More...</a><br /></td></tr>
<tr class="separator:aa3a17cf757a6297aab23a1327579347f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca2e8897d904bc36b5faa647cfa8d20a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#aca2e8897d904bc36b5faa647cfa8d20a">stop</a> ()=0</td></tr>
<tr class="memdesc:aca2e8897d904bc36b5faa647cfa8d20a"><td class="mdescLeft"> </td><td class="mdescRight">Stops the device playing. <a href="#aca2e8897d904bc36b5faa647cfa8d20a">More...</a><br /></td></tr>
<tr class="separator:aca2e8897d904bc36b5faa647cfa8d20a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8b5c71cb2512bcdf477267e3fc4faf7"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#af8b5c71cb2512bcdf477267e3fc4faf7">isPlaying</a> ()=0</td></tr>
<tr class="memdesc:af8b5c71cb2512bcdf477267e3fc4faf7"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the device is still calling back. <a href="#af8b5c71cb2512bcdf477267e3fc4faf7">More...</a><br /></td></tr>
<tr class="separator:af8b5c71cb2512bcdf477267e3fc4faf7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4cfb59b5782efabcb31b225a69bd9b12"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a4cfb59b5782efabcb31b225a69bd9b12">getLastError</a> ()=0</td></tr>
<tr class="memdesc:a4cfb59b5782efabcb31b225a69bd9b12"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last error that happened if anything went wrong. <a href="#a4cfb59b5782efabcb31b225a69bd9b12">More...</a><br /></td></tr>
<tr class="separator:a4cfb59b5782efabcb31b225a69bd9b12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7636fe06f58b58c41bc8575184f518f"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#af7636fe06f58b58c41bc8575184f518f">getCurrentBufferSizeSamples</a> ()=0</td></tr>
<tr class="memdesc:af7636fe06f58b58c41bc8575184f518f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the buffer size that the device is currently using. <a href="#af7636fe06f58b58c41bc8575184f518f">More...</a><br /></td></tr>
<tr class="separator:af7636fe06f58b58c41bc8575184f518f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afba31b6d244b7cc257e925a04c5c383c"><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#afba31b6d244b7cc257e925a04c5c383c">getCurrentSampleRate</a> ()=0</td></tr>
<tr class="memdesc:afba31b6d244b7cc257e925a04c5c383c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the sample rate that the device is currently using. <a href="#afba31b6d244b7cc257e925a04c5c383c">More...</a><br /></td></tr>
<tr class="separator:afba31b6d244b7cc257e925a04c5c383c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abab889e2e9ff5dd49626faa15bfbac37"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#abab889e2e9ff5dd49626faa15bfbac37">getCurrentBitDepth</a> ()=0</td></tr>
<tr class="memdesc:abab889e2e9ff5dd49626faa15bfbac37"><td class="mdescLeft"> </td><td class="mdescRight">Returns the device's current physical bit-depth. <a href="#abab889e2e9ff5dd49626faa15bfbac37">More...</a><br /></td></tr>
<tr class="separator:abab889e2e9ff5dd49626faa15bfbac37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f8af9affa191545e0722d07c3157cd2"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classBigInteger.html">BigInteger</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a4f8af9affa191545e0722d07c3157cd2">getActiveOutputChannels</a> () const =0</td></tr>
<tr class="memdesc:a4f8af9affa191545e0722d07c3157cd2"><td class="mdescLeft"> </td><td class="mdescRight">Returns a mask showing which of the available output channels are currently enabled. <a href="#a4f8af9affa191545e0722d07c3157cd2">More...</a><br /></td></tr>
<tr class="separator:a4f8af9affa191545e0722d07c3157cd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8020f07359040702d9339dff1628f940"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classBigInteger.html">BigInteger</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a8020f07359040702d9339dff1628f940">getActiveInputChannels</a> () const =0</td></tr>
<tr class="memdesc:a8020f07359040702d9339dff1628f940"><td class="mdescLeft"> </td><td class="mdescRight">Returns a mask showing which of the available input channels are currently enabled. <a href="#a8020f07359040702d9339dff1628f940">More...</a><br /></td></tr>
<tr class="separator:a8020f07359040702d9339dff1628f940"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a693804fbf5a7cceb31ece10a9f03bd11"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a693804fbf5a7cceb31ece10a9f03bd11">getOutputLatencyInSamples</a> ()=0</td></tr>
<tr class="memdesc:a693804fbf5a7cceb31ece10a9f03bd11"><td class="mdescLeft"> </td><td class="mdescRight">Returns the device's output latency. <a href="#a693804fbf5a7cceb31ece10a9f03bd11">More...</a><br /></td></tr>
<tr class="separator:a693804fbf5a7cceb31ece10a9f03bd11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3998b9256b8f5056e5e1cbf17c3e520d"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a3998b9256b8f5056e5e1cbf17c3e520d">getInputLatencyInSamples</a> ()=0</td></tr>
<tr class="memdesc:a3998b9256b8f5056e5e1cbf17c3e520d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the device's input latency. <a href="#a3998b9256b8f5056e5e1cbf17c3e520d">More...</a><br /></td></tr>
<tr class="separator:a3998b9256b8f5056e5e1cbf17c3e520d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab85840f9ead545d0b3664d55158fd581"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#ab85840f9ead545d0b3664d55158fd581">hasControlPanel</a> () const</td></tr>
<tr class="memdesc:ab85840f9ead545d0b3664d55158fd581"><td class="mdescLeft"> </td><td class="mdescRight">True if this device can show a pop-up control panel for editing its settings. <a href="#ab85840f9ead545d0b3664d55158fd581">More...</a><br /></td></tr>
<tr class="separator:ab85840f9ead545d0b3664d55158fd581"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8871c0f3b0639e0408582b354b28247"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#ab8871c0f3b0639e0408582b354b28247">showControlPanel</a> ()</td></tr>
<tr class="memdesc:ab8871c0f3b0639e0408582b354b28247"><td class="mdescLeft"> </td><td class="mdescRight">Shows a device-specific control panel if there is one. <a href="#ab8871c0f3b0639e0408582b354b28247">More...</a><br /></td></tr>
<tr class="separator:ab8871c0f3b0639e0408582b354b28247"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a413f736464f6fdfe09dbd31f17afa0b0"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a413f736464f6fdfe09dbd31f17afa0b0">setAudioPreprocessingEnabled</a> (bool shouldBeEnabled)</td></tr>
<tr class="memdesc:a413f736464f6fdfe09dbd31f17afa0b0"><td class="mdescLeft"> </td><td class="mdescRight">On devices which support it, this allows automatic gain control or other mic processing to be disabled. <a href="#a413f736464f6fdfe09dbd31f17afa0b0">More...</a><br /></td></tr>
<tr class="separator:a413f736464f6fdfe09dbd31f17afa0b0"><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:aa380a49e49176fb883d89b094bf2448c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#aa380a49e49176fb883d89b094bf2448c">AudioIODevice</a> (const <a class="el" href="classString.html">String</a> &deviceName, const <a class="el" href="classString.html">String</a> &<a class="el" href="classAudioIODevice.html#a0f3aec64dbabccdd7a9a688def70cf45">typeName</a>)</td></tr>
<tr class="memdesc:aa380a49e49176fb883d89b094bf2448c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a device, setting its name and type member variables. <a href="#aa380a49e49176fb883d89b094bf2448c">More...</a><br /></td></tr>
<tr class="separator:aa380a49e49176fb883d89b094bf2448c"><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:a8f0fcd3c3672601cfd44749221452ebc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a8f0fcd3c3672601cfd44749221452ebc">name</a></td></tr>
<tr class="separator:a8f0fcd3c3672601cfd44749221452ebc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f3aec64dbabccdd7a9a688def70cf45"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODevice.html#a0f3aec64dbabccdd7a9a688def70cf45">typeName</a></td></tr>
<tr class="separator:a0f3aec64dbabccdd7a9a688def70cf45"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for an audio device with synchronised input and output channels. </p>
<p>Subclasses of this are used to implement different protocols such as DirectSound, ASIO, CoreAudio, etc.</p>
<p>To create one of these, you'll need to use the <a class="el" href="classAudioIODeviceType.html" title="Represents a type of audio driver, such as DirectSound, ASIO, CoreAudio, etc. ">AudioIODeviceType</a> class - see the documentation for that class for more info.</p>
<p>For an easier way of managing audio devices and their settings, have a look at the <a class="el" href="classAudioDeviceManager.html" title="Manages the state of some audio and midi i/o devices. ">AudioDeviceManager</a> class.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioIODeviceType.html" title="Represents a type of audio driver, such as DirectSound, ASIO, CoreAudio, etc. ">AudioIODeviceType</a>, <a class="el" href="classAudioDeviceManager.html" title="Manages the state of some audio and midi i/o devices. ">AudioDeviceManager</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a0af67fc5598fb5fd9b033d3938968a51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0af67fc5598fb5fd9b033d3938968a51">§ </a></span>~AudioIODevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual AudioIODevice::~AudioIODevice </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>
<a id="aa380a49e49176fb883d89b094bf2448c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa380a49e49176fb883d89b094bf2448c">§ </a></span>AudioIODevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">AudioIODevice::AudioIODevice </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>deviceName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>typeName</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">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a device, setting its name and type member variables. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abb1c4b56c8aa943f0507ed1776369a80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb1c4b56c8aa943f0507ed1776369a80">§ </a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classString.html">String</a>& AudioIODevice::getName </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 device's name, (as set in the constructor). </p>
</div>
</div>
<a id="acb989e3b415936f70fb68e8a37bdb813"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb989e3b415936f70fb68e8a37bdb813">§ </a></span>getTypeName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classString.html">String</a>& AudioIODevice::getTypeName </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 type of the device. </p>
<p>E.g. "CoreAudio", "ASIO", etc. - this comes from the <a class="el" href="classAudioIODeviceType.html" title="Represents a type of audio driver, such as DirectSound, ASIO, CoreAudio, etc. ">AudioIODeviceType</a> that created it. </p>
</div>
</div>
<a id="a49d09c50d23685dfeb881594c6e8a621"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49d09c50d23685dfeb881594c6e8a621">§ </a></span>getOutputChannelNames()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classStringArray.html">StringArray</a> AudioIODevice::getOutputChannelNames </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>Returns the names of all the available output channels on this device. </p>
<p>To find out which of these are currently in use, call <a class="el" href="classAudioIODevice.html#a4f8af9affa191545e0722d07c3157cd2" title="Returns a mask showing which of the available output channels are currently enabled. ">getActiveOutputChannels()</a>. </p>
</div>
</div>
<a id="aabb8e29146abb9aeb60dea604288c8a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabb8e29146abb9aeb60dea604288c8a7">§ </a></span>getInputChannelNames()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classStringArray.html">StringArray</a> AudioIODevice::getInputChannelNames </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>Returns the names of all the available input channels on this device. </p>
<p>To find out which of these are currently in use, call <a class="el" href="classAudioIODevice.html#a8020f07359040702d9339dff1628f940" title="Returns a mask showing which of the available input channels are currently enabled. ">getActiveInputChannels()</a>. </p>
</div>
</div>
<a id="a18f3fef68c17f7d1b8e6d79493b0422c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18f3fef68c17f7d1b8e6d79493b0422c">§ </a></span>getAvailableSampleRates()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classArray.html">Array</a><double> AudioIODevice::getAvailableSampleRates </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>Returns the set of sample-rates this device supports. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioIODevice.html#afba31b6d244b7cc257e925a04c5c383c" title="Returns the sample rate that the device is currently using. ">getCurrentSampleRate</a> </dd></dl>
</div>
</div>
<a id="a9a3c62edc30e0b7c1ff0ddd8a789f5da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a3c62edc30e0b7c1ff0ddd8a789f5da">§ </a></span>getAvailableBufferSizes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classArray.html">Array</a><int> AudioIODevice::getAvailableBufferSizes </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>Returns the set of buffer sizes that are available. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioIODevice.html#af7636fe06f58b58c41bc8575184f518f" title="Returns the buffer size that the device is currently using. ">getCurrentBufferSizeSamples</a>, <a class="el" href="classAudioIODevice.html#a71384f0310a9f6850cd826d0fd91f8f4" title="Returns the default buffer-size to use. ">getDefaultBufferSize</a> </dd></dl>
</div>
</div>
<a id="a71384f0310a9f6850cd826d0fd91f8f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71384f0310a9f6850cd826d0fd91f8f4">§ </a></span>getDefaultBufferSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int AudioIODevice::getDefaultBufferSize </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>Returns the default buffer-size to use. </p>
<dl class="section return"><dt>Returns</dt><dd>a number of samples </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioIODevice.html#a9a3c62edc30e0b7c1ff0ddd8a789f5da" title="Returns the set of buffer sizes that are available. ">getAvailableBufferSizes</a> </dd></dl>
</div>
</div>
<a id="a519b91efd6bf7bf88fbe85eb5510629f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a519b91efd6bf7bf88fbe85eb5510629f">§ </a></span>open()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classString.html">String</a> AudioIODevice::open </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBigInteger.html">BigInteger</a> & </td>
<td class="paramname"><em>inputChannels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classBigInteger.html">BigInteger</a> & </td>
<td class="paramname"><em>outputChannels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>sampleRate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>bufferSizeSamples</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>Tries to open the device ready to play. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputChannels</td><td>a <a class="el" href="classBigInteger.html" title="An arbitrarily large integer class. ">BigInteger</a> in which a set bit indicates that the corresponding input channel should be enabled </td></tr>
<tr><td class="paramname">outputChannels</td><td>a <a class="el" href="classBigInteger.html" title="An arbitrarily large integer class. ">BigInteger</a> in which a set bit indicates that the corresponding output channel should be enabled </td></tr>
<tr><td class="paramname">sampleRate</td><td>the sample rate to try to use - to find out which rates are available, see <a class="el" href="classAudioIODevice.html#a18f3fef68c17f7d1b8e6d79493b0422c" title="Returns the set of sample-rates this device supports. ">getAvailableSampleRates()</a> </td></tr>
<tr><td class="paramname">bufferSizeSamples</td><td>the size of i/o buffer to use - to find out the available buffer sizes, see <a class="el" href="classAudioIODevice.html#a9a3c62edc30e0b7c1ff0ddd8a789f5da" title="Returns the set of buffer sizes that are available. ">getAvailableBufferSizes()</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an error description if there's a problem, or an empty string if it succeeds in opening the device </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioIODevice.html#a7ca9104dc82d77961b3dfcc005810004" title="Closes and releases the device if it's open. ">close</a> </dd></dl>
</div>
</div>
<a id="a7ca9104dc82d77961b3dfcc005810004"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ca9104dc82d77961b3dfcc005810004">§ </a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void AudioIODevice::close </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>Closes and releases the device if it's open. </p>
</div>
</div>
<a id="aebfdd9a70545dd500041cd7e5cd736c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebfdd9a70545dd500041cd7e5cd736c1">§ </a></span>isOpen()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool AudioIODevice::isOpen </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>Returns true if the device is still open. </p>
<p>A device might spontaneously close itself if something goes wrong, so this checks if it's still open. </p>
</div>
</div>
<a id="aa3a17cf757a6297aab23a1327579347f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3a17cf757a6297aab23a1327579347f">§ </a></span>start()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void AudioIODevice::start </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAudioIODeviceCallback.html">AudioIODeviceCallback</a> * </td>
<td class="paramname"><em>callback</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>Starts the device actually playing. </p>
<p>This must be called after the device has been opened.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callback</td><td>the callback to use for streaming the data. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioIODeviceCallback.html" title="One of these is passed to an AudioIODevice object to stream the audio data in and out...">AudioIODeviceCallback</a>, <a class="el" href="classAudioIODevice.html#a519b91efd6bf7bf88fbe85eb5510629f" title="Tries to open the device ready to play. ">open</a> </dd></dl>
</div>
</div>
<a id="aca2e8897d904bc36b5faa647cfa8d20a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca2e8897d904bc36b5faa647cfa8d20a">§ </a></span>stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void AudioIODevice::stop </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>Stops the device playing. </p>
<p>Once a device has been started, this will stop it. Any pending calls to the callback class will be flushed before this method returns. </p>
</div>
</div>
<a id="af8b5c71cb2512bcdf477267e3fc4faf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8b5c71cb2512bcdf477267e3fc4faf7">§ </a></span>isPlaying()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool AudioIODevice::isPlaying </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>Returns true if the device is still calling back. </p>
<p>The device might mysteriously stop, so this checks whether it's still playing. </p>
</div>
</div>
<a id="a4cfb59b5782efabcb31b225a69bd9b12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cfb59b5782efabcb31b225a69bd9b12">§ </a></span>getLastError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classString.html">String</a> AudioIODevice::getLastError </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>Returns the last error that happened if anything went wrong. </p>
</div>
</div>
<a id="af7636fe06f58b58c41bc8575184f518f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7636fe06f58b58c41bc8575184f518f">§ </a></span>getCurrentBufferSizeSamples()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int AudioIODevice::getCurrentBufferSizeSamples </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>Returns the buffer size that the device is currently using. </p>
<p>If the device isn't actually open, this value doesn't really mean much. </p>
</div>
</div>
<a id="afba31b6d244b7cc257e925a04c5c383c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afba31b6d244b7cc257e925a04c5c383c">§ </a></span>getCurrentSampleRate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double AudioIODevice::getCurrentSampleRate </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>Returns the sample rate that the device is currently using. </p>
<p>If the device isn't actually open, this value doesn't really mean much. </p>
</div>
</div>
<a id="abab889e2e9ff5dd49626faa15bfbac37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abab889e2e9ff5dd49626faa15bfbac37">§ </a></span>getCurrentBitDepth()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int AudioIODevice::getCurrentBitDepth </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>Returns the device's current physical bit-depth. </p>
<p>If the device isn't actually open, this value doesn't really mean much. </p>
</div>
</div>
<a id="a4f8af9affa191545e0722d07c3157cd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f8af9affa191545e0722d07c3157cd2">§ </a></span>getActiveOutputChannels()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classBigInteger.html">BigInteger</a> AudioIODevice::getActiveOutputChannels </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a mask showing which of the available output channels are currently enabled. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioIODevice.html#a49d09c50d23685dfeb881594c6e8a621" title="Returns the names of all the available output channels on this device. ">getOutputChannelNames</a> </dd></dl>
</div>
</div>
<a id="a8020f07359040702d9339dff1628f940"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8020f07359040702d9339dff1628f940">§ </a></span>getActiveInputChannels()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classBigInteger.html">BigInteger</a> AudioIODevice::getActiveInputChannels </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a mask showing which of the available input channels are currently enabled. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioIODevice.html#aabb8e29146abb9aeb60dea604288c8a7" title="Returns the names of all the available input channels on this device. ">getInputChannelNames</a> </dd></dl>
</div>
</div>
<a id="a693804fbf5a7cceb31ece10a9f03bd11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a693804fbf5a7cceb31ece10a9f03bd11">§ </a></span>getOutputLatencyInSamples()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int AudioIODevice::getOutputLatencyInSamples </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>Returns the device's output latency. </p>
<p>This is the delay in samples between a callback getting a block of data, and that data actually getting played. </p>
</div>
</div>
<a id="a3998b9256b8f5056e5e1cbf17c3e520d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3998b9256b8f5056e5e1cbf17c3e520d">§ </a></span>getInputLatencyInSamples()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int AudioIODevice::getInputLatencyInSamples </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>Returns the device's input latency. </p>
<p>This is the delay in samples between some audio actually arriving at the soundcard, and the callback getting passed this block of data. </p>
</div>
</div>
<a id="ab85840f9ead545d0b3664d55158fd581"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab85840f9ead545d0b3664d55158fd581">§ </a></span>hasControlPanel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool AudioIODevice::hasControlPanel </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>True if this device can show a pop-up control panel for editing its settings. </p>
<p>This is generally just true of ASIO devices. If true, you can call <a class="el" href="classAudioIODevice.html#ab8871c0f3b0639e0408582b354b28247" title="Shows a device-specific control panel if there is one. ">showControlPanel()</a> to display it. </p>
</div>
</div>
<a id="ab8871c0f3b0639e0408582b354b28247"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8871c0f3b0639e0408582b354b28247">§ </a></span>showControlPanel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool AudioIODevice::showControlPanel </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>Shows a device-specific control panel if there is one. </p>
<p>This should only be called for devices which return true from <a class="el" href="classAudioIODevice.html#ab85840f9ead545d0b3664d55158fd581" title="True if this device can show a pop-up control panel for editing its settings. ">hasControlPanel()</a>. </p>
</div>
</div>
<a id="a413f736464f6fdfe09dbd31f17afa0b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a413f736464f6fdfe09dbd31f17afa0b0">§ </a></span>setAudioPreprocessingEnabled()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool AudioIODevice::setAudioPreprocessingEnabled </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>shouldBeEnabled</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>On devices which support it, this allows automatic gain control or other mic processing to be disabled. </p>
<p>If the device doesn't support this operation, it'll return false. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8f0fcd3c3672601cfd44749221452ebc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f0fcd3c3672601cfd44749221452ebc">§ </a></span>name</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="classString.html">String</a> AudioIODevice::name</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="a0f3aec64dbabccdd7a9a688def70cf45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f3aec64dbabccdd7a9a688def70cf45">§ </a></span>typeName</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="classString.html">String</a> AudioIODevice::typeName</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__AudioIODevice_8h.html">juce_AudioIODevice.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|