/usr/share/doc/portaudio19-doc/doc/html/portaudio_8h.html is in portaudio19-doc 19+svn20140130-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 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 | <!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.6"/>
<title>PortAudio: portaudio.h File 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="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 style="padding-left: 0.5em;">
<div id="projectname">PortAudio
 <span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">portaudio.h File Reference<div class="ingroups"><a class="el" href="group__public__header.html">Public API definitions for users of PortAudio</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The portable PortAudio API.
<a href="#details">More...</a></p>
<p><a href="portaudio_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPaHostErrorInfo.html">PaHostErrorInfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPaStreamParameters.html">PaStreamParameters</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPaStreamCallbackTimeInfo.html">PaStreamCallbackTimeInfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPaStreamInfo.html">PaStreamInfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a8c26dd5e6f28bb4cda7a1f5460282297"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a8c26dd5e6f28bb4cda7a1f5460282297">paNoDevice</a>   ((<a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a>)-1)</td></tr>
<tr class="separator:a8c26dd5e6f28bb4cda7a1f5460282297"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14795fe3377c3b037025a61e550d44b5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a14795fe3377c3b037025a61e550d44b5">paUseHostApiSpecificDeviceSpecification</a>   ((<a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a>)-2)</td></tr>
<tr class="separator:a14795fe3377c3b037025a61e550d44b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f16d29916725b8791eae60ab9e0b081"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a2f16d29916725b8791eae60ab9e0b081">paFloat32</a>   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00000001)</td></tr>
<tr class="separator:a2f16d29916725b8791eae60ab9e0b081"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6fea69f3d81b628288325c06310b2fcf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a6fea69f3d81b628288325c06310b2fcf">paInt32</a>   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00000002)</td></tr>
<tr class="separator:a6fea69f3d81b628288325c06310b2fcf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f891a0bd9e94a94a8f446c176b749e7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a7f891a0bd9e94a94a8f446c176b749e7">paInt24</a>   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00000004)</td></tr>
<tr class="separator:a7f891a0bd9e94a94a8f446c176b749e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab284f8e0a161d78ede863aec45461dbd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ab284f8e0a161d78ede863aec45461dbd">paInt16</a>   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00000008)</td></tr>
<tr class="separator:ab284f8e0a161d78ede863aec45461dbd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a058ecfb48ac9f0efad7a7b0d446efe3e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a058ecfb48ac9f0efad7a7b0d446efe3e">paInt8</a>   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00000010)</td></tr>
<tr class="separator:a058ecfb48ac9f0efad7a7b0d446efe3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad826044e4ffe7b16bf990803ab77df37"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ad826044e4ffe7b16bf990803ab77df37">paUInt8</a>   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00000020)</td></tr>
<tr class="separator:ad826044e4ffe7b16bf990803ab77df37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba595f6b645c8134a8ac3004957b9ff7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#aba595f6b645c8134a8ac3004957b9ff7">paCustomFormat</a>   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00010000)</td></tr>
<tr class="separator:aba595f6b645c8134a8ac3004957b9ff7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d79f0b88812cef5364b276dbbc898b5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a1d79f0b88812cef5364b276dbbc898b5">paNonInterleaved</a>   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x80000000)</td></tr>
<tr class="separator:a1d79f0b88812cef5364b276dbbc898b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a400df642339bf4112333060af6a43c0f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a400df642339bf4112333060af6a43c0f">paFormatIsSupported</a>   (0)</td></tr>
<tr class="separator:a400df642339bf4112333060af6a43c0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1e20b97c1858a59bc62823573c59f0b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ac1e20b97c1858a59bc62823573c59f0b">paFramesPerBufferUnspecified</a>   (0)</td></tr>
<tr class="separator:ac1e20b97c1858a59bc62823573c59f0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad33384abe3754a39f4773f2561773595"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ad33384abe3754a39f4773f2561773595">paNoFlag</a>   ((<a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>) 0)</td></tr>
<tr class="separator:ad33384abe3754a39f4773f2561773595"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a837b8a81be3f7e36c96003e0d8dcec12"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a837b8a81be3f7e36c96003e0d8dcec12">paClipOff</a>   ((<a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>) 0x00000001)</td></tr>
<tr class="separator:a837b8a81be3f7e36c96003e0d8dcec12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add037e93aec78fa8d67f7a59ed500707"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#add037e93aec78fa8d67f7a59ed500707">paDitherOff</a>   ((<a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>) 0x00000002)</td></tr>
<tr class="separator:add037e93aec78fa8d67f7a59ed500707"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad89be5ed5279fc4c4a8495c775e1d5d5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ad89be5ed5279fc4c4a8495c775e1d5d5">paNeverDropInput</a>   ((<a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>) 0x00000004)</td></tr>
<tr class="separator:ad89be5ed5279fc4c4a8495c775e1d5d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7b862a223edd680d7985c33c847e31d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ad7b862a223edd680d7985c33c847e31d">paPrimeOutputBuffersUsingStreamCallback</a>   ((<a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>) 0x00000008)</td></tr>
<tr class="separator:ad7b862a223edd680d7985c33c847e31d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8522957e1bf814b9782d3a0e314c8b51"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a8522957e1bf814b9782d3a0e314c8b51">paPlatformSpecificFlags</a>   ((<a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>)0xFFFF0000)</td></tr>
<tr class="separator:a8522957e1bf814b9782d3a0e314c8b51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57d1879f52406bdedfdda8f79f458e15"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a57d1879f52406bdedfdda8f79f458e15">paInputUnderflow</a>   ((<a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a>) 0x00000001)</td></tr>
<tr class="separator:a57d1879f52406bdedfdda8f79f458e15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea144f0edaf02d0ac8b113f41fb95c47"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#aea144f0edaf02d0ac8b113f41fb95c47">paInputOverflow</a>   ((<a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a>) 0x00000002)</td></tr>
<tr class="separator:aea144f0edaf02d0ac8b113f41fb95c47"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa17c91c859b12ebbf53a1440def53c89"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#aa17c91c859b12ebbf53a1440def53c89">paOutputUnderflow</a>   ((<a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a>) 0x00000004)</td></tr>
<tr class="separator:aa17c91c859b12ebbf53a1440def53c89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac22bb260d47b348bd3aab8813fd45462"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ac22bb260d47b348bd3aab8813fd45462">paOutputOverflow</a>   ((<a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a>) 0x00000008)</td></tr>
<tr class="separator:ac22bb260d47b348bd3aab8813fd45462"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad6616980c2259866a39eb2b76fa4697d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ad6616980c2259866a39eb2b76fa4697d">paPrimingOutput</a>   ((<a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a>) 0x00000010)</td></tr>
<tr class="separator:ad6616980c2259866a39eb2b76fa4697d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a4949e4a8ef9f9dbe8cbee414ce69841d"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a></td></tr>
<tr class="separator:a4949e4a8ef9f9dbe8cbee414ce69841d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af3e4186dbeeb329bceafc0efc2124d98"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3e4186dbeeb329bceafc0efc2124d98"></a>
typedef enum PaErrorCode </td><td class="memItemRight" valign="bottom"><b>PaErrorCode</b></td></tr>
<tr class="separator:af3e4186dbeeb329bceafc0efc2124d98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad79317e65bde63d76c4b8e711ac5a361"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a></td></tr>
<tr class="separator:ad79317e65bde63d76c4b8e711ac5a361"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeef6da084c57c70aa94be97411e19930"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a></td></tr>
<tr class="separator:aeef6da084c57c70aa94be97411e19930"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae247ec252e84112170079ece319fc42c"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="portaudio_8h.html#a8eaebe3d39c5ea45598da8f86dc2e5ae">PaHostApiTypeId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ae247ec252e84112170079ece319fc42c">PaHostApiTypeId</a></td></tr>
<tr class="separator:ae247ec252e84112170079ece319fc42c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59bc8800f4c058add2e9a4de6f263352"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a59bc8800f4c058add2e9a4de6f263352">PaHostApiInfo</a></td></tr>
<tr class="separator:a59bc8800f4c058add2e9a4de6f263352"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae5f7523aa88f6e1ab05230103bd3560"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structPaHostErrorInfo.html">PaHostErrorInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#aae5f7523aa88f6e1ab05230103bd3560">PaHostErrorInfo</a></td></tr>
<tr class="separator:aae5f7523aa88f6e1ab05230103bd3560"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af17a7e6d0471a23071acf8dbd7bbe4bd"><td class="memItemLeft" align="right" valign="top">typedef double </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#af17a7e6d0471a23071acf8dbd7bbe4bd">PaTime</a></td></tr>
<tr class="separator:af17a7e6d0471a23071acf8dbd7bbe4bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4582d93c2c2e60e12be3d74c5fe00b96"><td class="memItemLeft" align="right" valign="top">typedef unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a></td></tr>
<tr class="separator:a4582d93c2c2e60e12be3d74c5fe00b96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84166d5f748e192341b71cf1b05d28b3"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a84166d5f748e192341b71cf1b05d28b3">PaDeviceInfo</a></td></tr>
<tr class="separator:a84166d5f748e192341b71cf1b05d28b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaedb633e6f41d592bf999c18bdb8bb12"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#aaedb633e6f41d592bf999c18bdb8bb12">PaStreamParameters</a></td></tr>
<tr class="separator:aaedb633e6f41d592bf999c18bdb8bb12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19874734f89958fccf86785490d53b4c"><td class="memItemLeft" align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a></td></tr>
<tr class="separator:a19874734f89958fccf86785490d53b4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37c7ac3ace7d2dd1430f40ecdee4ebb6"><td class="memItemLeft" align="right" valign="top">typedef unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a></td></tr>
<tr class="separator:a37c7ac3ace7d2dd1430f40ecdee4ebb6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac81b1065de3722c62eae395281451a73"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structPaStreamCallbackTimeInfo.html">PaStreamCallbackTimeInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ac81b1065de3722c62eae395281451a73">PaStreamCallbackTimeInfo</a></td></tr>
<tr class="separator:ac81b1065de3722c62eae395281451a73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55a005924bcfa0424594f4f65cd4ae82"><td class="memItemLeft" align="right" valign="top">typedef unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a></td></tr>
<tr class="separator:a55a005924bcfa0424594f4f65cd4ae82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82cf09a8d14c7b614a8b73774f4952f1"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="portaudio_8h.html#ae9bfb9c4e1895326f30f80d415c66c32">PaStreamCallbackResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a82cf09a8d14c7b614a8b73774f4952f1">PaStreamCallbackResult</a></td></tr>
<tr class="separator:a82cf09a8d14c7b614a8b73774f4952f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a60fb2a5ec9cbade3f54a9c978e2710"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a8a60fb2a5ec9cbade3f54a9c978e2710">PaStreamCallback</a> (const void *input, void *output, unsigned long frameCount, const <a class="el" href="structPaStreamCallbackTimeInfo.html">PaStreamCallbackTimeInfo</a> *timeInfo, <a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a> statusFlags, void *userData)</td></tr>
<tr class="separator:a8a60fb2a5ec9cbade3f54a9c978e2710"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2530ee0cb756c67726f9074d3482ef2"><td class="memItemLeft" align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ab2530ee0cb756c67726f9074d3482ef2">PaStreamFinishedCallback</a> (void *userData)</td></tr>
<tr class="separator:ab2530ee0cb756c67726f9074d3482ef2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5efc2a97ba96a3e06849c1a857127acc"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structPaStreamInfo.html">PaStreamInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a5efc2a97ba96a3e06849c1a857127acc">PaStreamInfo</a></td></tr>
<tr class="separator:a5efc2a97ba96a3e06849c1a857127acc"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a2e45bf8b5145f131a91c128af2bdaec7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>PaErrorCode</b> { <br/>
  <b>paNoError</b> = 0,
<b>paNotInitialized</b> = -10000,
<b>paUnanticipatedHostError</b>,
<b>paInvalidChannelCount</b>,
<br/>
  <b>paInvalidSampleRate</b>,
<b>paInvalidDevice</b>,
<b>paInvalidFlag</b>,
<b>paSampleFormatNotSupported</b>,
<br/>
  <b>paBadIODeviceCombination</b>,
<b>paInsufficientMemory</b>,
<b>paBufferTooBig</b>,
<b>paBufferTooSmall</b>,
<br/>
  <b>paNullCallback</b>,
<b>paBadStreamPtr</b>,
<b>paTimedOut</b>,
<b>paInternalError</b>,
<br/>
  <b>paDeviceUnavailable</b>,
<b>paIncompatibleHostApiSpecificStreamInfo</b>,
<b>paStreamIsStopped</b>,
<b>paStreamIsNotStopped</b>,
<br/>
  <b>paInputOverflowed</b>,
<b>paOutputUnderflowed</b>,
<b>paHostApiNotFound</b>,
<b>paInvalidHostApi</b>,
<br/>
  <b>paCanNotReadFromACallbackStream</b>,
<b>paCanNotWriteToACallbackStream</b>,
<b>paCanNotReadFromAnOutputOnlyStream</b>,
<b>paCanNotWriteToAnInputOnlyStream</b>,
<br/>
  <b>paIncompatibleStreamHostApi</b>,
<b>paBadBufferPtr</b>
<br/>
}</td></tr>
<tr class="separator:a2e45bf8b5145f131a91c128af2bdaec7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8eaebe3d39c5ea45598da8f86dc2e5ae"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a8eaebe3d39c5ea45598da8f86dc2e5ae">PaHostApiTypeId</a> { <br/>
  <b>paInDevelopment</b> =0,
