/usr/share/doc/portaudio19-doc/doc/html/classcom_1_1portaudio_1_1BlockingStream.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 | <!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: com.portaudio.BlockingStream 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.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 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_1BlockingStream.html">BlockingStream</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">com.portaudio.BlockingStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4cb237d1596fcfb10adf7e21166bfd10"><td class="memItemLeft" align="right" valign="top">native int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html#a4cb237d1596fcfb10adf7e21166bfd10">getReadAvailable</a> ()</td></tr>
<tr class="separator:a4cb237d1596fcfb10adf7e21166bfd10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24fcac3b87ee7f15cbf97c9f821009dd"><td class="memItemLeft" align="right" valign="top">native int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html#a24fcac3b87ee7f15cbf97c9f821009dd">getWriteAvailable</a> ()</td></tr>
<tr class="separator:a24fcac3b87ee7f15cbf97c9f821009dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6004b6eb81636c73053841b32c371fa"><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html#ab6004b6eb81636c73053841b32c371fa">read</a> (float[] buffer, int numFrames)</td></tr>
<tr class="separator:ab6004b6eb81636c73053841b32c371fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab12ce694b065cb1729fff4815345b4a9"><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html#ab12ce694b065cb1729fff4815345b4a9">write</a> (float[] buffer, int numFrames)</td></tr>
<tr class="separator:ab12ce694b065cb1729fff4815345b4a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3817b1e550497d46eb20459d9a41dc03"><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html#a3817b1e550497d46eb20459d9a41dc03">read</a> (short[] buffer, int numFrames)</td></tr>
<tr class="separator:a3817b1e550497d46eb20459d9a41dc03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a7b50bb6f5f7cb1cb95748ec20ca874"><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html#a4a7b50bb6f5f7cb1cb95748ec20ca874">write</a> (short[] buffer, int numFrames)</td></tr>
<tr class="separator:a4a7b50bb6f5f7cb1cb95748ec20ca874"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8acbba9e18de0678780d1209548f9c8d"><td class="memItemLeft" align="right" valign="top">native void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html#a8acbba9e18de0678780d1209548f9c8d">start</a> ()</td></tr>
<tr class="separator:a8acbba9e18de0678780d1209548f9c8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a912f5332bc0c5f610ec94bf583a3e2d6"><td class="memItemLeft" align="right" valign="top">native void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html#a912f5332bc0c5f610ec94bf583a3e2d6">stop</a> ()</td></tr>
<tr class="separator:a912f5332bc0c5f610ec94bf583a3e2d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9897ea14063ab8e9cf01da7f0c71dcf3"><td class="memItemLeft" align="right" valign="top">native void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html#a9897ea14063ab8e9cf01da7f0c71dcf3">abort</a> ()</td></tr>
<tr class="separator:a9897ea14063ab8e9cf01da7f0c71dcf3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8aa21c90665dbd02b7578ec83aa7bc38"><td class="memItemLeft" align="right" valign="top">native void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html#a8aa21c90665dbd02b7578ec83aa7bc38">close</a> ()</td></tr>
<tr class="separator:a8aa21c90665dbd02b7578ec83aa7bc38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7302d39a2f9d2fc698f6bec0cc22abc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7302d39a2f9d2fc698f6bec0cc22abc"></a>
native boolean </td><td class="memItemRight" valign="bottom"><b>isStopped</b> ()</td></tr>
<tr class="separator:af7302d39a2f9d2fc698f6bec0cc22abc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe5907d29a3873b1ed0c5f53aa349d51"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe5907d29a3873b1ed0c5f53aa349d51"></a>
native boolean </td><td class="memItemRight" valign="bottom"><b>isActive</b> ()</td></tr>
<tr class="separator:abe5907d29a3873b1ed0c5f53aa349d51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ae8348af5928fd48cd6da8e1cef762e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ae8348af5928fd48cd6da8e1cef762e"></a>
String </td><td class="memItemRight" valign="bottom"><b>toString</b> ()</td></tr>
<tr class="separator:a2ae8348af5928fd48cd6da8e1cef762e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1768a144ac219d3ce7682ac8422d20f2"><td class="memItemLeft" align="right" valign="top">native double </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1portaudio_1_1BlockingStream.html#a1768a144ac219d3ce7682ac8422d20f2">getTime</a> ()</td></tr>
<tr class="separator:a1768a144ac219d3ce7682ac8422d20f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a760ca3c640acd287074bfa222b052270"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a760ca3c640acd287074bfa222b052270"></a>
<a class="el" href="classcom_1_1portaudio_1_1StreamInfo.html">StreamInfo</a> </td><td class="memItemRight" valign="bottom"><b>getInfo</b> ()</td></tr>
<tr class="separator:a760ca3c640acd287074bfa222b052270"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents a stream for blocking read/write I/O.</p>
<p>This Java object contains the pointer to a <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a> stream stored as a long. It is passed to <a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a> when calling stream related functions.</p>
<p>To create one of these, call PortAudio.openStream().</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classcom_1_1portaudio_1_1PortAudio.html">PortAudio</a></dd></dl>
<dl class="section author"><dt>Author</dt><dd>Phil Burk </dd></dl>
<p>Definition at line <a class="el" href="BlockingStream_8java_source.html#l00059">59</a> of file <a class="el" href="BlockingStream_8java_source.html">BlockingStream.java</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9897ea14063ab8e9cf01da7f0c71dcf3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">native void com.portaudio.BlockingStream.abort </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop immediately and lose any data that was written but not played. </p>
</div>
</div>
<a class="anchor" id="a8aa21c90665dbd02b7578ec83aa7bc38"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">native void com.portaudio.BlockingStream.close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the stream and zero out the pointer. Do not reference the stream after this. </p>
</div>
</div>
<a class="anchor" id="a4cb237d1596fcfb10adf7e21166bfd10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">native int com.portaudio.BlockingStream.getReadAvailable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>number of frames that can be read without blocking. </dd></dl>
</div>
</div>
<a class="anchor" id="a1768a144ac219d3ce7682ac8422d20f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">native double com.portaudio.BlockingStream.getTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get audio time related to this stream. Note that it may not start at 0.0. </p>
</div>
</div>
<a class="anchor" id="a24fcac3b87ee7f15cbf97c9f821009dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">native int com.portaudio.BlockingStream.getWriteAvailable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>number of frames that can be written without blocking. </dd></dl>
</div>
</div>
<a class="anchor" id="ab6004b6eb81636c73053841b32c371fa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boolean com.portaudio.BlockingStream.read </td>
<td>(</td>
<td class="paramtype">float[] </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numFrames</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read 32-bit floating point data from the stream into the array.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td></td></tr>
<tr><td class="paramname">numFrames</td><td>number of frames to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if an input overflow occurred </dd></dl>
<p>Definition at line <a class="el" href="BlockingStream_8java_source.html#l00093">93</a> of file <a class="el" href="BlockingStream_8java_source.html">BlockingStream.java</a>.</p>
<p>References <a class="el" href="PortAudio_8java_source.html#l00075">com.portaudio.PortAudio.FORMAT_FLOAT_32</a>.</p>
</div>
</div>
<a class="anchor" id="a3817b1e550497d46eb20459d9a41dc03"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boolean com.portaudio.BlockingStream.read </td>
<td>(</td>
<td class="paramtype">short[] </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numFrames</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read 16-bit integer data to the stream from the array.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td></td></tr>
<tr><td class="paramname">numFrames</td><td>number of frames to write </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if an input overflow occurred </dd></dl>
<p>Definition at line <a class="el" href="BlockingStream_8java_source.html#l00134">134</a> of file <a class="el" href="BlockingStream_8java_source.html">BlockingStream.java</a>.</p>
</div>
</div>
<a class="anchor" id="a8acbba9e18de0678780d1209548f9c8d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">native void com.portaudio.BlockingStream.start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Atart audio I/O. </p>
</div>
</div>
<a class="anchor" id="a912f5332bc0c5f610ec94bf583a3e2d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">native void com.portaudio.BlockingStream.stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait for the stream to play all of the data that has been written then stop. </p>
</div>
</div>
<a class="anchor" id="ab12ce694b065cb1729fff4815345b4a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boolean com.portaudio.BlockingStream.write </td>
<td>(</td>
<td class="paramtype">float[] </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numFrames</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write 32-bit floating point data to the stream from the array. The data should be in the range -1.0 to +1.0.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td></td></tr>
<tr><td class="paramname">numFrames</td><td>number of frames to write </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if an output underflow occurred </dd></dl>
<p>Definition at line <a class="el" href="BlockingStream_8java_source.html#l00112">112</a> of file <a class="el" href="BlockingStream_8java_source.html">BlockingStream.java</a>.</p>
<p>References <a class="el" href="PortAudio_8java_source.html#l00075">com.portaudio.PortAudio.FORMAT_FLOAT_32</a>.</p>
</div>
</div>
<a class="anchor" id="a4a7b50bb6f5f7cb1cb95748ec20ca874"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boolean com.portaudio.BlockingStream.write </td>
<td>(</td>
<td class="paramtype">short[] </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numFrames</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write 16-bit integer data to the stream from the array.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td></td></tr>
<tr><td class="paramname">numFrames</td><td>number of frames to write </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if an output underflow occurred </dd></dl>
<p>Definition at line <a class="el" href="BlockingStream_8java_source.html#l00152">152</a> of file <a class="el" href="BlockingStream_8java_source.html">BlockingStream.java</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="BlockingStream_8java_source.html">BlockingStream.java</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Feb 15 2014 23:28:26 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>
|