<!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: pa_asio.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.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><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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">pa_asio.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>ASIO-specific PortAudio API extension header file.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="portaudio_8h_source.html">portaudio.h</a>"</code><br/>
</div>
<p><a href="pa__asio_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="structPaAsioStreamInfo.html">PaAsioStreamInfo</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:a73860435fa4ce6edbb85d360bc825e05"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pa__asio_8h.html#a73860435fa4ce6edbb85d360bc825e05">PaAsio_GetAvailableLatencyValues</a>   <a class="el" href="pa__asio_8h.html#a95dbac9747083dcee51b1e0e4695a912">PaAsio_GetAvailableBufferSizes</a></td></tr>
<tr class="separator:a73860435fa4ce6edbb85d360bc825e05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79421fc86f6f900602f6c735aaead654"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79421fc86f6f900602f6c735aaead654"></a>
#define </td><td class="memItemRight" valign="bottom"><b>paAsioUseChannelSelectors</b>   (0x01)</td></tr>
<tr class="separator:a79421fc86f6f900602f6c735aaead654"><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:a943a839eab0c7c9d71f1afa875d1fb2d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a943a839eab0c7c9d71f1afa875d1fb2d"></a>
typedef struct <a class="el" href="structPaAsioStreamInfo.html">PaAsioStreamInfo</a> </td><td class="memItemRight" valign="bottom"><b>PaAsioStreamInfo</b></td></tr>
<tr class="separator:a943a839eab0c7c9d71f1afa875d1fb2d"><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:a95dbac9747083dcee51b1e0e4695a912"><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="pa__asio_8h.html#a95dbac9747083dcee51b1e0e4695a912">PaAsio_GetAvailableBufferSizes</a> (<a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> device, long *minBufferSizeFrames, long *maxBufferSizeFrames, long *preferredBufferSizeFrames, long *granularity)</td></tr>
<tr class="separator:a95dbac9747083dcee51b1e0e4695a912"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9449ca8f0aedaa7b93027cdca3d6ba3"><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="pa__asio_8h.html#ac9449ca8f0aedaa7b93027cdca3d6ba3">PaAsio_ShowControlPanel</a> (<a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> device, void *systemSpecific)</td></tr>
<tr class="separator:ac9449ca8f0aedaa7b93027cdca3d6ba3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abaafacb711225e7c6158fff3b3e8b87a"><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="pa__asio_8h.html#abaafacb711225e7c6158fff3b3e8b87a">PaAsio_GetInputChannelName</a> (<a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> device, int channelIndex, const char **channelName)</td></tr>
<tr class="separator:abaafacb711225e7c6158fff3b3e8b87a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97bd5b2192c1321a492ba24d7ef843fa"><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="pa__asio_8h.html#a97bd5b2192c1321a492ba24d7ef843fa">PaAsio_GetOutputChannelName</a> (<a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> device, int channelIndex, const char **channelName)</td></tr>
<tr class="separator:a97bd5b2192c1321a492ba24d7ef843fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a838e2a8ed83db7cf5f2864492f3c78fc"><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="pa__asio_8h.html#a838e2a8ed83db7cf5f2864492f3c78fc">PaAsio_SetStreamSampleRate</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream, double sampleRate)</td></tr>
<tr class="separator:a838e2a8ed83db7cf5f2864492f3c78fc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>ASIO-specific PortAudio API extension header file. </p>
<p>Definition in file <a class="el" href="pa__asio_8h_source.html">pa_asio.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a73860435fa4ce6edbb85d360bc825e05"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PaAsio_GetAvailableLatencyValues   <a class="el" href="pa__asio_8h.html#a95dbac9747083dcee51b1e0e4695a912">PaAsio_GetAvailableBufferSizes</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Backwards compatibility alias for PaAsio_GetAvailableBufferSizes</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="pa__asio_8h.html#a95dbac9747083dcee51b1e0e4695a912">PaAsio_GetAvailableBufferSizes</a> </dd></dl>
<p>Definition at line <a class="el" href="pa__asio_8h_source.html#l00078">78</a> of file <a class="el" href="pa__asio_8h_source.html">pa_asio.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a95dbac9747083dcee51b1e0e4695a912"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> PaAsio_GetAvailableBufferSizes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </td>
<td class="paramname"><em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long * </td>
<td class="paramname"><em>minBufferSizeFrames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long * </td>
<td class="paramname"><em>maxBufferSizeFrames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long * </td>
<td class="paramname"><em>preferredBufferSizeFrames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long * </td>
<td class="paramname"><em>granularity</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve legal native buffer sizes for the specificed device, in sample frames.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">device</td><td>The global index of the device about which the query is being made. </td></tr>
<tr><td class="paramname">minBufferSizeFrames</td><td>A pointer to the location which will receive the minimum buffer size value. </td></tr>
<tr><td class="paramname">maxBufferSizeFrames</td><td>A pointer to the location which will receive the maximum buffer size value. </td></tr>
<tr><td class="paramname">preferredBufferSizeFrames</td><td>A pointer to the location which will receive the preferred buffer size value. </td></tr>
<tr><td class="paramname">granularity</td><td>A pointer to the location which will receive the "granularity". This value determines the step size used to compute the legal values between minBufferSizeFrames and maxBufferSizeFrames. If granularity is -1 then available buffer size values are powers of two.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd>ASIOGetBufferSize in the ASIO SDK.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>: this function used to be called PaAsio_GetAvailableLatencyValues. There is a #define that maps PaAsio_GetAvailableLatencyValues to this function for backwards compatibility. </dd></dl>
</div>
</div>
<a class="anchor" id="abaafacb711225e7c6158fff3b3e8b87a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> PaAsio_GetInputChannelName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </td>
<td class="paramname"><em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>channelIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>channelName</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a pointer to a string containing the name of the specified input channel. The string is valid until Pa_Terminate is called.</p>
<p>The string will be no longer than 32 characters including the null terminator. </p>
</div>
</div>
<a class="anchor" id="a97bd5b2192c1321a492ba24d7ef843fa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> PaAsio_GetOutputChannelName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </td>
<td class="paramname"><em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>channelIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>channelName</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a pointer to a string containing the name of the specified input channel. The string is valid until Pa_Terminate is called.</p>
<p>The string will be no longer than 32 characters including the null terminator. </p>
</div>
</div>
<a class="anchor" id="a838e2a8ed83db7cf5f2864492f3c78fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> PaAsio_SetStreamSampleRate </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">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>Set the sample rate of an open paASIO stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>The stream to operate on. </td></tr>
<tr><td class="paramname">sampleRate</td><td>The new sample rate.</td></tr>
</table>
</dd>
</dl>
<p>Note that this function may fail if the stream is alredy running and the ASIO driver does not support switching the sample rate of a running stream.</p>
<p>Returns paIncompatibleStreamHostApi if stream is not a paASIO stream. </p>
</div>
</div>
<a class="anchor" id="ac9449ca8f0aedaa7b93027cdca3d6ba3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4949e4a8ef9f9dbe8cbee414ce69841d">PaError</a> PaAsio_ShowControlPanel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </td>
<td class="paramname"><em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>systemSpecific</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Display the ASIO control panel for the specified device.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">device</td><td>The global index of the device whose control panel is to be displayed. </td></tr>
<tr><td class="paramname">systemSpecific</td><td>On Windows, the calling application's main window handle, on Macintosh this value should be zero. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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
>
130