<b>paDirectSound</b> =1,
<b>paMME</b> =2,
<b>paASIO</b> =3,
<br/>
  <b>paSoundManager</b> =4,
<b>paCoreAudio</b> =5,
<b>paOSS</b> =7,
<b>paALSA</b> =8,
<br/>
  <b>paAL</b> =9,
<b>paBeOS</b> =10,
<b>paWDMKS</b> =11,
<b>paJACK</b> =12,
<br/>
  <b>paWASAPI</b> =13,
<b>paAudioScienceHPI</b> =14
<br/>
}</td></tr>
<tr class="separator:a8eaebe3d39c5ea45598da8f86dc2e5ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9bfb9c4e1895326f30f80d415c66c32"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ae9bfb9c4e1895326f30f80d415c66c32">PaStreamCallbackResult</a> { <a class="el" href="portaudio_8h.html#ae9bfb9c4e1895326f30f80d415c66c32acba49cbf0e3bf605bb3deecef3b4fce3">paContinue</a> =0,
<a class="el" href="portaudio_8h.html#ae9bfb9c4e1895326f30f80d415c66c32aa01800db52ead393d8b0016f63d76650">paComplete</a> =1,
<a class="el" href="portaudio_8h.html#ae9bfb9c4e1895326f30f80d415c66c32acaf141eb5d71420ffb4474da1dbd8de2">paAbort</a> =2
}</td></tr>
<tr class="separator:ae9bfb9c4e1895326f30f80d415c66c32"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a66da08bcf908e0849c62a6b47f50d7b4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a66da08bcf908e0849c62a6b47f50d7b4">Pa_GetVersion</a> (void)</td></tr>
<tr class="separator:a66da08bcf908e0849c62a6b47f50d7b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a28f3fd9e6d9f933cc695abea71c4b445"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a28f3fd9e6d9f933cc695abea71c4b445">Pa_GetVersionText</a> (void)</td></tr>
<tr class="separator:a28f3fd9e6d9f933cc695abea71c4b445"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae606855a611cf29c7d2d7421df5e3b5d"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ae606855a611cf29c7d2d7421df5e3b5d">Pa_GetErrorText</a> (<a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> errorCode)</td></tr>
<tr class="separator:ae606855a611cf29c7d2d7421df5e3b5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abed859482d156622d9332dff9b2d89da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#abed859482d156622d9332dff9b2d89da">Pa_Initialize</a> (void)</td></tr>
<tr class="separator:abed859482d156622d9332dff9b2d89da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0db317604e916e8bd6098e60e6237221"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a0db317604e916e8bd6098e60e6237221">Pa_Terminate</a> (void)</td></tr>
<tr class="separator:a0db317604e916e8bd6098e60e6237221"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19dbdb7c8702e3f4bfc0cdb99dac3dd9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a19dbdb7c8702e3f4bfc0cdb99dac3dd9">Pa_GetHostApiCount</a> (void)</td></tr>
<tr class="separator:a19dbdb7c8702e3f4bfc0cdb99dac3dd9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae55c77f9b7e3f8eb301a6f1c0e2347ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ae55c77f9b7e3f8eb301a6f1c0e2347ac">Pa_GetDefaultHostApi</a> (void)</td></tr>
<tr class="separator:ae55c77f9b7e3f8eb301a6f1c0e2347ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c650aede88ea553066bab9bbe97ea90"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a7c650aede88ea553066bab9bbe97ea90">Pa_GetHostApiInfo</a> (<a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a> hostApi)</td></tr>
<tr class="separator:a7c650aede88ea553066bab9bbe97ea90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a081c3975126d20b4226facfb7ba0620f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a081c3975126d20b4226facfb7ba0620f">Pa_HostApiTypeIdToHostApiIndex</a> (<a class="el" href="portaudio_8h.html#a8eaebe3d39c5ea45598da8f86dc2e5ae">PaHostApiTypeId</a> type)</td></tr>
<tr class="separator:a081c3975126d20b4226facfb7ba0620f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54f306b5e5258323c95a27c5722258cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a54f306b5e5258323c95a27c5722258cd">Pa_HostApiDeviceIndexToDeviceIndex</a> (<a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a> hostApi, int hostApiDeviceIndex)</td></tr>
<tr class="separator:a54f306b5e5258323c95a27c5722258cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad573f208b60577f21d2777a7c5054e0"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structPaHostErrorInfo.html">PaHostErrorInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#aad573f208b60577f21d2777a7c5054e0">Pa_GetLastHostErrorInfo</a> (void)</td></tr>
<tr class="separator:aad573f208b60577f21d2777a7c5054e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acfe4d3c5ec1a343f459981bfa2057f8d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#acfe4d3c5ec1a343f459981bfa2057f8d">Pa_GetDeviceCount</a> (void)</td></tr>
<tr class="separator:acfe4d3c5ec1a343f459981bfa2057f8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf9f2f82da95553d5adb929af670f74b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#abf9f2f82da95553d5adb929af670f74b">Pa_GetDefaultInputDevice</a> (void)</td></tr>
<tr class="separator:abf9f2f82da95553d5adb929af670f74b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc955dfab007624000695c48d4f876dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#adc955dfab007624000695c48d4f876dc">Pa_GetDefaultOutputDevice</a> (void)</td></tr>
<tr class="separator:adc955dfab007624000695c48d4f876dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7d8e091ffc1d1d4a035704660e117eb"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ac7d8e091ffc1d1d4a035704660e117eb">Pa_GetDeviceInfo</a> (<a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> device)</td></tr>
<tr class="separator:ac7d8e091ffc1d1d4a035704660e117eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdb313743d6efef26cecdae787a2bd3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#abdb313743d6efef26cecdae787a2bd3d">Pa_IsFormatSupported</a> (const <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> *inputParameters, const <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> *outputParameters, double sampleRate)</td></tr>
<tr class="separator:abdb313743d6efef26cecdae787a2bd3d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a443ad16338191af364e3be988014cbbe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> **stream, const <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> *inputParameters, const <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> *outputParameters, double sampleRate, unsigned long framesPerBuffer, <a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a> streamFlags, <a class="el" href="portaudio_8h.html#a8a60fb2a5ec9cbade3f54a9c978e2710">PaStreamCallback</a> *streamCallback, void *userData)</td></tr>
<tr class="separator:a443ad16338191af364e3be988014cbbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a12735ac191200f696a43b87667b714"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a0a12735ac191200f696a43b87667b714">Pa_OpenDefaultStream</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> **stream, int numInputChannels, int numOutputChannels, <a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> sampleFormat, double sampleRate, unsigned long framesPerBuffer, <a class="el" href="portaudio_8h.html#a8a60fb2a5ec9cbade3f54a9c978e2710">PaStreamCallback</a> *streamCallback, void *userData)</td></tr>
<tr class="separator:a0a12735ac191200f696a43b87667b714"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92f56f88cbd14da0e8e03077e835d104"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a92f56f88cbd14da0e8e03077e835d104">Pa_CloseStream</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:a92f56f88cbd14da0e8e03077e835d104"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa11e7b06b2cde8621551f5d527965838"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#aa11e7b06b2cde8621551f5d527965838">Pa_SetStreamFinishedCallback</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream, <a class="el" href="portaudio_8h.html#ab2530ee0cb756c67726f9074d3482ef2">PaStreamFinishedCallback</a> *streamFinishedCallback)</td></tr>
<tr class="separator:aa11e7b06b2cde8621551f5d527965838"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7432aadd26c40452da12fa99fc1a047b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a7432aadd26c40452da12fa99fc1a047b">Pa_StartStream</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:a7432aadd26c40452da12fa99fc1a047b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af18dd60220251286c337631a855e38a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#af18dd60220251286c337631a855e38a0">Pa_StopStream</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:af18dd60220251286c337631a855e38a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a138e57abde4e833c457b64895f638a25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a138e57abde4e833c457b64895f638a25">Pa_AbortStream</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:a138e57abde4e833c457b64895f638a25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52d778c985ae9d566de7e13529cc771f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a52d778c985ae9d566de7e13529cc771f">Pa_IsStreamStopped</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:a52d778c985ae9d566de7e13529cc771f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f8709c4971932643681a6f374c4bb5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a1f8709c4971932643681a6f374c4bb5a">Pa_IsStreamActive</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:a1f8709c4971932643681a6f374c4bb5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d9c4cbda4e9f381b76f287c3de8a758"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structPaStreamInfo.html">PaStreamInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a3d9c4cbda4e9f381b76f287c3de8a758">Pa_GetStreamInfo</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:a3d9c4cbda4e9f381b76f287c3de8a758"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b3fb60e6949f37f7f134105ff425749"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#af17a7e6d0471a23071acf8dbd7bbe4bd">PaTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a2b3fb60e6949f37f7f134105ff425749">Pa_GetStreamTime</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:a2b3fb60e6949f37f7f134105ff425749"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83b8c624464dd7bb6a01b06ab596c115"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a83b8c624464dd7bb6a01b06ab596c115">Pa_GetStreamCpuLoad</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:a83b8c624464dd7bb6a01b06ab596c115"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b62d4b74b5d3d88368e9e4c0b8b2dc7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a0b62d4b74b5d3d88368e9e4c0b8b2dc7">Pa_ReadStream</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream, void *buffer, unsigned long frames)</td></tr>
<tr class="separator:a0b62d4b74b5d3d88368e9e4c0b8b2dc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a075a6efb503a728213bdae24347ed27d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a075a6efb503a728213bdae24347ed27d">Pa_WriteStream</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream, const void *buffer, unsigned long frames)</td></tr>
<tr class="separator:a075a6efb503a728213bdae24347ed27d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad04c33f045fa58d7b705b56b1fd3e816"><td class="memItemLeft" align="right" valign="top">signed long </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#ad04c33f045fa58d7b705b56b1fd3e816">Pa_GetStreamReadAvailable</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:ad04c33f045fa58d7b705b56b1fd3e816"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25595acf48733ec32045aa189c3caa61"><td class="memItemLeft" align="right" valign="top">signed long </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a25595acf48733ec32045aa189c3caa61">Pa_GetStreamWriteAvailable</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:a25595acf48733ec32045aa189c3caa61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a290c1596fb9c8bab22a28d3ca75ea321"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a8eaebe3d39c5ea45598da8f86dc2e5ae">PaHostApiTypeId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a290c1596fb9c8bab22a28d3ca75ea321">Pa_GetStreamHostApiType</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:a290c1596fb9c8bab22a28d3ca75ea321"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a541ed0b734df2631bc4c229acf92abc1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a541ed0b734df2631bc4c229acf92abc1">Pa_GetSampleSize</a> (<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> format)</td></tr>
<tr class="separator:a541ed0b734df2631bc4c229acf92abc1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b3c20044c9401c42add29475636e83d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="portaudio_8h.html#a1b3c20044c9401c42add29475636e83d">Pa_Sleep</a> (long msec)</td></tr>
<tr class="separator:a1b3c20044c9401c42add29475636e83d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The portable PortAudio API. </p>
<p>Definition in file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a837b8a81be3f7e36c96003e0d8dcec12"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paClipOff   ((<a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>) 0x00000001)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Disable default clipping of out of range samples. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00610">610</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="aba595f6b645c8134a8ac3004957b9ff7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paCustomFormat   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00010000)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00442">442</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="add037e93aec78fa8d67f7a59ed500707"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paDitherOff   ((<a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>) 0x00000002)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Disable default dithering. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00615">615</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2f16d29916725b8791eae60ab9e0b081"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paFloat32   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00000001)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00436">436</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a400df642339bf4112333060af6a43c0f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paFormatIsSupported   (0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return code for Pa_IsFormatSupported indicating success. </p>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00534">534</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac1e20b97c1858a59bc62823573c59f0b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paFramesPerBufferUnspecified   (0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Can be passed as the framesPerBuffer parameter to <a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream()</a> or <a class="el" href="portaudio_8h.html#a0a12735ac191200f696a43b87667b714">Pa_OpenDefaultStream()</a> to indicate that the stream callback will accept buffers of any size. </p>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00591">591</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="aea144f0edaf02d0ac8b113f41fb95c47"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paInputOverflow   ((<a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a>) 0x00000002)</td>
</tr>
</table>
</div><div class="memdoc">
<p>In a stream opened with paFramesPerBufferUnspecified, indicates that data prior to the first sample of the input buffer was discarded due to an overflow, possibly because the stream callback is using too much CPU time. Otherwise indicates that data prior to one or more samples in the input buffer was discarded. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00679">679</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a57d1879f52406bdedfdda8f79f458e15"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paInputUnderflow   ((<a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a>) 0x00000001)</td>
</tr>
</table>
</div><div class="memdoc">
<p>In a stream opened with paFramesPerBufferUnspecified, indicates that input data is all silence (zeros) because no real data is available. In a stream opened without paFramesPerBufferUnspecified, it indicates that one or more zero samples have been inserted into the input buffer to compensate for an input underflow. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00670">670</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab284f8e0a161d78ede863aec45461dbd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paInt16   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00000008)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00439">439</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7f891a0bd9e94a94a8f446c176b749e7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paInt24   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00000004)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Packed 24 bit format. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00438">438</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6fea69f3d81b628288325c06310b2fcf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paInt32   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00000002)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00437">437</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a058ecfb48ac9f0efad7a7b0d446efe3e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paInt8   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00000010)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00440">440</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad89be5ed5279fc4c4a8495c775e1d5d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paNeverDropInput   ((<a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>) 0x00000004)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag requests that where possible a full duplex stream will not discard overflowed input samples without calling the stream callback. This flag is only valid for full duplex callback streams and only when used in combination with the paFramesPerBufferUnspecified (0) framesPerBuffer parameter. Using this flag incorrectly results in a paInvalidFlag error being returned from Pa_OpenStream and Pa_OpenDefaultStream.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>, <a class="el" href="portaudio_8h.html#ac1e20b97c1858a59bc62823573c59f0b">paFramesPerBufferUnspecified</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00626">626</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8c26dd5e6f28bb4cda7a1f5460282297"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paNoDevice   ((<a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a>)-1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A special PaDeviceIndex value indicating that no device is available, or should be used.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00169">169</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad33384abe3754a39f4773f2561773595"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paNoFlag   ((<a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>) 0)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00605">605</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1d79f0b88812cef5364b276dbbc898b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paNonInterleaved   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x80000000)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00444">444</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac22bb260d47b348bd3aab8813fd45462"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paOutputOverflow   ((<a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a>) 0x00000008)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates that output data will be discarded because no room is available. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00690">690</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa17c91c859b12ebbf53a1440def53c89"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paOutputUnderflow   ((<a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a>) 0x00000004)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates that output data (or a gap) was inserted, possibly because the stream callback is using too much CPU time. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00685">685</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8522957e1bf814b9782d3a0e314c8b51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paPlatformSpecificFlags   ((<a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>)0xFFFF0000)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A mask specifying the platform specific bits. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00639">639</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad7b862a223edd680d7985c33c847e31d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paPrimeOutputBuffersUsingStreamCallback   ((<a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a>) 0x00000008)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Call the stream callback to fill initial output buffers, rather than the default behavior of priming the buffers with zeros (silence). This flag has no effect for input-only and blocking read/write streams.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00634">634</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad6616980c2259866a39eb2b76fa4697d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paPrimingOutput   ((<a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a>) 0x00000010)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Some of all of the output data will be used to prime the stream, input data may be zero. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00696">696</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad826044e4ffe7b16bf990803ab77df37"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paUInt8   ((<a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a>) 0x00000020)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00441">441</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a14795fe3377c3b037025a61e550d44b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define paUseHostApiSpecificDeviceSpecification   ((<a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a>)-2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A special PaDeviceIndex value indicating that the device(s) to be used are specified in the host api specific stream info structure.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00177">177</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ad79317e65bde63d76c4b8e711ac5a361"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The type used to refer to audio devices. Values of this type usually range from 0 to (<a class="el" href="portaudio_8h.html#acfe4d3c5ec1a343f459981bfa2057f8d">Pa_GetDeviceCount()</a>-1), and may also take on the PaNoDevice and paUseHostApiSpecificDeviceSpecification values.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#acfe4d3c5ec1a343f459981bfa2057f8d">Pa_GetDeviceCount</a>, <a class="el" href="portaudio_8h.html#a8c26dd5e6f28bb4cda7a1f5460282297">paNoDevice</a>, <a class="el" href="portaudio_8h.html#a14795fe3377c3b037025a61e550d44b5">paUseHostApiSpecificDeviceSpecification</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00161">161</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a84166d5f748e192341b71cf1b05d28b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a> <a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A structure providing information and capabilities of PortAudio devices. Devices may support input, output or both input and output. </p>
</div>
</div>
<a class="anchor" id="a4949e4a8ef9f9dbe8cbee414ce69841d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Error codes returned by PortAudio functions. Note that with the exception of paNoError, all PaErrorCodes are negative. </p>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00070">70</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeef6da084c57c70aa94be97411e19930"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The type used to enumerate to host APIs at runtime. Values of this type range from 0 to (<a class="el" href="portaudio_8h.html#a19dbdb7c8702e3f4bfc0cdb99dac3dd9">Pa_GetHostApiCount()</a>-1).</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a19dbdb7c8702e3f4bfc0cdb99dac3dd9">Pa_GetHostApiCount</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00187">187</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a59bc8800f4c058add2e9a4de6f263352"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a> <a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A structure containing information about a particular host API. </p>
</div>
</div>
<a class="anchor" id="ae247ec252e84112170079ece319fc42c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="portaudio_8h.html#a8eaebe3d39c5ea45598da8f86dc2e5ae">PaHostApiTypeId</a> <a class="el" href="portaudio_8h.html#a8eaebe3d39c5ea45598da8f86dc2e5ae">PaHostApiTypeId</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unchanging unique identifiers for each supported host API. This type is used in the <a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a> structure. The values are guaranteed to be unique and to never change, thus allowing code to be written that conditionally uses host API specific extensions.</p>
<p>New type ids will be allocated when support for a host API reaches "public alpha" status, prior to that developers should use the paInDevelopment type id.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aae5f7523aa88f6e1ab05230103bd3560"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structPaHostErrorInfo.html">PaHostErrorInfo</a> <a class="el" href="structPaHostErrorInfo.html">PaHostErrorInfo</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Structure used to return information about a host error condition. </p>
</div>
</div>
<a class="anchor" id="a4582d93c2c2e60e12be3d74c5fe00b96"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned long <a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A type used to specify one or more sample formats. Each value indicates a possible format for sound data passed to and from the stream callback, Pa_ReadStream and Pa_WriteStream.</p>
<p>The standard formats paFloat32, paInt16, paInt32, paInt24, paInt8 and aUInt8 are usually implemented by all implementations.</p>
<p>The floating point representation (paFloat32) uses +1.0 and -1.0 as the maximum and minimum respectively.</p>
<p>paUInt8 is an unsigned 8 bit format where 128 is considered "ground"</p>
<p>The paNonInterleaved flag indicates that audio data is passed as an array of pointers to separate buffers, one buffer for each channel. Usually, when this flag is not used, audio data is passed as a single buffer with all channels interleaved.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream</a>, <a class="el" href="portaudio_8h.html#a0a12735ac191200f696a43b87667b714">Pa_OpenDefaultStream</a>, <a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a> </dd>
<dd>
<a class="el" href="portaudio_8h.html#a2f16d29916725b8791eae60ab9e0b081">paFloat32</a>, <a class="el" href="portaudio_8h.html#ab284f8e0a161d78ede863aec45461dbd">paInt16</a>, <a class="el" href="portaudio_8h.html#a6fea69f3d81b628288325c06310b2fcf">paInt32</a>, <a class="el" href="portaudio_8h.html#a7f891a0bd9e94a94a8f446c176b749e7">paInt24</a>, <a class="el" href="portaudio_8h.html#a058ecfb48ac9f0efad7a7b0d446efe3e">paInt8</a> </dd>
<dd>
<a class="el" href="portaudio_8h.html#ad826044e4ffe7b16bf990803ab77df37">paUInt8</a>, <a class="el" href="portaudio_8h.html#aba595f6b645c8134a8ac3004957b9ff7">paCustomFormat</a>, <a class="el" href="portaudio_8h.html#a1d79f0b88812cef5364b276dbbc898b5">paNonInterleaved</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00433">433</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a19874734f89958fccf86785490d53b4c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void <a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A single PaStream can provide multiple channels of real-time streaming audio input and output to a client application. A stream provides access to audio hardware represented by one or more PaDevices. Depending on the underlying Host API, it may be possible to open multiple streams using the same device, however this behavior is implementation defined. Portable applications should assume that a PaDevice may be simultaneously used by at most one PaStream.</p>
<p>Pointers to PaStream objects are passed between PortAudio functions that operate on streams.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream</a>, <a class="el" href="portaudio_8h.html#a0a12735ac191200f696a43b87667b714">Pa_OpenDefaultStream</a>, <a class="el" href="portaudio_8h.html#a0a12735ac191200f696a43b87667b714">Pa_OpenDefaultStream</a>, <a class="el" href="portaudio_8h.html#a92f56f88cbd14da0e8e03077e835d104">Pa_CloseStream</a>, <a class="el" href="portaudio_8h.html#a7432aadd26c40452da12fa99fc1a047b">Pa_StartStream</a>, <a class="el" href="portaudio_8h.html#af18dd60220251286c337631a855e38a0">Pa_StopStream</a>, <a class="el" href="portaudio_8h.html#a138e57abde4e833c457b64895f638a25">Pa_AbortStream</a>, <a class="el" href="portaudio_8h.html#a1f8709c4971932643681a6f374c4bb5a">Pa_IsStreamActive</a>, <a class="el" href="portaudio_8h.html#a2b3fb60e6949f37f7f134105ff425749">Pa_GetStreamTime</a>, <a class="el" href="portaudio_8h.html#a83b8c624464dd7bb6a01b06ab596c115">Pa_GetStreamCpuLoad</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00584">584</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8a60fb2a5ec9cbade3f54a9c978e2710"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int PaStreamCallback(const void *input, void *output, unsigned long frameCount, const <a class="el" href="structPaStreamCallbackTimeInfo.html">PaStreamCallbackTimeInfo</a> *timeInfo, <a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a> statusFlags, void *userData)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Functions of type PaStreamCallback are implemented by PortAudio clients. They consume, process or generate audio in response to requests from an active PortAudio stream.</p>
<p>When a stream is running, PortAudio calls the stream callback periodically. The callback function is responsible for processing buffers of audio samples passed via the input and output parameters.</p>
<p>The PortAudio stream callback runs at very high or real-time priority. It is required to consistently meet its time deadlines. Do not allocate memory, access the file system, call library functions or call other functions from the stream callback that may block or take an unpredictable amount of time to complete.</p>
<p>In order for a stream to maintain glitch-free operation the callback must consume and return audio data faster than it is recorded and/or played. PortAudio anticipates that each callback invocation may execute for a duration approaching the duration of frameCount audio frames at the stream sample rate. It is reasonable to expect to be able to utilise 70% or more of the available CPU time in the PortAudio callback. However, due to buffer size adaption and other factors, not all host APIs are able to guarantee audio stability under heavy CPU load with arbitrary fixed callback buffer sizes. When high callback CPU utilisation is required the most robust behavior can be achieved by using paFramesPerBufferUnspecified as the <a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream()</a> framesPerBuffer parameter.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>and </td></tr>
<tr><td class="paramname">output</td><td>are either arrays of interleaved samples or; if non-interleaved samples were requested using the paNonInterleaved sample format flag, an array of buffer pointers, one non-interleaved buffer for each channel.</td></tr>
</table>
</dd>
</dl>
<p>The format, packing and number of channels used by the buffers are determined by parameters to <a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">frameCount</td><td>The number of sample frames to be processed by the stream callback.</td></tr>
<tr><td class="paramname">timeInfo</td><td>Timestamps indicating the ADC capture time of the first sample in the input buffer, the DAC output time of the first sample in the output buffer and the time the callback was invoked. See <a class="el" href="structPaStreamCallbackTimeInfo.html">PaStreamCallbackTimeInfo</a> and <a class="el" href="portaudio_8h.html#a2b3fb60e6949f37f7f134105ff425749">Pa_GetStreamTime()</a></td></tr>
<tr><td class="paramname">statusFlags</td><td>Flags indicating whether input and/or output buffers have been inserted or will be dropped to overcome underflow or overflow conditions.</td></tr>
<tr><td class="paramname">userData</td><td>The value of a user supplied pointer passed to <a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream()</a> intended for storing synthesis data etc.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The stream callback should return one of the values in the <a class="el" href="portaudio_8h.html#ae9bfb9c4e1895326f30f80d415c66c32">PaStreamCallbackResult</a> enumeration. To ensure that the callback continues to be called, it should return paContinue (0). Either paComplete or paAbort can be returned to finish stream processing, after either of these values is returned the callback will not be called again. If paAbort is returned the stream will finish as soon as possible. If paComplete is returned, the stream will continue until all buffers generated by the callback have been played. This may be useful in applications such as soundfile players where a specific duration of output is required. However, it is not necessary to utilize this mechanism as <a class="el" href="portaudio_8h.html#af18dd60220251286c337631a855e38a0">Pa_StopStream()</a>, <a class="el" href="portaudio_8h.html#a138e57abde4e833c457b64895f638a25">Pa_AbortStream()</a> or <a class="el" href="portaudio_8h.html#a92f56f88cbd14da0e8e03077e835d104">Pa_CloseStream()</a> can also be used to stop the stream. The callback must always fill the entire output buffer irrespective of its return value.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream</a>, <a class="el" href="portaudio_8h.html#a0a12735ac191200f696a43b87667b714">Pa_OpenDefaultStream</a></dd></dl>
<dl class="section note"><dt>Note</dt><dd>With the exception of <a class="el" href="portaudio_8h.html#a83b8c624464dd7bb6a01b06ab596c115">Pa_GetStreamCpuLoad()</a> it is not permissible to call PortAudio API functions from within the stream callback. </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00779">779</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a55a005924bcfa0424594f4f65cd4ae82"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned long <a class="el" href="portaudio_8h.html#a55a005924bcfa0424594f4f65cd4ae82">PaStreamCallbackFlags</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag bit constants for the statusFlags to PaStreamCallback.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a57d1879f52406bdedfdda8f79f458e15">paInputUnderflow</a>, <a class="el" href="portaudio_8h.html#aea144f0edaf02d0ac8b113f41fb95c47">paInputOverflow</a>, <a class="el" href="portaudio_8h.html#aa17c91c859b12ebbf53a1440def53c89">paOutputUnderflow</a>, <a class="el" href="portaudio_8h.html#ac22bb260d47b348bd3aab8813fd45462">paOutputOverflow</a>, <a class="el" href="portaudio_8h.html#ad6616980c2259866a39eb2b76fa4697d">paPrimingOutput</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00661">661</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a82cf09a8d14c7b614a8b73774f4952f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="portaudio_8h.html#ae9bfb9c4e1895326f30f80d415c66c32">PaStreamCallbackResult</a> <a class="el" href="portaudio_8h.html#ae9bfb9c4e1895326f30f80d415c66c32">PaStreamCallbackResult</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allowable return values for the PaStreamCallback. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a8a60fb2a5ec9cbade3f54a9c978e2710">PaStreamCallback</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac81b1065de3722c62eae395281451a73"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structPaStreamCallbackTimeInfo.html">PaStreamCallbackTimeInfo</a> <a class="el" href="structPaStreamCallbackTimeInfo.html">PaStreamCallbackTimeInfo</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Timing information for the buffers passed to the stream callback.</p>
<p>Time values are expressed in seconds and are synchronised with the time base used by <a class="el" href="portaudio_8h.html#a2b3fb60e6949f37f7f134105ff425749">Pa_GetStreamTime()</a> for the associated stream.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a8a60fb2a5ec9cbade3f54a9c978e2710">PaStreamCallback</a>, <a class="el" href="portaudio_8h.html#a2b3fb60e6949f37f7f134105ff425749">Pa_GetStreamTime</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ab2530ee0cb756c67726f9074d3482ef2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void PaStreamFinishedCallback(void *userData)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Functions of type PaStreamFinishedCallback are implemented by PortAudio clients. They can be registered with a stream using the Pa_SetStreamFinishedCallback function. Once registered they are called when the stream becomes inactive (ie once a call to <a class="el" href="portaudio_8h.html#af18dd60220251286c337631a855e38a0">Pa_StopStream()</a> will not block). A stream will become inactive after the stream callback returns non-zero, or when Pa_StopStream or Pa_AbortStream is called. For a stream providing audio output, if the stream callback returns paComplete, or Pa_StopStream is called, the stream finished callback will not be called until all generated sample data has been played.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">userData</td><td>The userData parameter supplied to <a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream()</a></td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#aa11e7b06b2cde8621551f5d527965838">Pa_SetStreamFinishedCallback</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00911">911</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a37c7ac3ace7d2dd1430f40ecdee4ebb6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned long <a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags used to control the behavior of a stream. They are passed as parameters to Pa_OpenStream or Pa_OpenDefaultStream. Multiple flags may be ORed together.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream</a>, <a class="el" href="portaudio_8h.html#a0a12735ac191200f696a43b87667b714">Pa_OpenDefaultStream</a> </dd>
<dd>
<a class="el" href="portaudio_8h.html#ad33384abe3754a39f4773f2561773595">paNoFlag</a>, <a class="el" href="portaudio_8h.html#a837b8a81be3f7e36c96003e0d8dcec12">paClipOff</a>, <a class="el" href="portaudio_8h.html#add037e93aec78fa8d67f7a59ed500707">paDitherOff</a>, <a class="el" href="portaudio_8h.html#ad89be5ed5279fc4c4a8495c775e1d5d5">paNeverDropInput</a>, <a class="el" href="portaudio_8h.html#ad7b862a223edd680d7985c33c847e31d">paPrimeOutputBuffersUsingStreamCallback</a>, <a class="el" href="portaudio_8h.html#a8522957e1bf814b9782d3a0e314c8b51">paPlatformSpecificFlags</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00602">602</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5efc2a97ba96a3e06849c1a857127acc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structPaStreamInfo.html">PaStreamInfo</a> <a class="el" href="structPaStreamInfo.html">PaStreamInfo</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A structure containing unchanging information about an open stream. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a3d9c4cbda4e9f381b76f287c3de8a758">Pa_GetStreamInfo</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aaedb633e6f41d592bf999c18bdb8bb12"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters for one direction (input or output) of a stream. </p>
</div>
</div>
<a class="anchor" id="af17a7e6d0471a23071acf8dbd7bbe4bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef double <a class="el" href="portaudio_8h.html#af17a7e6d0471a23071acf8dbd7bbe4bd">PaTime</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The type used to represent monotonic time in seconds. PaTime is used for the fields of the <a class="el" href="structPaStreamCallbackTimeInfo.html">PaStreamCallbackTimeInfo</a> argument to the PaStreamCallback and as the result of <a class="el" href="portaudio_8h.html#a2b3fb60e6949f37f7f134105ff425749">Pa_GetStreamTime()</a>.</p>
<p>PaTime values have unspecified origin.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a8a60fb2a5ec9cbade3f54a9c978e2710">PaStreamCallback</a>, <a class="el" href="structPaStreamCallbackTimeInfo.html">PaStreamCallbackTimeInfo</a>, <a class="el" href="portaudio_8h.html#a2b3fb60e6949f37f7f134105ff425749">Pa_GetStreamTime</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00409">409</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a8eaebe3d39c5ea45598da8f86dc2e5ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="portaudio_8h.html#a8eaebe3d39c5ea45598da8f86dc2e5ae">PaHostApiTypeId</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unchanging unique identifiers for each supported host API. This type is used in the <a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a> structure. The values are guaranteed to be unique and to never change, thus allowing code to be written that conditionally uses host API specific extensions.</p>
<p>New type ids will be allocated when support for a host API reaches "public alpha" status, prior to that developers should use the paInDevelopment type id.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00224">224</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae9bfb9c4e1895326f30f80d415c66c32"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="portaudio_8h.html#ae9bfb9c4e1895326f30f80d415c66c32">PaStreamCallbackResult</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allowable return values for the PaStreamCallback. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a8a60fb2a5ec9cbade3f54a9c978e2710">PaStreamCallback</a> </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ae9bfb9c4e1895326f30f80d415c66c32acba49cbf0e3bf605bb3deecef3b4fce3"></a>paContinue</em> </td><td class="fielddoc">
<p>Signal that the stream should continue invoking the callback and processing audio. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ae9bfb9c4e1895326f30f80d415c66c32aa01800db52ead393d8b0016f63d76650"></a>paComplete</em> </td><td class="fielddoc">
<p>Signal that the stream should stop invoking the callback and finish once all output samples have played. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ae9bfb9c4e1895326f30f80d415c66c32acaf141eb5d71420ffb4474da1dbd8de2"></a>paAbort</em> </td><td class="fielddoc">
<p>Signal that the stream should stop invoking the callback and finish as soon as possible. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00702">702</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a138e57abde4e833c457b64895f638a25"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_AbortStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Terminates audio processing immediately without waiting for pending buffers to complete. </p>
</div>
</div>
<a class="anchor" id="a92f56f88cbd14da0e8e03077e835d104"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_CloseStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes an audio stream. If the audio stream is active it discards any pending buffers as if <a class="el" href="portaudio_8h.html#a138e57abde4e833c457b64895f638a25">Pa_AbortStream()</a> had been called. </p>
</div>
</div>
<a class="anchor" id="ae55c77f9b7e3f8eb301a6f1c0e2347ac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a> Pa_GetDefaultHostApi </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the index of the default host API. The default host API will be the lowest common denominator host API on the current platform and is unlikely to provide the best performance.</p>
<dl class="section return"><dt>Returns</dt><dd>A non-negative value ranging from 0 to (<a class="el" href="portaudio_8h.html#a19dbdb7c8702e3f4bfc0cdb99dac3dd9">Pa_GetHostApiCount()</a>-1) indicating the default host API index or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered. </dd></dl>
</div>
</div>
<a class="anchor" id="abf9f2f82da95553d5adb929af670f74b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> Pa_GetDefaultInputDevice </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the index of the default input device. The result can be used in the inputDevice parameter to <a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream()</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>The default input device index for the default host API, or paNoDevice if no default input device is available or an error was encountered. </dd></dl>
</div>
</div>
<a class="anchor" id="adc955dfab007624000695c48d4f876dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> Pa_GetDefaultOutputDevice </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the index of the default output device. The result can be used in the outputDevice parameter to <a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream()</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>The default output device index for the default host API, or paNoDevice if no default output device is available or an error was encountered.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>On the PC, the user can specify a default device by setting an environment variable. For example, to use device #1. <pre>
set PA_RECOMMENDED_OUTPUT_DEVICE=1
</pre> The user should first determine the available device ids by using the supplied application "pa_devs". </dd></dl>
</div>
</div>
<a class="anchor" id="acfe4d3c5ec1a343f459981bfa2057f8d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> Pa_GetDeviceCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the number of available devices. The number of available devices may be zero.</p>
<dl class="section return"><dt>Returns</dt><dd>A non-negative value indicating the number of available devices or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered. </dd></dl>
</div>
</div>
<a class="anchor" id="ac7d8e091ffc1d1d4a035704660e117eb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a>* Pa_GetDeviceInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </td>
<td class="paramname"><em>device</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a pointer to a <a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a> structure containing information about the specified device. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to an immutable <a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a> structure. If the device parameter is out of range the function returns NULL.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">device</td><td>A valid device index in the range 0 to (<a class="el" href="portaudio_8h.html#acfe4d3c5ec1a343f459981bfa2057f8d">Pa_GetDeviceCount()</a>-1)</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>PortAudio manages the memory referenced by the returned pointer, the client must not manipulate or free the memory. The pointer is only guaranteed to be valid between calls to <a class="el" href="portaudio_8h.html#abed859482d156622d9332dff9b2d89da">Pa_Initialize()</a> and <a class="el" href="portaudio_8h.html#a0db317604e916e8bd6098e60e6237221">Pa_Terminate()</a>.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a>, <a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ae606855a611cf29c7d2d7421df5e3b5d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* Pa_GetErrorText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> </td>
<td class="paramname"><em>errorCode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Translate the supplied PortAudio error code into a human readable message. </p>
</div>
</div>
<a class="anchor" id="a19dbdb7c8702e3f4bfc0cdb99dac3dd9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a> Pa_GetHostApiCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the number of available host APIs. Even if a host API is available it may have no devices available.</p>
<dl class="section return"><dt>Returns</dt><dd>A non-negative value indicating the number of available host APIs or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a7c650aede88ea553066bab9bbe97ea90"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a>* Pa_GetHostApiInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a> </td>
<td class="paramname"><em>hostApi</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a pointer to a structure containing information about a specific host Api.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hostApi</td><td>A valid host API index ranging from 0 to (<a class="el" href="portaudio_8h.html#a19dbdb7c8702e3f4bfc0cdb99dac3dd9">Pa_GetHostApiCount()</a>-1)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to an immutable <a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a> structure describing a specific host API. If the hostApi parameter is out of range or an error is encountered, the function returns NULL.</dd></dl>
<p>The returned structure is owned by the PortAudio implementation and must not be manipulated or freed. The pointer is only guaranteed to be valid between calls to <a class="el" href="portaudio_8h.html#abed859482d156622d9332dff9b2d89da">Pa_Initialize()</a> and <a class="el" href="portaudio_8h.html#a0db317604e916e8bd6098e60e6237221">Pa_Terminate()</a>. </p>
</div>
</div>
<a class="anchor" id="aad573f208b60577f21d2777a7c5054e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structPaHostErrorInfo.html">PaHostErrorInfo</a>* Pa_GetLastHostErrorInfo </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return information about the last host error encountered. The error information returned by <a class="el" href="portaudio_8h.html#aad573f208b60577f21d2777a7c5054e0">Pa_GetLastHostErrorInfo()</a> will never be modified asynchronously by errors occurring in other PortAudio owned threads (such as the thread that manages the stream callback.)</p>
<p>This function is provided as a last resort, primarily to enhance debugging by providing clients with access to all available error information.</p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to an immutable structure constraining information about the host error. The values in this structure will only be valid if a PortAudio function has previously returned the paUnanticipatedHostError error code. </dd></dl>
</div>
</div>
<a class="anchor" id="a541ed0b734df2631bc4c229acf92abc1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_GetSampleSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the size of a given sample format in bytes.</p>
<dl class="section return"><dt>Returns</dt><dd>The size in bytes of a single sample in the specified format, or paSampleFormatNotSupported if the format is not supported. </dd></dl>
</div>
</div>
<a class="anchor" id="a83b8c624464dd7bb6a01b06ab596c115"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Pa_GetStreamCpuLoad </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve CPU usage information for the specified stream. The "CPU Load" is a fraction of total CPU time consumed by a callback stream's audio processing routines including, but not limited to the client supplied stream callback. This function does not work with blocking read/write streams.</p>
<p>This function may be called from the stream callback function or the application.</p>
<dl class="section return"><dt>Returns</dt><dd>A floating point value, typically between 0.0 and 1.0, where 1.0 indicates that the stream callback is consuming the maximum number of CPU cycles possible to maintain real-time operation. A value of 0.5 would imply that PortAudio and the stream callback was consuming roughly 50% of the available CPU time. The return value may exceed 1.0. A value of 0.0 will always be returned for a blocking read/write stream, or if an error occurs. </dd></dl>
</div>
</div>
<a class="anchor" id="a290c1596fb9c8bab22a28d3ca75ea321"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a8eaebe3d39c5ea45598da8f86dc2e5ae">PaHostApiTypeId</a> Pa_GetStreamHostApiType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the host type handling an open stream.</p>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value representing the host API type handling an open stream or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered. </dd></dl>
</div>
</div>
<a class="anchor" id="a3d9c4cbda4e9f381b76f287c3de8a758"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structPaStreamInfo.html">PaStreamInfo</a>* Pa_GetStreamInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a pointer to a <a class="el" href="structPaStreamInfo.html">PaStreamInfo</a> structure containing information about the specified stream. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to an immutable <a class="el" href="structPaStreamInfo.html">PaStreamInfo</a> structure. If the stream parameter is invalid, or an error is encountered, the function returns NULL.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>A pointer to an open stream previously created with Pa_OpenStream.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>PortAudio manages the memory referenced by the returned pointer, the client must not manipulate or free the memory. The pointer is only guaranteed to be valid until the specified stream is closed.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structPaStreamInfo.html">PaStreamInfo</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad04c33f045fa58d7b705b56b1fd3e816"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">signed long Pa_GetStreamReadAvailable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the number of frames that can be read from the stream without waiting.</p>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value representing the maximum number of frames that can be read from the stream without blocking or busy waiting or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered. </dd></dl>
</div>
</div>
<a class="anchor" id="a2b3fb60e6949f37f7f134105ff425749"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#af17a7e6d0471a23071acf8dbd7bbe4bd">PaTime</a> Pa_GetStreamTime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current time in seconds for a stream according to the same clock used to generate callback <a class="el" href="structPaStreamCallbackTimeInfo.html">PaStreamCallbackTimeInfo</a> timestamps. The time values are monotonically increasing and have unspecified origin.</p>
<p>Pa_GetStreamTime returns valid time values for the entire life of the stream, from when the stream is opened until it is closed. Starting and stopping the stream does not affect the passage of time returned by Pa_GetStreamTime.</p>
<p>This time may be used for synchronizing other events to the audio stream, for example synchronizing audio to MIDI.</p>
<dl class="section return"><dt>Returns</dt><dd>The stream's current time in seconds, or 0 if an error occurred.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#af17a7e6d0471a23071acf8dbd7bbe4bd">PaTime</a>, <a class="el" href="portaudio_8h.html#a8a60fb2a5ec9cbade3f54a9c978e2710">PaStreamCallback</a>, <a class="el" href="structPaStreamCallbackTimeInfo.html">PaStreamCallbackTimeInfo</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a25595acf48733ec32045aa189c3caa61"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">signed long Pa_GetStreamWriteAvailable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the number of frames that can be written to the stream without waiting.</p>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value representing the maximum number of frames that can be written to the stream without blocking or busy waiting or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered. </dd></dl>
</div>
</div>
<a class="anchor" id="a66da08bcf908e0849c62a6b47f50d7b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Pa_GetVersion </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the release number of the currently running PortAudio build, eg 1900. </p>
</div>
</div>
<a class="anchor" id="a28f3fd9e6d9f933cc695abea71c4b445"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* Pa_GetVersionText </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a textual description of the current PortAudio build, eg "PortAudio V19-devel 13 October 2002". </p>
</div>
</div>
<a class="anchor" id="a54f306b5e5258323c95a27c5722258cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> Pa_HostApiDeviceIndexToDeviceIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a> </td>
<td class="paramname"><em>hostApi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>hostApiDeviceIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a host-API-specific device index to standard PortAudio device index. This function may be used in conjunction with the deviceCount field of <a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a> to enumerate all devices for the specified host API.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hostApi</td><td>A valid host API index ranging from 0 to (<a class="el" href="portaudio_8h.html#a19dbdb7c8702e3f4bfc0cdb99dac3dd9">Pa_GetHostApiCount()</a>-1)</td></tr>
<tr><td class="paramname">hostApiDeviceIndex</td><td>A valid per-host device index in the range 0 to (Pa_GetHostApiInfo(hostApi)->deviceCount-1)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A non-negative PaDeviceIndex ranging from 0 to (<a class="el" href="portaudio_8h.html#acfe4d3c5ec1a343f459981bfa2057f8d">Pa_GetDeviceCount()</a>-1) or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.</dd></dl>
<p>A paInvalidHostApi error code indicates that the host API index specified by the hostApi parameter is out of range.</p>
<p>A paInvalidDevice error code indicates that the hostApiDeviceIndex parameter is out of range.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structPaHostApiInfo.html">PaHostApiInfo</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a081c3975126d20b4226facfb7ba0620f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#aeef6da084c57c70aa94be97411e19930">PaHostApiIndex</a> Pa_HostApiTypeIdToHostApiIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a8eaebe3d39c5ea45598da8f86dc2e5ae">PaHostApiTypeId</a> </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a static host API unique identifier, into a runtime host API index.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>A unique host API identifier belonging to the PaHostApiTypeId enumeration.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A valid PaHostApiIndex ranging from 0 to (<a class="el" href="portaudio_8h.html#a19dbdb7c8702e3f4bfc0cdb99dac3dd9">Pa_GetHostApiCount()</a>-1) or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.</dd></dl>
<p>The paHostApiNotFound error code indicates that the host API specified by the type parameter is not available.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a8eaebe3d39c5ea45598da8f86dc2e5ae">PaHostApiTypeId</a> </dd></dl>
</div>
</div>
<a class="anchor" id="abed859482d156622d9332dff9b2d89da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_Initialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Library initialization function - call this before using PortAudio. This function initializes internal data structures and prepares underlying host APIs for use. With the exception of <a class="el" href="portaudio_8h.html#a66da08bcf908e0849c62a6b47f50d7b4">Pa_GetVersion()</a>, <a class="el" href="portaudio_8h.html#a28f3fd9e6d9f933cc695abea71c4b445">Pa_GetVersionText()</a>, and <a class="el" href="portaudio_8h.html#ae606855a611cf29c7d2d7421df5e3b5d">Pa_GetErrorText()</a>, this function MUST be called before using any other PortAudio API functions.</p>
<p>If <a class="el" href="portaudio_8h.html#abed859482d156622d9332dff9b2d89da">Pa_Initialize()</a> is called multiple times, each successful call must be matched with a corresponding call to <a class="el" href="portaudio_8h.html#a0db317604e916e8bd6098e60e6237221">Pa_Terminate()</a>. Pairs of calls to <a class="el" href="portaudio_8h.html#abed859482d156622d9332dff9b2d89da">Pa_Initialize()</a>/Pa_Terminate() may overlap, and are not required to be fully nested.</p>
<p>Note that if <a class="el" href="portaudio_8h.html#abed859482d156622d9332dff9b2d89da">Pa_Initialize()</a> returns an error code, <a class="el" href="portaudio_8h.html#a0db317604e916e8bd6098e60e6237221">Pa_Terminate()</a> should NOT be called.</p>
<dl class="section return"><dt>Returns</dt><dd>paNoError if successful, otherwise an error code indicating the cause of failure.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a0db317604e916e8bd6098e60e6237221">Pa_Terminate</a> </dd></dl>
</div>
</div>
<a class="anchor" id="abdb313743d6efef26cecdae787a2bd3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_IsFormatSupported </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> * </td>
<td class="paramname"><em>inputParameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> * </td>
<td class="paramname"><em>outputParameters</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine whether it would be possible to open a stream with the specified parameters.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputParameters</td><td>A structure that describes the input parameters used to open a stream. The suggestedLatency field is ignored. See <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> for a description of these parameters. inputParameters must be NULL for output-only streams.</td></tr>
<tr><td class="paramname">outputParameters</td><td>A structure that describes the output parameters used to open a stream. The suggestedLatency field is ignored. See <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> for a description of these parameters. outputParameters must be NULL for input-only streams.</td></tr>
<tr><td class="paramname">sampleRate</td><td>The required sampleRate. For full-duplex streams it is the sample rate for both input and output</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns 0 if the format is supported, and an error code indicating why the format is not supported otherwise. The constant paFormatIsSupported is provided to compare with the return value for success.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a400df642339bf4112333060af6a43c0f">paFormatIsSupported</a>, <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1f8709c4971932643681a6f374c4bb5a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_IsStreamActive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine whether the stream is active. A stream is active after a successful call to <a class="el" href="portaudio_8h.html#a7432aadd26c40452da12fa99fc1a047b">Pa_StartStream()</a>, until it becomes inactive either as a result of a call to <a class="el" href="portaudio_8h.html#af18dd60220251286c337631a855e38a0">Pa_StopStream()</a> or <a class="el" href="portaudio_8h.html#a138e57abde4e833c457b64895f638a25">Pa_AbortStream()</a>, or as a result of a return value other than paContinue from the stream callback. In the latter case, the stream is considered inactive after the last buffer has finished playing.</p>
<dl class="section return"><dt>Returns</dt><dd>Returns one (1) when the stream is active (ie playing or recording audio), zero (0) when not playing or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#af18dd60220251286c337631a855e38a0">Pa_StopStream</a>, <a class="el" href="portaudio_8h.html#a138e57abde4e833c457b64895f638a25">Pa_AbortStream</a>, <a class="el" href="portaudio_8h.html#a52d778c985ae9d566de7e13529cc771f">Pa_IsStreamStopped</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a52d778c985ae9d566de7e13529cc771f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_IsStreamStopped </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine whether the stream is stopped. A stream is considered to be stopped prior to a successful call to Pa_StartStream and after a successful call to Pa_StopStream or Pa_AbortStream. If a stream callback returns a value other than paContinue the stream is NOT considered to be stopped.</p>
<dl class="section return"><dt>Returns</dt><dd>Returns one (1) when the stream is stopped, zero (0) when the stream is running or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#af18dd60220251286c337631a855e38a0">Pa_StopStream</a>, <a class="el" href="portaudio_8h.html#a138e57abde4e833c457b64895f638a25">Pa_AbortStream</a>, <a class="el" href="portaudio_8h.html#a1f8709c4971932643681a6f374c4bb5a">Pa_IsStreamActive</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0a12735ac191200f696a43b87667b714"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_OpenDefaultStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> ** </td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numInputChannels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numOutputChannels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> </td>
<td class="paramname"><em>sampleFormat</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">unsigned long </td>
<td class="paramname"><em>framesPerBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a8a60fb2a5ec9cbade3f54a9c978e2710">PaStreamCallback</a> * </td>
<td class="paramname"><em>streamCallback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userData</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A simplified version of <a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream()</a> that opens the default input and/or output devices.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>The address of a PaStream pointer which will receive a pointer to the newly opened stream.</td></tr>
<tr><td class="paramname">numInputChannels</td><td>The number of channels of sound that will be supplied to the stream callback or returned by Pa_ReadStream. It can range from 1 to the value of maxInputChannels in the <a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a> record for the default input device. If 0 the stream is opened as an output-only stream.</td></tr>
<tr><td class="paramname">numOutputChannels</td><td>The number of channels of sound to be delivered to the stream callback or passed to Pa_WriteStream. It can range from 1 to the value of maxOutputChannels in the <a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a> record for the default output device. If 0 the stream is opened as an output-only stream.</td></tr>
<tr><td class="paramname">sampleFormat</td><td>The sample format of both the input and output buffers provided to the callback or passed to and from Pa_ReadStream and Pa_WriteStream. sampleFormat may be any of the formats described by the PaSampleFormat enumeration.</td></tr>
<tr><td class="paramname">sampleRate</td><td>Same as Pa_OpenStream parameter of the same name. </td></tr>
<tr><td class="paramname">framesPerBuffer</td><td>Same as Pa_OpenStream parameter of the same name. </td></tr>
<tr><td class="paramname">streamCallback</td><td>Same as Pa_OpenStream parameter of the same name. </td></tr>
<tr><td class="paramname">userData</td><td>Same as Pa_OpenStream parameter of the same name.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>As for Pa_OpenStream</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream</a>, <a class="el" href="portaudio_8h.html#a8a60fb2a5ec9cbade3f54a9c978e2710">PaStreamCallback</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a443ad16338191af364e3be988014cbbe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_OpenStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> ** </td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> * </td>
<td class="paramname"><em>inputParameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> * </td>
<td class="paramname"><em>outputParameters</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">unsigned long </td>
<td class="paramname"><em>framesPerBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a37c7ac3ace7d2dd1430f40ecdee4ebb6">PaStreamFlags</a> </td>
<td class="paramname"><em>streamFlags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a8a60fb2a5ec9cbade3f54a9c978e2710">PaStreamCallback</a> * </td>
<td class="paramname"><em>streamCallback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userData</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens a stream for either input, output or both.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>The address of a PaStream pointer which will receive a pointer to the newly opened stream.</td></tr>
<tr><td class="paramname">inputParameters</td><td>A structure that describes the input parameters used by the opened stream. See <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> for a description of these parameters. inputParameters must be NULL for output-only streams.</td></tr>
<tr><td class="paramname">outputParameters</td><td>A structure that describes the output parameters used by the opened stream. See <a class="el" href="structPaStreamParameters.html">PaStreamParameters</a> for a description of these parameters. outputParameters must be NULL for input-only streams.</td></tr>
<tr><td class="paramname">sampleRate</td><td>The desired sampleRate. For full-duplex streams it is the sample rate for both input and output</td></tr>
<tr><td class="paramname">framesPerBuffer</td><td>The number of frames passed to the stream callback function, or the preferred block granularity for a blocking read/write stream. The special value paFramesPerBufferUnspecified (0) may be used to request that the stream callback will receive an optimal (and possibly varying) number of frames based on host requirements and the requested latency settings. Note: With some host APIs, the use of non-zero framesPerBuffer for a callback stream may introduce an additional layer of buffering which could introduce additional latency. PortAudio guarantees that the additional latency will be kept to the theoretical minimum however, it is strongly recommended that a non-zero framesPerBuffer value only be used when your algorithm requires a fixed number of frames per stream callback.</td></tr>
<tr><td class="paramname">streamFlags</td><td>Flags which modify the behavior of the streaming process. This parameter may contain a combination of flags ORed together. Some flags may only be relevant to certain buffer formats.</td></tr>
<tr><td class="paramname">streamCallback</td><td>A pointer to a client supplied function that is responsible for processing and filling input and output buffers. If this parameter is NULL the stream will be opened in 'blocking read/write' mode. In blocking mode, the client can receive sample data using Pa_ReadStream and write sample data using Pa_WriteStream, the number of samples that may be read or written without blocking is returned by Pa_GetStreamReadAvailable and Pa_GetStreamWriteAvailable respectively.</td></tr>
<tr><td class="paramname">userData</td><td>A client supplied pointer which is passed to the stream callback function. It could for example, contain a pointer to instance data necessary for processing the audio buffers. This parameter is ignored if streamCallback is NULL.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Upon success <a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream()</a> returns paNoError and places a pointer to a valid PaStream in the stream argument. The stream is inactive (stopped). If a call to <a class="el" href="portaudio_8h.html#a443ad16338191af364e3be988014cbbe">Pa_OpenStream()</a> fails, a non-zero error code is returned (see PaError for possible error codes) and the value of stream is invalid.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structPaStreamParameters.html">PaStreamParameters</a>, <a class="el" href="portaudio_8h.html#a8a60fb2a5ec9cbade3f54a9c978e2710">PaStreamCallback</a>, <a class="el" href="portaudio_8h.html#a0b62d4b74b5d3d88368e9e4c0b8b2dc7">Pa_ReadStream</a>, <a class="el" href="portaudio_8h.html#a075a6efb503a728213bdae24347ed27d">Pa_WriteStream</a>, <a class="el" href="portaudio_8h.html#ad04c33f045fa58d7b705b56b1fd3e816">Pa_GetStreamReadAvailable</a>, <a class="el" href="portaudio_8h.html#a25595acf48733ec32045aa189c3caa61">Pa_GetStreamWriteAvailable</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0b62d4b74b5d3d88368e9e4c0b8b2dc7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_ReadStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>frames</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read samples from an input stream. The function doesn't return until the entire buffer has been filled - this may involve waiting for the operating system to supply the data.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>A pointer to an open stream previously created with Pa_OpenStream.</td></tr>
<tr><td class="paramname">buffer</td><td>A pointer to a buffer of sample frames. The buffer contains samples in the format specified by the inputParameters->sampleFormat field used to open the stream, and the number of channels specified by inputParameters->numChannels. If non-interleaved samples were requested using the paNonInterleaved sample format flag, buffer is a pointer to the first element of an array of buffer pointers, one non-interleaved buffer for each channel.</td></tr>
<tr><td class="paramname">frames</td><td>The number of frames to be read into buffer. This parameter is not constrained to a specific range, however high performance applications will want to match this parameter to the framesPerBuffer parameter used when opening the stream.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success PaNoError will be returned, or PaInputOverflowed if input data was discarded by PortAudio after the previous call and before this call. </dd></dl>
</div>
</div>
<a class="anchor" id="aa11e7b06b2cde8621551f5d527965838"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_SetStreamFinishedCallback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#ab2530ee0cb756c67726f9074d3482ef2">PaStreamFinishedCallback</a> * </td>
<td class="paramname"><em>streamFinishedCallback</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register a stream finished callback function which will be called when the stream becomes inactive. See the description of PaStreamFinishedCallback for further details about when the callback will be called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>a pointer to a PaStream that is in the stopped state - if the stream is not stopped, the stream's finished callback will remain unchanged and an error code will be returned.</td></tr>
<tr><td class="paramname">streamFinishedCallback</td><td>a pointer to a function with the same signature as PaStreamFinishedCallback, that will be called when the stream becomes inactive. Passing NULL for this parameter will un-register a previously registered stream finished callback function.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>on success returns paNoError, otherwise an error code indicating the cause of the error.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#ab2530ee0cb756c67726f9074d3482ef2">PaStreamFinishedCallback</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1b3c20044c9401c42add29475636e83d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Pa_Sleep </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>msec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Put the caller to sleep for at least 'msec' milliseconds. This function is provided only as a convenience for authors of portable code (such as the tests and examples in the PortAudio distribution.)</p>
<p>The function may sleep longer than requested so don't rely on this for accurate musical timing. </p>
</div>
</div>
<a class="anchor" id="a7432aadd26c40452da12fa99fc1a047b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_StartStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Commences audio processing. </p>
</div>
</div>
<a class="anchor" id="af18dd60220251286c337631a855e38a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_StopStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Terminates audio processing. It waits until all pending audio buffers have been played before it returns. </p>
</div>
</div>
<a class="anchor" id="a0db317604e916e8bd6098e60e6237221"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_Terminate </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Library termination function - call this when finished using PortAudio. This function deallocates all resources allocated by PortAudio since it was initialized by a call to <a class="el" href="portaudio_8h.html#abed859482d156622d9332dff9b2d89da">Pa_Initialize()</a>. In cases where Pa_Initialise() has been called multiple times, each call must be matched with a corresponding call to <a class="el" href="portaudio_8h.html#a0db317604e916e8bd6098e60e6237221">Pa_Terminate()</a>. The final matching call to <a class="el" href="portaudio_8h.html#a0db317604e916e8bd6098e60e6237221">Pa_Terminate()</a> will automatically close any PortAudio streams that are still open.</p>
<p><a class="el" href="portaudio_8h.html#a0db317604e916e8bd6098e60e6237221">Pa_Terminate()</a> MUST be called before exiting a program which uses PortAudio. Failure to do so may result in serious resource leaks, such as audio devices not being available until the next reboot.</p>
<dl class="section return"><dt>Returns</dt><dd>paNoError if successful, otherwise an error code indicating the cause of failure.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="portaudio_8h.html#abed859482d156622d9332dff9b2d89da">Pa_Initialize</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a075a6efb503a728213bdae24347ed27d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> Pa_WriteStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> * </td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>frames</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write samples to an output stream. This function doesn't return until the entire buffer has been consumed - this may involve waiting for the operating system to consume the data.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>A pointer to an open stream previously created with Pa_OpenStream.</td></tr>
<tr><td class="paramname">buffer</td><td>A pointer to a buffer of sample frames. The buffer contains samples in the format specified by the outputParameters->sampleFormat field used to open the stream, and the number of channels specified by outputParameters->numChannels. If non-interleaved samples were requested using the paNonInterleaved sample format flag, buffer is a pointer to the first element of an array of buffer pointers, one non-interleaved buffer for each channel.</td></tr>
<tr><td class="paramname">frames</td><td>The number of frames to be written from buffer. This parameter is not constrained to a specific range, however high performance applications will want to match this parameter to the framesPerBuffer parameter used when opening the stream.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success PaNoError will be returned, or paOutputUnderflowed if additional output data was inserted after the previous call and before this call. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 25 2014 21:08:45 for PortAudio by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|