Release 4.0.12 tarball
[rtaudio.git] / doc / html / functions.html
index f360f94a18efb2c326535de5f01f1f3d25b989f2..020228ff86fef28b15b5d7a75f9a0a8c0c88cc95 100644 (file)
 <HTML>
 <HEAD>
-<TITLE>The RtAudio Tutorial</TITLE>
+<TITLE>The RtAudio Home Page</TITLE>
 <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
+<LINK REL="SHORTCUT ICON" HREF="http://www.music.mcgill.ca/~gary/favicon.ico">
 </HEAD>
 <BODY BGCOLOR="#FFFFFF">
 <CENTER>
-<a class="qindex" href="index.html">Tutorial</a> &nbsp; <a class="qindex" href="annotated.html">Class/Enum List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </CENTER>
+<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="annotated.html">Class/Enum List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </CENTER>
 <HR>
-<!-- Generated by Doxygen 1.3.4 -->
-<div class="qindex"><a class="qindexHL" href="functions.html">All</a> | <a class="qindex" href="functions_func.html">Functions</a> | <a class="qindex" href="functions_vars.html">Variables</a> | <a class="qindex" href="functions_enum.html">Enumerations</a> | <a class="qindex" href="functions_eval.html">Enumeration&nbsp;values</a></div>
-<div class="qindex"><a class="qindex" href="#index_a">a</a> | <a class="qindex" href="#index_c">c</a> | <a class="qindex" href="#index_d">d</a> | <a class="qindex" href="#index_g">g</a> | <a class="qindex" href="#index_i">i</a> | <a class="qindex" href="#index_l">l</a> | <a class="qindex" href="#index_m">m</a> | <a class="qindex" href="#index_n">n</a> | <a class="qindex" href="#index_o">o</a> | <a class="qindex" href="#index_p">p</a> | <a class="qindex" href="#index_r">r</a> | <a class="qindex" href="#index_s">s</a> | <a class="qindex" href="#index_t">t</a> | <a class="qindex" href="#index_u">u</a> | <a class="qindex" href="#index_w">w</a> | <a class="qindex" href="#index_~">~</a></div>
+<!-- Generated by Doxygen 1.8.2 -->
+</div><!-- top -->
+<div class="contents">
+<div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div>
 
-<p>
-
-<p>
-Here is a list of all documented class members with links to the class documentation for each member:<h3><a class="anchor" name="index_a">- a -</a></h3><ul>
+<h3><a class="anchor" id="index_a"></a>- a -</h3><ul>
 <li>abortStream()
-: <a class="el" href="classRtAudio.html#a13">RtAudio</a></ul>
-<h3><a class="anchor" name="index_c">- c -</a></h3><ul>
-<li>cancelStreamCallback()
-: <a class="el" href="classRtAudio.html#a5">RtAudio</a><li>closeStream()
-: <a class="el" href="classRtAudio.html#a10">RtAudio</a></ul>
-<h3><a class="anchor" name="index_d">- d -</a></h3><ul>
+: <a class="el" href="classRtAudio.html#ad0586b47cd6bb9591a80b4052815991f">RtAudio</a>
+</li>
+<li>Api
+: <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_c"></a>- c -</h3><ul>
+<li>closeStream()
+: <a class="el" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a">RtAudio</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_d"></a>- d -</h3><ul>
 <li>DEBUG_WARNING
-: <a class="el" href="classRtError.html#w11w1">RtError</a><li>DRIVER_ERROR
-: <a class="el" href="classRtError.html#w11w8">RtError</a><li>duplexChannels
-: <a class="el" href="structRtAudioDeviceInfo.html#o4">RtAudioDeviceInfo</a></ul>
-<h3><a class="anchor" name="index_g">- g -</a></h3><ul>
+: <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba">RtError</a>
+</li>
+<li>deviceId
+: <a class="el" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">RtAudio::StreamParameters</a>
+</li>
+<li>DRIVER_ERROR
+: <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b">RtError</a>
+</li>
+<li>duplexChannels
+: <a class="el" href="structRtAudio_1_1DeviceInfo.html#a3e8ad34c2d14e24293a0beafc26186e7">RtAudio::DeviceInfo</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_f"></a>- f -</h3><ul>
+<li>firstChannel
+: <a class="el" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">RtAudio::StreamParameters</a>
+</li>
+<li>flags
+: <a class="el" href="structRtAudio_1_1StreamOptions.html#a0ecc98b031aa3af49d09b781643e298b">RtAudio::StreamOptions</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_g"></a>- g -</h3><ul>
+<li>getCompiledApi()
+: <a class="el" href="classRtAudio.html#ae266ffad2ef428d0b2c6c262d391ce26">RtAudio</a>
+</li>
+<li>getCurrentApi()
+: <a class="el" href="classRtAudio.html#a83687634795792b2c47e4ae1cf8a5246">RtAudio</a>
+</li>
+<li>getDefaultInputDevice()
+: <a class="el" href="classRtAudio.html#aad8b94edd3cd379ee300b125750ac6ce">RtAudio</a>
+</li>
+<li>getDefaultOutputDevice()
+: <a class="el" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc">RtAudio</a>
+</li>
 <li>getDeviceCount()
