<!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.3.1"/>
<title>PortAudio: com.portaudio.PortAudio Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="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.3.1 -->
<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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>com</b></li><li class="navelem"><b>portaudio</b></li><li class="navelem"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<div class="title">com.portaudio.PortAudio Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a472cdb12b5c715b463e9a0f9754e6794"><td class="memItemLeft" align="right" valign="top">static native int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a472cdb12b5c715b463e9a0f9754e6794">getVersion</a> ()</td></tr>
<tr class="separator:a472cdb12b5c715b463e9a0f9754e6794"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0f4312152d15a594aaa978fa8f7bc33"><td class="memItemLeft" align="right" valign="top">static native String </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#af0f4312152d15a594aaa978fa8f7bc33">getVersionText</a> ()</td></tr>
<tr class="separator:af0f4312152d15a594aaa978fa8f7bc33"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a056b212026d02c19607d81a4faf8a4b0"><td class="memItemLeft" align="right" valign="top">static native void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a056b212026d02c19607d81a4faf8a4b0">initialize</a> ()</td></tr>
<tr class="separator:a056b212026d02c19607d81a4faf8a4b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d20afde68cdc2834850cda643717cfe"><td class="memItemLeft" align="right" valign="top">static native void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a2d20afde68cdc2834850cda643717cfe">terminate</a> ()</td></tr>
<tr class="separator:a2d20afde68cdc2834850cda643717cfe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a687ec58fa9debb2c9a15dc885b389537"><td class="memItemLeft" align="right" valign="top">static native int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a687ec58fa9debb2c9a15dc885b389537">getDeviceCount</a> ()</td></tr>
<tr class="separator:a687ec58fa9debb2c9a15dc885b389537"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a7313844e5ac030a8129c845f173130"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classcom_1_1portaudio_1_1DeviceInfo.html">DeviceInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a5a7313844e5ac030a8129c845f173130">getDeviceInfo</a> (int index)</td></tr>
<tr class="separator:a5a7313844e5ac030a8129c845f173130"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b8711db178f99c4980dee9b46ac810a"><td class="memItemLeft" align="right" valign="top">static native int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a5b8711db178f99c4980dee9b46ac810a">getHostApiCount</a> ()</td></tr>
<tr class="separator:a5b8711db178f99c4980dee9b46ac810a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9feef9e0a5da56914633c2f2482543c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classcom_1_1portaudio_1_1HostApiInfo.html">HostApiInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#ad9feef9e0a5da56914633c2f2482543c">getHostApiInfo</a> (int index)</td></tr>
<tr class="separator:ad9feef9e0a5da56914633c2f2482543c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ad822032493ff1144000f5673daf569"><td class="memItemLeft" align="right" valign="top">static native int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a4ad822032493ff1144000f5673daf569">hostApiTypeIdToHostApiIndex</a> (int hostApiType)</td></tr>
<tr class="separator:a4ad822032493ff1144000f5673daf569"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6403a73147c43aca3fa733e4ba71c67c"><td class="memItemLeft" align="right" valign="top">static native int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a6403a73147c43aca3fa733e4ba71c67c">hostApiDeviceIndexToDeviceIndex</a> (int hostApiIndex, int apiDeviceIndex)</td></tr>
<tr class="separator:a6403a73147c43aca3fa733e4ba71c67c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10036af29e71cc9f07e63bfd6030045b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10036af29e71cc9f07e63bfd6030045b"></a>
static native int </td><td class="memItemRight" valign="bottom"><b>getDefaultInputDevice</b> ()</td></tr>
<tr class="separator:a10036af29e71cc9f07e63bfd6030045b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0f16ff3269d3b8166a7581de751c427"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0f16ff3269d3b8166a7581de751c427"></a>
static native int </td><td class="memItemRight" valign="bottom"><b>getDefaultOutputDevice</b> ()</td></tr>
<tr class="separator:ad0f16ff3269d3b8166a7581de751c427"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae44bdce73311d1ecbaf9667ab58628de"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae44bdce73311d1ecbaf9667ab58628de"></a>
static native int </td><td class="memItemRight" valign="bottom"><b>getDefaultHostApi</b> ()</td></tr>
<tr class="separator:ae44bdce73311d1ecbaf9667ab58628de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1f0b8268c0819eced0aea804b28638a"><td class="memItemLeft" align="right" valign="top">static native int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#ac1f0b8268c0819eced0aea804b28638a">isFormatSupported</a> (<a class="el" href="classcom_1_1portaudio_1_1StreamParameters.html">StreamParameters</a> inputStreamParameters, <a class="el" href="classcom_1_1portaudio_1_1StreamParameters.html">StreamParameters</a> outputStreamParameters, int sampleRate)</td></tr>
<tr class="separator:ac1f0b8268c0819eced0aea804b28638a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32cbdd9a1e8f4cb1c0ad475a6cbc579b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html">BlockingStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a32cbdd9a1e8f4cb1c0ad475a6cbc579b">openStream</a> (<a class="el" href="classcom_1_1portaudio_1_1StreamParameters.html">StreamParameters</a> inputStreamParameters, <a class="el" href="classcom_1_1portaudio_1_1StreamParameters.html">StreamParameters</a> outputStreamParameters, int sampleRate, int framesPerBuffer, int flags)</td></tr>
<tr class="separator:a32cbdd9a1e8f4cb1c0ad475a6cbc579b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a2f395bc99fe477caba5d221849e14697"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f395bc99fe477caba5d221849e14697"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>FLAG_CLIP_OFF</b> = (1 << 0)</td></tr>
<tr class="separator:a2f395bc99fe477caba5d221849e14697"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b21f44b7fd8e5e78a314b5a043e4196"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b21f44b7fd8e5e78a314b5a043e4196"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>FLAG_DITHER_OFF</b> = (1 << 1)</td></tr>
<tr class="separator:a8b21f44b7fd8e5e78a314b5a043e4196"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d96208f8de10d8b5888aeaf5e43fa57"><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a2d96208f8de10d8b5888aeaf5e43fa57">FORMAT_FLOAT_32</a> = (1 << 0)</td></tr>
<tr class="separator:a2d96208f8de10d8b5888aeaf5e43fa57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9b9140287ddfa452a78a90762b8e2c2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9b9140287ddfa452a78a90762b8e2c2"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>FORMAT_INT_32</b> = (1 << 1)</td></tr>
<tr class="separator:ae9b9140287ddfa452a78a90762b8e2c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a63350a8781554741a49c72753551dd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a63350a8781554741a49c72753551dd"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>FORMAT_INT_24</b> = (1 << 2)</td></tr>
<tr class="separator:a7a63350a8781554741a49c72753551dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a038b2ecc4e7aff2cd9159d6c1acb2f17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a038b2ecc4e7aff2cd9159d6c1acb2f17"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>FORMAT_INT_16</b> = (1 << 3)</td></tr>
<tr class="separator:a038b2ecc4e7aff2cd9159d6c1acb2f17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a598b92996b1e04767e4138d9851a800b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a598b92996b1e04767e4138d9851a800b"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>FORMAT_INT_8</b> = (1 << 4)</td></tr>
<tr class="separator:a598b92996b1e04767e4138d9851a800b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f0cadf5525b51a67a75c02f22014ed0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f0cadf5525b51a67a75c02f22014ed0"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>FORMAT_UINT_8</b> = (1 << 5)</td></tr>
<tr class="separator:a1f0cadf5525b51a67a75c02f22014ed0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5aeefa7a9316b0fd60265a3b336e7a40"><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a5aeefa7a9316b0fd60265a3b336e7a40">HOST_API_TYPE_DEV</a> = 0</td></tr>
<tr class="separator:a5aeefa7a9316b0fd60265a3b336e7a40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a986e1b33fc0f6dfb6c7d562a4d51d9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a986e1b33fc0f6dfb6c7d562a4d51d9"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_DIRECTSOUND</b> = 1</td></tr>
<tr class="separator:a6a986e1b33fc0f6dfb6c7d562a4d51d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5aa443407edd49f2aefe05c05a05cd3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5aa443407edd49f2aefe05c05a05cd3"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_MME</b> = 2</td></tr>
<tr class="separator:aa5aa443407edd49f2aefe05c05a05cd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada483f7837f8bba9cc062f7fd068bf6f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada483f7837f8bba9cc062f7fd068bf6f"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_ASIO</b> = 3</td></tr>
<tr class="separator:ada483f7837f8bba9cc062f7fd068bf6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e994d6f1b8393c1fadf330fc18b5649"><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a3e994d6f1b8393c1fadf330fc18b5649">HOST_API_TYPE_SOUNDMANAGER</a> = 4</td></tr>
<tr class="separator:a3e994d6f1b8393c1fadf330fc18b5649"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0408bbb1b5312837354f6622ed56da5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0408bbb1b5312837354f6622ed56da5"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_COREAUDIO</b> = 5</td></tr>
<tr class="separator:ab0408bbb1b5312837354f6622ed56da5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cb0af6edee17cf295e8049704022d00"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cb0af6edee17cf295e8049704022d00"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_OSS</b> = 7</td></tr>
<tr class="separator:a0cb0af6edee17cf295e8049704022d00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2cf938238890b34503d58db47a454e72"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2cf938238890b34503d58db47a454e72"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_ALSA</b> = 8</td></tr>
<tr class="separator:a2cf938238890b34503d58db47a454e72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a034414578c6cb7d1ef05dbb97d4030ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a034414578c6cb7d1ef05dbb97d4030ef"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_AL</b> = 9</td></tr>
<tr class="separator:a034414578c6cb7d1ef05dbb97d4030ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9947391c7afe60e9bfef0b8362ab9467"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9947391c7afe60e9bfef0b8362ab9467"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_BEOS</b> = 10</td></tr>
<tr class="separator:a9947391c7afe60e9bfef0b8362ab9467"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61826bf26d326ff98510f1274f6f3f5b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61826bf26d326ff98510f1274f6f3f5b"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_WDMKS</b> = 11</td></tr>
<tr class="separator:a61826bf26d326ff98510f1274f6f3f5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a883a151e9c2fa3df4bc2a246441dcf65"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a883a151e9c2fa3df4bc2a246441dcf65"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_JACK</b> = 12</td></tr>
<tr class="separator:a883a151e9c2fa3df4bc2a246441dcf65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a878906a801ec0974c8379defcbb1a45f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a878906a801ec0974c8379defcbb1a45f"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_WASAPI</b> = 13</td></tr>
<tr class="separator:a878906a801ec0974c8379defcbb1a45f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad72258e139b9133a8f20723e8aefa184"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad72258e139b9133a8f20723e8aefa184"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_AUDIOSCIENCE</b> = 14</td></tr>
<tr class="separator:ad72258e139b9133a8f20723e8aefa184"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2432d2945896284335ab4adcf4b9ddf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2432d2945896284335ab4adcf4b9ddf"></a>
static final int </td><td class="memItemRight" valign="bottom"><b>HOST_API_TYPE_COUNT</b> = 15</td></tr>
<tr class="separator:ab2432d2945896284335ab4adcf4b9ddf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Java methods that call <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a> via JNI. This is a portable audio I/O library that can be used as an alternative to JavaSound.</p>
<p>Please see the <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a> documentation for a full explanation.</p>
<p><a href="http://portaudio.com/docs/">http://portaudio.com/docs/</a> <a href="http://portaudio.com/docs/v19-doxydocs/portaudio_8h.html">http://portaudio.com/docs/v19-doxydocs/portaudio_8h.html</a></p>
<p>This Java binding does not support audio callbacks because an audio callback should never block. Calling into a Java virtual machine might block for garbage collection or synchronization. So only the blocking read/write mode is supported.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html">BlockingStream</a> </dd>
<dd>
<a class="el" href="classcom_1_1portaudio_1_1DeviceInfo.html">DeviceInfo</a> </dd>
<dd>
<a class="el" href="classcom_1_1portaudio_1_1HostApiInfo.html">HostApiInfo</a> </dd>
<dd>
<a class="el" href="classcom_1_1portaudio_1_1StreamInfo.html">StreamInfo</a> </dd>
<dd>
<a class="el" href="classcom_1_1portaudio_1_1StreamParameters.html">StreamParameters</a></dd></dl>
<dl class="section author"><dt>Author</dt><dd>Phil Burk </dd></dl>
<p>Definition at line <a class="el" href="PortAudio_8java_source.html#l00069">69</a> of file <a class="el" href="PortAudio_8java_source.html">PortAudio.java</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a687ec58fa9debb2c9a15dc885b389537"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static native int com.portaudio.PortAudio.getDeviceCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the number of available devices. The number of available devices may be zero. </dd></dl>
</div>
</div>
<a class="anchor" id="a5a7313844e5ac030a8129c845f173130"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcom_1_1portaudio_1_1DeviceInfo.html">DeviceInfo</a> com.portaudio.PortAudio.getDeviceInfo </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>A valid device index in the range 0 to (<a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a687ec58fa9debb2c9a15dc885b389537">getDeviceCount()</a>-1) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="classcom_1_1portaudio_1_1DeviceInfo.html">DeviceInfo</a> structure. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">RuntimeException</td><td>if the device parameter is out of range. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="PortAudio_8java_source.html#l00169">169</a> of file <a class="el" href="PortAudio_8java_source.html">PortAudio.java</a>.</p>
</div>
</div>
<a class="anchor" id="a5b8711db178f99c4980dee9b46ac810a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static native int com.portaudio.PortAudio.getHostApiCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the number of available host APIs. </dd></dl>
</div>
</div>
<a class="anchor" id="ad9feef9e0a5da56914633c2f2482543c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcom_1_1portaudio_1_1HostApiInfo.html">HostApiInfo</a> com.portaudio.PortAudio.getHostApiInfo </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>information about the Host API </dd></dl>
<p>Definition at line <a class="el" href="PortAudio_8java_source.html#l00188">188</a> of file <a class="el" href="PortAudio_8java_source.html">PortAudio.java</a>.</p>
</div>
</div>
<a class="anchor" id="a472cdb12b5c715b463e9a0f9754e6794"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static native int com.portaudio.PortAudio.getVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the release number of the currently running <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a> build, eg 1900. </dd></dl>
</div>
</div>
<a class="anchor" id="af0f4312152d15a594aaa978fa8f7bc33"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static native String com.portaudio.PortAudio.getVersionText </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a textual description of the current <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a> build, eg "PortAudio V19-devel 13 October 2002". </dd></dl>
</div>
</div>
<a class="anchor" id="a6403a73147c43aca3fa733e4ba71c67c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static native int com.portaudio.PortAudio.hostApiDeviceIndexToDeviceIndex </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>hostApiIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>apiDeviceIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hostApiIndex</td><td>A valid host API index ranging from 0 to (<a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a5b8711db178f99c4980dee9b46ac810a">getHostApiCount()</a>-1) </td></tr>
<tr><td class="paramname">apiDeviceIndex</td><td>A valid per-host device index in the range 0 to (getHostApiInfo(hostApi).deviceCount-1) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>standard <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a> device index </dd></dl>
</div>
</div>
<a class="anchor" id="a4ad822032493ff1144000f5673daf569"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static native int com.portaudio.PortAudio.hostApiTypeIdToHostApiIndex </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>hostApiType</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hostApiType</td><td>A unique host API identifier, for example HOST_API_TYPE_COREAUDIO. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a runtime host API index </dd></dl>
</div>
</div>
<a class="anchor" id="a056b212026d02c19607d81a4faf8a4b0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static native void com.portaudio.PortAudio.initialize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Library initialization function - call this before using <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a>. This function initializes internal data structures and prepares underlying host APIs for use. With the exception of <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a472cdb12b5c715b463e9a0f9754e6794">getVersion()</a>, <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#af0f4312152d15a594aaa978fa8f7bc33">getVersionText()</a>, and getErrorText(), this function MUST be called before using any other <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a> API functions. </p>
<p>Referenced by <a class="el" href="PlaySine_8java_source.html#l00045">com.portaudio.PlaySine.play()</a>.</p>
</div>
</div>
<a class="anchor" id="ac1f0b8268c0819eced0aea804b28638a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static native int com.portaudio.PortAudio.isFormatSupported </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcom_1_1portaudio_1_1StreamParameters.html">StreamParameters</a> </td>
<td class="paramname"><em>inputStreamParameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcom_1_1portaudio_1_1StreamParameters.html">StreamParameters</a> </td>
<td class="paramname"><em>outputStreamParameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>sampleRate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputStreamParameters</td><td>input description, may be null </td></tr>
<tr><td class="paramname">outputStreamParameters</td><td>output description, may be null </td></tr>
<tr><td class="paramname">sampleRate</td><td>typically 44100 or 48000, or maybe 22050, 16000, 8000, 96000 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if supported or a negative error </dd></dl>
</div>
</div>
<a class="anchor" id="a32cbdd9a1e8f4cb1c0ad475a6cbc579b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html">BlockingStream</a> com.portaudio.PortAudio.openStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcom_1_1portaudio_1_1StreamParameters.html">StreamParameters</a> </td>
<td class="paramname"><em>inputStreamParameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcom_1_1portaudio_1_1StreamParameters.html">StreamParameters</a> </td>
<td class="paramname"><em>outputStreamParameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>sampleRate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>framesPerBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputStreamParameters</td><td>input description, may be null </td></tr>
<tr><td class="paramname">outputStreamParameters</td><td>output description, may be null </td></tr>
<tr><td class="paramname">sampleRate</td><td>typically 44100 or 48000, or maybe 22050, 16000, 8000, 96000 </td></tr>
<tr><td class="paramname">framesPerBuffer</td><td></td></tr>
<tr><td class="paramname">flags</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Definition at line <a class="el" href="PortAudio_8java_source.html#l00250">250</a> of file <a class="el" href="PortAudio_8java_source.html">PortAudio.java</a>.</p>
</div>
</div>
<a class="anchor" id="a2d20afde68cdc2834850cda643717cfe"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static native void com.portaudio.PortAudio.terminate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Library termination function - call this when finished using <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a>. This function deallocates all resources allocated by <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a> since it was initialized by a call to <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a056b212026d02c19607d81a4faf8a4b0">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="classcom_1_1portaudio_1_1PortAudio.html#a2d20afde68cdc2834850cda643717cfe">terminate()</a>. The final matching call to <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html#a2d20afde68cdc2834850cda643717cfe">terminate()</a> will automatically close any <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a> streams that are still open. </p>
<p>Referenced by <a class="el" href="PlaySine_8java_source.html#l00045">com.portaudio.PlaySine.play()</a>.</p>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a2d96208f8de10d8b5888aeaf5e43fa57"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">final int com.portaudio.PortAudio.FORMAT_FLOAT_32 = (1 << 0)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sample Formats </p>
<p>Definition at line <a class="el" href="PortAudio_8java_source.html#l00075">75</a> of file <a class="el" href="PortAudio_8java_source.html">PortAudio.java</a>.</p>
<p>Referenced by <a class="el" href="BlockingStream_8java_source.html#l00093">com.portaudio.BlockingStream.read()</a>, and <a class="el" href="BlockingStream_8java_source.html#l00112">com.portaudio.BlockingStream.write()</a>.</p>
</div>
</div>
<a class="anchor" id="a5aeefa7a9316b0fd60265a3b336e7a40"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">final int com.portaudio.PortAudio.HOST_API_TYPE_DEV = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>These HOST_API_TYPES will not change in the future. </p>
<p>Definition at line <a class="el" href="PortAudio_8java_source.html#l00083">83</a> of file <a class="el" href="PortAudio_8java_source.html">PortAudio.java</a>.</p>
</div>
</div>
<a class="anchor" id="a3e994d6f1b8393c1fadf330fc18b5649"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">final int com.portaudio.PortAudio.HOST_API_TYPE_SOUNDMANAGER = 4</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Apple Sound Manager. Obsolete. </p>
<p>Definition at line <a class="el" href="PortAudio_8java_source.html#l00088">88</a> of file <a class="el" href="PortAudio_8java_source.html">PortAudio.java</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PortAudio_8java_source.html">PortAudio.java</a></li>
</ul>
</div><!-- contents -->
<hr size="1"><address style="text-align: right;"><small>Generated for PortAudio by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>1.8.3.1</small></address>
</body>
</html>
distrib
>
Fedora
>
18
>
x86_64
>
media
>
updates
>
by-pkgid
>
866ae5f99ebc53131e4da7c8445c0009
>
files
>
56
