/usr/share/doc/portaudio19-doc/doc/html/pa__asio_8h.html is in portaudio19-doc 19.6.0-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>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 id="projectalign" 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.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></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 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 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 id="a73860435fa4ce6edbb85d360bc825e05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73860435fa4ce6edbb85d360bc825e05">§ </a></span>PaAsio_GetAvailableLatencyValues</h2>
<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 id="a95dbac9747083dcee51b1e0e4695a912"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95dbac9747083dcee51b1e0e4695a912">§ </a></span>PaAsio_GetAvailableBufferSizes()</h2>
<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 id="abaafacb711225e7c6158fff3b3e8b87a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abaafacb711225e7c6158fff3b3e8b87a">§ </a></span>PaAsio_GetInputChannelName()</h2>
<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 id="a97bd5b2192c1321a492ba24d7ef843fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97bd5b2192c1321a492ba24d7ef843fa">§ </a></span>PaAsio_GetOutputChannelName()</h2>
<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 id="a838e2a8ed83db7cf5f2864492f3c78fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a838e2a8ed83db7cf5f2864492f3c78fc">§ </a></span>PaAsio_SetStreamSampleRate()</h2>
<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 id="ac9449ca8f0aedaa7b93027cdca3d6ba3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9449ca8f0aedaa7b93027cdca3d6ba3">§ </a></span>PaAsio_ShowControlPanel()</h2>
<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 -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
|