-: <a class="el" href="classRtAudio.html#a6">RtAudio</a><li>getDeviceInfo()
-: <a class="el" href="classRtAudio.html#a7">RtAudio</a><li>getMessage()
-: <a class="el" href="classRtError.html#a4">RtError</a><li>getMessageString()
-: <a class="el" href="classRtError.html#a5">RtError</a><li>getStreamBuffer()
-: <a class="el" href="classRtAudio.html#a8">RtAudio</a><li>getType()
-: <a class="el" href="classRtError.html#a3">RtError</a></ul>
-<h3><a class="anchor" name="index_i">- i -</a></h3><ul>
+: <a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a">RtAudio</a>
+</li>
+<li>getDeviceInfo()
+: <a class="el" href="classRtAudio.html#a02d7ff44ad1d7eae22283a052f3dfda8">RtAudio</a>
+</li>
+<li>getMessage()
+: <a class="el" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50">RtError</a>
+</li>
+<li>getStreamLatency()
+: <a class="el" href="classRtAudio.html#a843c989d9f501c71bc2f2c5ca18df9f3">RtAudio</a>
+</li>
+<li>getStreamSampleRate()
+: <a class="el" href="classRtAudio.html#a28214b8b05d60b45c24ee6fae7b2a0b5">RtAudio</a>
+</li>
+<li>getStreamTime()
+: <a class="el" href="classRtAudio.html#a344e59a62353c5791db4621b985cb2ca">RtAudio</a>
+</li>
+<li>getType()
+: <a class="el" href="classRtError.html#a3e316dc9b9b41fe2f64cabf34beb4fe7">RtError</a>
+</li>
+<li>getVersion()
+: <a class="el" href="classRtAudio.html#afee36f6d32f4744ffa7471a0ce7a3856">RtAudio</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_i"></a>- i -</h3><ul>
 <li>inputChannels
-: <a class="el" href="structRtAudioDeviceInfo.html#o3">RtAudioDeviceInfo</a><li>INVALID_DEVICE
-: <a class="el" href="classRtError.html#w11w4">RtError</a><li>INVALID_PARAMETER
-: <a class="el" href="classRtError.html#w11w7">RtError</a><li>INVALID_STREAM
-: <a class="el" href="classRtError.html#w11w5">RtError</a><li>IRIX_AL
-: <a class="el" href="classRtAudio.html#w8w5">RtAudio</a><li>isDefault
-: <a class="el" href="structRtAudioDeviceInfo.html#o5">RtAudioDeviceInfo</a></ul>
-<h3><a class="anchor" name="index_l">- l -</a></h3><ul>
+: <a class="el" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">RtAudio::DeviceInfo</a>
+</li>
+<li>INVALID_DEVICE
+: <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1">RtError</a>
+</li>
+<li>INVALID_PARAMETER
+: <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6">RtError</a>
+</li>
+<li>INVALID_USE
+: <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc">RtError</a>
+</li>
+<li>isDefaultInput
+: <a class="el" href="structRtAudio_1_1DeviceInfo.html#a7c8aca084bd908799b6be5954b80def2">RtAudio::DeviceInfo</a>
+</li>
+<li>isDefaultOutput
+: <a class="el" href="structRtAudio_1_1DeviceInfo.html#a5365245e73ffe29a05734de4474acd58">RtAudio::DeviceInfo</a>
+</li>
+<li>isStreamOpen()
+: <a class="el" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f">RtAudio</a>
+</li>
+<li>isStreamRunning()
+: <a class="el" href="classRtAudio.html#a84cc8d9b7ab9bc5f37bcf48430ec5aea">RtAudio</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_l"></a>- l -</h3><ul>
 <li>LINUX_ALSA
-: <a class="el" href="classRtAudio.html#w8w1">RtAudio</a><li>LINUX_JACK
-: <a class="el" href="classRtAudio.html#w8w3">RtAudio</a><li>LINUX_OSS
-: <a class="el" href="classRtAudio.html#w8w2">RtAudio</a></ul>
-<h3><a class="anchor" name="index_m">- m -</a></h3><ul>
+: <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa7a2ba095c2806caa893b6fb8fc3a1a8">RtAudio</a>
+</li>
+<li>LINUX_OSS
+: <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a39c84615e61de75e6a4e865596d62c82">RtAudio</a>
+</li>
+<li>LINUX_PULSE
+: <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849adc17dff310e85d303fb326c837c08d77">RtAudio</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_m"></a>- m -</h3><ul>
 <li>MACOSX_CORE
-: <a class="el" href="classRtAudio.html#w8w4">RtAudio</a><li>MEMORY_ERROR
-: <a class="el" href="classRtError.html#w11w6">RtError</a></ul>
-<h3><a class="anchor" name="index_n">- n -</a></h3><ul>
+: <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a9fec92b8272244a87a6a11a717bd662d">RtAudio</a>
+</li>
+<li>MEMORY_ERROR
+: <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e">RtError</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_n"></a>- n -</h3><ul>
 <li>name
-: <a class="el" href="structRtAudioDeviceInfo.html#o0">RtAudioDeviceInfo</a><li>nativeFormats
-: <a class="el" href="structRtAudioDeviceInfo.html#o7">RtAudioDeviceInfo</a><li>NO_DEVICES_FOUND
-: <a class="el" href="classRtError.html#w11w3">RtError</a></ul>
-<h3><a class="anchor" name="index_o">- o -</a></h3><ul>
+: <a class="el" href="structRtAudio_1_1DeviceInfo.html#a24df596ab8d54f2eb540c7cf16212b3b">RtAudio::DeviceInfo</a>
+</li>
+<li>nativeFormats
+: <a class="el" href="structRtAudio_1_1DeviceInfo.html#a23251b549b89b2fe04a57fcd7cb76ea4">RtAudio::DeviceInfo</a>
+</li>
+<li>nChannels
+: <a class="el" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">RtAudio::StreamParameters</a>
+</li>
+<li>NO_DEVICES_FOUND
+: <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82">RtError</a>
+</li>
+<li>numberOfBuffers
+: <a class="el" href="structRtAudio_1_1StreamOptions.html#a75a14cfab903d0e1c091bc16aec80240">RtAudio::StreamOptions</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_o"></a>- o -</h3><ul>
 <li>openStream()
-: <a class="el" href="classRtAudio.html#a3">RtAudio</a><li>outputChannels
-: <a class="el" href="structRtAudioDeviceInfo.html#o2">RtAudioDeviceInfo</a></ul>
-<h3><a class="anchor" name="index_p">- p -</a></h3><ul>
+: <a class="el" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b">RtAudio</a>
+</li>
+<li>outputChannels
+: <a class="el" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">RtAudio::DeviceInfo</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_p"></a>- p -</h3><ul>
 <li>printMessage()
-: <a class="el" href="classRtError.html#a2">RtError</a><li>probed
-: <a class="el" href="structRtAudioDeviceInfo.html#o1">RtAudioDeviceInfo</a></ul>
-<h3><a class="anchor" name="index_r">- r -</a></h3><ul>
+: <a class="el" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc">RtError</a>
+</li>
+<li>priority
+: <a class="el" href="structRtAudio_1_1StreamOptions.html#adfd267059434edb21573c584e6367def">RtAudio::StreamOptions</a>
+</li>
+<li>probed
+: <a class="el" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">RtAudio::DeviceInfo</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_r"></a>- r -</h3><ul>
 <li>RtAudio()
-: <a class="el" href="classRtAudio.html#a1">RtAudio</a><li>RtAudioApi
-: <a class="el" href="classRtAudio.html#w8">RtAudio</a><li>RtError()
-: <a class="el" href="classRtError.html#a0">RtError</a></ul>
-<h3><a class="anchor" name="index_s">- s -</a></h3><ul>
+: <a class="el" href="classRtAudio.html#afd0bfa26deae9804e18faff59d0273d9">RtAudio</a>
+</li>
+<li>RTAUDIO_DUMMY
+: <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849ab06b8fd88bf18c9a2b8271f6961ae2d1">RtAudio</a>
+</li>
+<li>RtError()
+: <a class="el" href="classRtError.html#aa479a305ccbe56be0fd9137b9b405a37">RtError</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_s"></a>- s -</h3><ul>
 <li>sampleRates
-: <a class="el" href="structRtAudioDeviceInfo.html#o6">RtAudioDeviceInfo</a><li>setStreamCallback()
-: <a class="el" href="classRtAudio.html#a4">RtAudio</a><li>startStream()
-: <a class="el" href="classRtAudio.html#a11">RtAudio</a><li>stopStream()
-: <a class="el" href="classRtAudio.html#a12">RtAudio</a><li>SYSTEM_ERROR
-: <a class="el" href="classRtError.html#w11w9">RtError</a></ul>
-<h3><a class="anchor" name="index_t">- t -</a></h3><ul>
+: <a class="el" href="structRtAudio_1_1DeviceInfo.html#afa65f5f92f66ce7aacd3ff35e11b230f">RtAudio::DeviceInfo</a>
+</li>
+<li>showWarnings()
+: <a class="el" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77">RtAudio</a>
+</li>
+<li>startStream()
+: <a class="el" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80">RtAudio</a>
+</li>
+<li>stopStream()
+: <a class="el" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd">RtAudio</a>
+</li>
+<li>streamName
+: <a class="el" href="structRtAudio_1_1StreamOptions.html#a2a4b0b8d690c624d20f4e8f4be6ca9ba">RtAudio::StreamOptions</a>
+</li>
+<li>SYSTEM_ERROR
+: <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b">RtError</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_t"></a>- t -</h3><ul>
 <li>THREAD_ERROR
-: <a class="el" href="classRtError.html#w11w10">RtError</a><li>tickStream()
-: <a class="el" href="classRtAudio.html#a9">RtAudio</a><li>Type
-: <a class="el" href="classRtError.html#w11">RtError</a></ul>
-<h3><a class="anchor" name="index_u">- u -</a></h3><ul>
+: <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6">RtError</a>
+</li>
+<li>Type
+: <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">RtError</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_u"></a>- u -</h3><ul>
+<li>UNIX_JACK
+: <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a4767e17c6edfbd827f91763915df4105">RtAudio</a>
+</li>
 <li>UNSPECIFIED
-: <a class="el" href="classRtError.html#w11w2">RtError</a>, <a class="el" href="classRtAudio.html#w8w0">RtAudio</a></ul>
-<h3><a class="anchor" name="index_w">- w -</a></h3><ul>
+: <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6">RtError</a>
+, <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae">RtAudio</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_w"></a>- w -</h3><ul>
 <li>WARNING
-: <a class="el" href="classRtError.html#w11w0">RtError</a><li>WINDOWS_ASIO
-: <a class="el" href="classRtAudio.html#w8w6">RtAudio</a><li>WINDOWS_DS
-: <a class="el" href="classRtAudio.html#w8w7">RtAudio</a></ul>
-<h3><a class="anchor" name="index_~">- ~ -</a></h3><ul>
+: <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398">RtError</a>
+</li>
+<li>what()
+: <a class="el" href="classRtError.html#aeb843b7a7785d66061c61ebfc29e7e9d">RtError</a>
+</li>
+<li>WINDOWS_ASIO
+: <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a219517d1df90f94d07758481155bd469">RtAudio</a>
+</li>
+<li>WINDOWS_DS
+: <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931">RtAudio</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_0x7e"></a>- ~ -</h3><ul>
 <li>~RtAudio()
-: <a class="el" href="classRtAudio.html#a2">RtAudio</a><li>~RtError()
-: <a class="el" href="classRtError.html#a1">RtError</a></ul>
+: <a class="el" href="classRtAudio.html#aa8a9716fd64680657ef69c9465442a2f">RtAudio</a>
+</li>
+<li>~RtError()
+: <a class="el" href="classRtError.html#a6793e03386e7e69ffafb65a296dfa48c">RtError</a>
+</li>
+</ul>
+</div><!-- contents -->
 <HR>
-
 <table><tr><td><img src="../images/mcgill.gif" width=165></td>
-  <td>&copy;2001-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br>
-  Maintained by Gary P. Scavone, <a href="mailto:gary@music.mcgill.ca">gary@music.mcgill.ca</a></td></tr>
+  <td>&copy;2001-2013 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr>
 </table>
-
 </BODY>
 </HTML>