falkTX
/
rtaudio
mirror of https://github.com/falkTX/rtaudio
1
0
Fork 0
Code Releases 27 Activity
Browse Source

Release 2.0 tarball

tags/2.0
Gary Scavone Stephen Sinclair 11 years ago
parent
72ee1e6be2
commit
cdfd5a2d8e
33 changed files with 6494 additions and 0 deletions
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +295
    -0
      doc/html/RtAudio_8h-source.html
  2. +56
    -0
      doc/html/RtAudio_8h.html
  3. +24
    -0
      doc/html/annotated.html
  4. +45
    -0
      doc/html/classRtAudio-members.html
  5. +918
    -0
      doc/html/classRtAudio.html
  6. +40
    -0
      doc/html/classRtAudioError-members.html
  7. +337
    -0
      doc/html/classRtAudioError.html
  8. +20
    -0
      doc/html/doxygen.css
  9. BIN
      doc/html/doxygen.gif
  10. +21
    -0
      doc/html/files.html
  11. +129
    -0
      doc/html/functions.html
  12. +27
    -0
      doc/html/globals.html
  13. +583
    -0
      doc/html/index.html
  14. +34
    -0
      doc/html/structRtAudio_1_1RTAUDIO__DEVICE-members.html
  15. +378
    -0
      doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html
  16. +21
    -0
      doc/html/tutorial_8txt.html
  17. +31
    -0
      doc/latex/Makefile
  18. +29
    -0
      doc/latex/RtAudio_8h.tex
  19. +6
    -0
      doc/latex/annotated.tex
  20. +254
    -0
      doc/latex/classRtAudio.tex
  21. +135
    -0
      doc/latex/classRtAudioError.tex
  22. +65
    -0
      doc/latex/doxygen.sty
  23. +4
    -0
      doc/latex/files.tex
  24. +595
    -0
      doc/latex/index.tex
  25. +42
    -0
      doc/latex/refman.tex
  26. +106
    -0
      doc/latex/structRtAudio_1_1RTAUDIO__DEVICE.tex
  27. +2
    -0
      doc/latex/tutorial_8txt.tex
  28. +254
    -0
      doc/man/man3/RtAudio.3
  29. +45
    -0
      doc/man/man3/RtAudio.h.3
  30. +115
    -0
      doc/man/man3/RtAudioError.3
  31. +91
    -0
      doc/man/man3/RtAudio_RTAUDIO_DEVICE.3
  32. +11
    -0
      doc/man/man3/tutorial.txt.3
  33. +1781
    -0
      doc/rtf/refman.rtf

+ 295
- 0
doc/html/RtAudio_8h-source.html View File

@@ -0,0 +1,295 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>RtAudio.h</h1><a href="RtAudio_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">/******************************************/</font>
00002 <font class="comment">/*</font>
00003 <font class="comment"> RtAudio - realtime sound I/O C++ class</font>
00004 <font class="comment"> Version 2.0 by Gary P. Scavone, 2001-2002.</font>
00005 <font class="comment">*/</font>
00006 <font class="comment">/******************************************/</font>
00007
00008 <font class="preprocessor">#if !defined(__RtAudio_h)</font>
<a name="l00009"></a><a class="code" href="RtAudio_8h.html#a0">00009</a> <font class="preprocessor"></font><font class="preprocessor">#define __RtAudio_h</font>
00010 <font class="preprocessor"></font>
00011 <font class="preprocessor">#include &lt;map&gt;</font>
00012
00013 <font class="preprocessor">#if defined(__LINUX_ALSA_)</font>
00014 <font class="preprocessor"></font><font class="preprocessor"> #include &lt;alsa/asoundlib.h&gt;</font>
00015 <font class="preprocessor"> #include &lt;pthread.h&gt;</font>
00016 <font class="preprocessor"> #include &lt;unistd.h&gt;</font>
00017
00018 <font class="keyword">typedef</font> snd_pcm_t *AUDIO_HANDLE;
00019 <font class="keyword">typedef</font> <font class="keywordtype">int</font> DEVICE_ID;
00020 <font class="keyword">typedef</font> pthread_t THREAD_HANDLE;
00021 <font class="keyword">typedef</font> pthread_mutex_t MUTEX;
00022
00023 <font class="preprocessor">#elif defined(__LINUX_OSS_)</font>
00024 <font class="preprocessor"></font><font class="preprocessor"> #include &lt;pthread.h&gt;</font>
00025 <font class="preprocessor"> #include &lt;unistd.h&gt;</font>
00026
00027 <font class="keyword">typedef</font> <font class="keywordtype">int</font> AUDIO_HANDLE;
00028 <font class="keyword">typedef</font> <font class="keywordtype">int</font> DEVICE_ID;
00029 <font class="keyword">typedef</font> pthread_t THREAD_HANDLE;
00030 <font class="keyword">typedef</font> pthread_mutex_t MUTEX;
00031
00032 <font class="preprocessor">#elif defined(__WINDOWS_DS_)</font>
00033 <font class="preprocessor"></font><font class="preprocessor"> #include &lt;windows.h&gt;</font>
00034 <font class="preprocessor"> #include &lt;process.h&gt;</font>
00035
00036 <font class="comment">// The following struct is used to hold the extra variables</font>
00037 <font class="comment">// specific to the DirectSound implementation.</font>
00038 <font class="keyword">typedef</font> <font class="keyword">struct </font>{
00039 <font class="keywordtype">void</font> * object;
00040 <font class="keywordtype">void</font> * buffer;
00041 UINT bufferPointer;
00042 } AUDIO_HANDLE;
00043
00044 <font class="keyword">typedef</font> LPGUID DEVICE_ID;
00045 <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> THREAD_HANDLE;
00046 <font class="keyword">typedef</font> CRITICAL_SECTION MUTEX;
00047
00048 <font class="preprocessor">#elif defined(__IRIX_AL_)</font>
00049 <font class="preprocessor"></font><font class="preprocessor"> #include &lt;dmedia/audio.h&gt;</font>
00050 <font class="preprocessor"> #include &lt;pthread.h&gt;</font>
00051 <font class="preprocessor"> #include &lt;unistd.h&gt;</font>
00052
00053 <font class="keyword">typedef</font> ALport AUDIO_HANDLE;
00054 <font class="keyword">typedef</font> <font class="keywordtype">int</font> DEVICE_ID;
00055 <font class="keyword">typedef</font> pthread_t THREAD_HANDLE;
00056 <font class="keyword">typedef</font> pthread_mutex_t MUTEX;
00057
00058 <font class="preprocessor">#endif</font>
00059 <font class="preprocessor"></font>
00060
00061 <font class="comment">// *************************************************** //</font>
00062 <font class="comment">//</font>
00063 <font class="comment">// RtAudioError class declaration.</font>
00064 <font class="comment">//</font>
00065 <font class="comment">// *************************************************** //</font>
00066
<a name="l00067"></a><a class="code" href="classRtAudioError.html">00067</a> <font class="keyword">class </font><a class="code" href="classRtAudioError.html">RtAudioError</a>
00068 {
00069 <font class="keyword">public</font>:
<a name="l00070"></a><a class="code" href="classRtAudioError.html#s11">00070</a> <font class="keyword">enum</font> TYPE {
00071 WARNING,
00072 DEBUG_WARNING,
00073 UNSPECIFIED,
00074 NO_DEVICES_FOUND,
00075 INVALID_DEVICE,
00076 INVALID_STREAM,
00077 MEMORY_ERROR,
00078 INVALID_PARAMETER,
00079 DRIVER_ERROR,
00080 SYSTEM_ERROR,
00081 THREAD_ERROR
00082 };
00083
00084 <font class="keyword">protected</font>:
<a name="l00085"></a><a class="code" href="classRtAudioError.html#n0">00085</a> <font class="keywordtype">char</font> error_message[256];
<a name="l00086"></a><a class="code" href="classRtAudioError.html#n1">00086</a> TYPE type;
00087
00088 <font class="keyword">public</font>:
00090 <a class="code" href="classRtAudioError.html#a0">RtAudioError</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *p, TYPE tipe = RtAudioError::UNSPECIFIED);
00091
00093 <font class="keyword">virtual</font> <a class="code" href="classRtAudioError.html#a1">~RtAudioError</a>(<font class="keywordtype">void</font>);
00094
00096 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classRtAudioError.html#a2">printMessage</a>(<font class="keywordtype">void</font>);
00097
<a name="l00099"></a><a class="code" href="classRtAudioError.html#a3">00099</a> <font class="keyword">virtual</font> <font class="keyword">const</font> TYPE&amp; <a class="code" href="classRtAudioError.html#a3">getType</a>(<font class="keywordtype">void</font>)<font class="keyword"> </font>{ <font class="keywordflow">return</font> type; }
00100
<a name="l00102"></a><a class="code" href="classRtAudioError.html#a4">00102</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="classRtAudioError.html#a4">getMessage</a>(<font class="keywordtype">void</font>)<font class="keyword"> </font>{ <font class="keywordflow">return</font> error_message; }
00103 };
00104
00105
00106 <font class="comment">// *************************************************** //</font>
00107 <font class="comment">//</font>
00108 <font class="comment">// RtAudio class declaration.</font>
00109 <font class="comment">//</font>
00110 <font class="comment">// *************************************************** //</font>
00111
<a name="l00112"></a><a class="code" href="classRtAudio.html">00112</a> <font class="keyword">class </font><a class="code" href="classRtAudio.html">RtAudio</a>
00113 {
00114 <font class="keyword">public</font>:
00115
00116 <font class="comment">// Support for signed integers and floats. Audio data fed to/from</font>
00117 <font class="comment">// the tickStream() routine is assumed to ALWAYS be in host</font>
00118 <font class="comment">// byte order. The internal routines will automatically take care of</font>
00119 <font class="comment">// any necessary byte-swapping between the host format and the</font>
00120 <font class="comment">// soundcard. Thus, endian-ness is not a concern in the following</font>
00121 <font class="comment">// format definitions.</font>
<a name="l00122"></a><a class="code" href="classRtAudio.html#s0">00122</a> <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> RTAUDIO_FORMAT;
<a name="l00123"></a><a class="code" href="classRtAudio.html#p0">00123</a> <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT8;
<a name="l00124"></a><a class="code" href="classRtAudio.html#p1">00124</a> <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT16;
<a name="l00125"></a><a class="code" href="classRtAudio.html#p2">00125</a> <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT24;
<a name="l00126"></a><a class="code" href="classRtAudio.html#p3">00126</a> <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT32;
<a name="l00127"></a><a class="code" href="classRtAudio.html#p4">00127</a> <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_FLOAT32;
<a name="l00128"></a><a class="code" href="classRtAudio.html#p5">00128</a> <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_FLOAT64;
00130 <font class="comment">//static const int MAX_SAMPLE_RATES = 14;</font>
00131 <font class="keyword">enum</font> { MAX_SAMPLE_RATES = 14 };
00132
00133 <font class="keyword">typedef</font> int (*RTAUDIO_CALLBACK)(<font class="keywordtype">char</font> *buffer, <font class="keywordtype">int</font> bufferSize, <font class="keywordtype">void</font> *userData);
00134
<a name="l00135"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html">00135</a> <font class="keyword">typedef</font> <font class="keyword">struct </font>{
<a name="l00136"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m0">00136</a> <font class="keywordtype">char</font> name[128];
<a name="l00137"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m1">00137</a> DEVICE_ID id[2];
<a name="l00138"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m2">00138</a> <font class="keywordtype">bool</font> probed;
<a name="l00139"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m3">00139</a> <font class="keywordtype">int</font> maxOutputChannels;
<a name="l00140"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m4">00140</a> <font class="keywordtype">int</font> maxInputChannels;
<a name="l00141"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m5">00141</a> <font class="keywordtype">int</font> maxDuplexChannels;
<a name="l00142"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m6">00142</a> <font class="keywordtype">int</font> minOutputChannels;
<a name="l00143"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m7">00143</a> <font class="keywordtype">int</font> minInputChannels;
<a name="l00144"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m8">00144</a> <font class="keywordtype">int</font> minDuplexChannels;
<a name="l00145"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m9">00145</a> <font class="keywordtype">bool</font> hasDuplexSupport;
<a name="l00146"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m10">00146</a> <font class="keywordtype">int</font> nSampleRates;
<a name="l00147"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m11">00147</a> <font class="keywordtype">int</font> sampleRates[MAX_SAMPLE_RATES];
<a name="l00148"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m12">00148</a> RTAUDIO_FORMAT nativeFormats;
00149 } RTAUDIO_DEVICE;
00150
00152
00159 <a class="code" href="classRtAudio.html#a0">RtAudio</a>();
00160
00162
00173 <a class="code" href="classRtAudio.html#a0">RtAudio</a>(<font class="keywordtype">int</font> *streamID,
00174 <font class="keywordtype">int</font> outputDevice, <font class="keywordtype">int</font> outputChannels,
00175 <font class="keywordtype">int</font> inputDevice, <font class="keywordtype">int</font> inputChannels,
00176 RTAUDIO_FORMAT format, <font class="keywordtype">int</font> sampleRate,
00177 <font class="keywordtype">int</font> *bufferSize, <font class="keywordtype">int</font> numberOfBuffers);
00178
00180
00184 <a class="code" href="classRtAudio.html#a2">~RtAudio</a>();
00185
00187
00214 <font class="keywordtype">int</font> <a class="code" href="classRtAudio.html#a3">openStream</a>(<font class="keywordtype">int</font> outputDevice, <font class="keywordtype">int</font> outputChannels,
00215 <font class="keywordtype">int</font> inputDevice, <font class="keywordtype">int</font> inputChannels,
00216 RTAUDIO_FORMAT format, <font class="keywordtype">int</font> sampleRate,
00217 <font class="keywordtype">int</font> *bufferSize, <font class="keywordtype">int</font> numberOfBuffers);
00218
00220
00239 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a4">setStreamCallback</a>(<font class="keywordtype">int</font> streamID, RTAUDIO_CALLBACK callback, <font class="keywordtype">void</font> *userData);
00240
00242
00249 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a5">cancelStreamCallback</a>(<font class="keywordtype">int</font> streamID);
00250
00252 <font class="keywordtype">int</font> <a class="code" href="classRtAudio.html#a6">getDeviceCount</a>(<font class="keywordtype">void</font>);
00253
00255
00265 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a7">getDeviceInfo</a>(<font class="keywordtype">int</font> device, RTAUDIO_DEVICE *info);
00266
00268
00273 <font class="keywordtype">char</font> * <font class="keyword">const</font> <a class="code" href="classRtAudio.html#a8">getStreamBuffer</a>(<font class="keywordtype">int</font> streamID);
00274
00276
00281 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a9">tickStream</a>(<font class="keywordtype">int</font> streamID);
00282
00284
00288 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a10">closeStream</a>(<font class="keywordtype">int</font> streamID);
00289
00291
00295 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a11">startStream</a>(<font class="keywordtype">int</font> streamID);
00296
00298
00302 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a12">stopStream</a>(<font class="keywordtype">int</font> streamID);
00303
00305
00309 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a13">abortStream</a>(<font class="keywordtype">int</font> streamID);
00310
00312
00317 <font class="keywordtype">int</font> <a class="code" href="classRtAudio.html#a14">streamWillBlock</a>(<font class="keywordtype">int</font> streamID);
00318
00319 <font class="keyword">protected</font>:
00320
00321 <font class="keyword">private</font>:
00322
00323 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> SAMPLE_RATES[MAX_SAMPLE_RATES];
00324
00325 <font class="keyword">enum</font> { FAILURE, SUCCESS };
00326
00327 <font class="keyword">enum</font> STREAM_MODE {
00328 PLAYBACK,
00329 RECORD,
00330 DUPLEX,
00331 UNINITIALIZED = -75
00332 };
00333
00334 <font class="keyword">enum</font> STREAM_STATE {
00335 STREAM_STOPPED,
00336 STREAM_RUNNING
00337 };
00338
00339 <font class="keyword">typedef</font> <font class="keyword">struct </font>{
00340 <font class="keywordtype">int</font> device[2]; <font class="comment">// Playback and record, respectively.</font>
00341 STREAM_MODE mode; <font class="comment">// PLAYBACK, RECORD, or DUPLEX.</font>
00342 AUDIO_HANDLE handle[2]; <font class="comment">// Playback and record handles, respectively.</font>
00343 STREAM_STATE state; <font class="comment">// STOPPED or RUNNING</font>
00344 <font class="keywordtype">char</font> *userBuffer;
00345 <font class="keywordtype">char</font> *deviceBuffer;
00346 <font class="keywordtype">bool</font> doConvertBuffer[2]; <font class="comment">// Playback and record, respectively.</font>
00347 <font class="keywordtype">bool</font> deInterleave[2]; <font class="comment">// Playback and record, respectively.</font>
00348 <font class="keywordtype">bool</font> doByteSwap[2]; <font class="comment">// Playback and record, respectively.</font>
00349 <font class="keywordtype">int</font> sampleRate;
00350 <font class="keywordtype">int</font> bufferSize;
00351 <font class="keywordtype">int</font> nBuffers;
00352 <font class="keywordtype">int</font> nUserChannels[2]; <font class="comment">// Playback and record, respectively.</font>
00353 <font class="keywordtype">int</font> nDeviceChannels[2]; <font class="comment">// Playback and record channels, respectively.</font>
00354 RTAUDIO_FORMAT userFormat;
00355 RTAUDIO_FORMAT deviceFormat[2]; <font class="comment">// Playback and record, respectively.</font>
00356 <font class="keywordtype">bool</font> usingCallback;
00357 THREAD_HANDLE thread;
00358 MUTEX mutex;
00359 RTAUDIO_CALLBACK callback;
00360 <font class="keywordtype">void</font> *userData;
00361 } RTAUDIO_STREAM;
00362
00363 <font class="keyword">typedef</font> <font class="keywordtype">signed</font> <font class="keywordtype">short</font> INT16;
00364 <font class="keyword">typedef</font> <font class="keywordtype">signed</font> <font class="keywordtype">int</font> INT32;
00365 <font class="keyword">typedef</font> <font class="keywordtype">float</font> FLOAT32;
00366 <font class="keyword">typedef</font> <font class="keywordtype">double</font> FLOAT64;
00367
00368 <font class="keywordtype">char</font> message[256];
00369 <font class="keywordtype">int</font> nDevices;
00370 RTAUDIO_DEVICE *devices;
00371
00372 std::map&lt;int, void *&gt; streams;
00373
00375 <font class="keywordtype">void</font> error(RtAudioError::TYPE type);
00376
00381 <font class="keywordtype">void</font> initialize(<font class="keywordtype">void</font>);
00382
00384 <font class="keywordtype">void</font> clearDeviceInfo(RTAUDIO_DEVICE *info);
00385
00393 <font class="keywordtype">void</font> probeDeviceInfo(RTAUDIO_DEVICE *info);
00394
00401 <font class="keywordtype">bool</font> probeDeviceOpen(<font class="keywordtype">int</font> device, RTAUDIO_STREAM *stream,
00402 STREAM_MODE mode, <font class="keywordtype">int</font> channels,
00403 <font class="keywordtype">int</font> sampleRate, RTAUDIO_FORMAT format,
00404 <font class="keywordtype">int</font> *bufferSize, <font class="keywordtype">int</font> numberOfBuffers);
00405
00412 <font class="keywordtype">void</font> *verifyStream(<font class="keywordtype">int</font> streamID);
00413
00418 <font class="keywordtype">void</font> convertStreamBuffer(RTAUDIO_STREAM *stream, STREAM_MODE mode);
00419
00421 <font class="keywordtype">void</font> byteSwapBuffer(<font class="keywordtype">char</font> *buffer, <font class="keywordtype">int</font> samples, RTAUDIO_FORMAT format);
00422
00424 <font class="keywordtype">int</font> formatBytes(RTAUDIO_FORMAT format);
00425 };
00426
00427 <font class="comment">// Uncomment the following definition to have extra information spewed to stderr.</font>
00428 <font class="comment">//#define RTAUDIO_DEBUG</font>
00429
00430 <font class="preprocessor">#endif</font>
</font></pre></div><HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 56
- 0
doc/html/RtAudio_8h.html View File

@@ -0,0 +1,56 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>RtAudio.h File Reference</h1><code>#include &lt;map&gt;</code><br>

<p>
<a href="RtAudio_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html">RtAudioError</a></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html">RtAudio</a></td></tr>
<tr><td nowrap align=right valign=top>struct &nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RtAudio::RTAUDIO_DEVICE</a></td></tr>
<tr><td nowrap align=right valign=top>struct &nbsp;</td><td valign=bottom><b>RtAudio::RTAUDIO_STREAM</b></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="RtAudio_8h.html#a0">__RtAudio_h</a></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a name="a0" doxytag="RtAudio.h::__RtAudio_h"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define __RtAudio_h
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
<b>Value:</b><div class="fragment"><pre>
</pre></div> </td>
</tr>
</table>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 24
- 0
doc/html/annotated.html View File

@@ -0,0 +1,24 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>RtAudio Compound List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<ul>
<li><a class="el" href="classRtAudio.html">RtAudio</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RtAudio::RTAUDIO_DEVICE</a>
<li><a class="el" href="classRtAudioError.html">RtAudioError</a>
</ul>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 45
- 0
doc/html/classRtAudio-members.html View File

@@ -0,0 +1,45 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>RtAudio Member List</h1>This is the complete list of members for <a class="el" href="classRtAudio.html">RtAudio</a>, including all inherited members.<ul>
<li><a class="el" href="classRtAudio.html#a13">abortStream</a>(int streamID)
<li><a class="el" href="classRtAudio.html#a5">cancelStreamCallback</a>(int streamID)
<li><a class="el" href="classRtAudio.html#a10">closeStream</a>(int streamID)
<li><a class="el" href="classRtAudio.html#a6">getDeviceCount</a>(void)
<li><a class="el" href="classRtAudio.html#a7">getDeviceInfo</a>(int device, RTAUDIO_DEVICE *info)
<li><a class="el" href="classRtAudio.html#a8">getStreamBuffer</a>(int streamID)
<li><a class="el" href="classRtAudio.html#s3s2">MAX_SAMPLE_RATES</a> enum value
<li><a class="el" href="classRtAudio.html#a3">openStream</a>(int outputDevice, int outputChannels, int inputDevice, int inputChannels, RTAUDIO_FORMAT format, int sampleRate, int *bufferSize, int numberOfBuffers)
<li><a class="el" href="classRtAudio.html#a0">RtAudio</a>()
<li><a class="el" href="classRtAudio.html#a1">RtAudio</a>(int *streamID, int outputDevice, int outputChannels, int inputDevice, int inputChannels, RTAUDIO_FORMAT format, int sampleRate, int *bufferSize, int numberOfBuffers)
<li><a class="el" href="classRtAudio.html#s1">RTAUDIO_CALLBACK</a> typedef
<li><a class="el" href="classRtAudio.html#p4">RTAUDIO_FLOAT32</a>
<code> [static]</code><li><a class="el" href="classRtAudio.html#p5">RTAUDIO_FLOAT64</a>
<code> [static]</code><li><a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> typedef
<li><a class="el" href="classRtAudio.html#p1">RTAUDIO_SINT16</a>
<code> [static]</code><li><a class="el" href="classRtAudio.html#p2">RTAUDIO_SINT24</a>
<code> [static]</code><li><a class="el" href="classRtAudio.html#p3">RTAUDIO_SINT32</a>
<code> [static]</code><li><a class="el" href="classRtAudio.html#p0">RTAUDIO_SINT8</a>
<code> [static]</code><li><a class="el" href="classRtAudio.html#a4">setStreamCallback</a>(int streamID, RTAUDIO_CALLBACK callback, void *userData)
<li><a class="el" href="classRtAudio.html#a11">startStream</a>(int streamID)
<li><a class="el" href="classRtAudio.html#a12">stopStream</a>(int streamID)
<li><a class="el" href="classRtAudio.html#a14">streamWillBlock</a>(int streamID)
<li><a class="el" href="classRtAudio.html#a9">tickStream</a>(int streamID)
<li><a class="el" href="classRtAudio.html#a2">~RtAudio</a>()
</ul>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 918
- 0
doc/html/classRtAudio.html View File

@@ -0,0 +1,918 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>RtAudio Class Reference</h1><code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>&gt;</code>
<p>
<a href="classRtAudio-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef unsigned long&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a></td></tr>
<tr><td nowrap align=right valign=top>typedef int (*&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#s1">RTAUDIO_CALLBACK</a> )(char *buffer, int bufferSize, void *userData)</td></tr>
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom>{ <a class="el" href="classRtAudio.html#s3s2">MAX_SAMPLE_RATES</a> = 14
}</td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a0">RtAudio</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The default constructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a1">RtAudio</a> (int *streamID, int outputDevice, int outputChannels, int inputDevice, int inputChannels, <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> format, int sampleRate, int *bufferSize, int numberOfBuffers)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>A constructor which can be used to open a stream during instantiation.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a2">~RtAudio</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The destructor.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a3">openStream</a> (int outputDevice, int outputChannels, int inputDevice, int inputChannels, <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> format, int sampleRate, int *bufferSize, int numberOfBuffers)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>A public method for opening a stream with the specified parameters.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a4">setStreamCallback</a> (int streamID, <a class="el" href="classRtAudio.html#s1">RTAUDIO_CALLBACK</a> callback, void *userData)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>A public method which sets a user-defined callback function for a given stream.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a5">cancelStreamCallback</a> (int streamID)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>A public method which cancels a callback process and function for a given stream.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a6">getDeviceCount</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>A public method which returns the number of audio devices found.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a7">getDeviceInfo</a> (int device, <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RTAUDIO_DEVICE</a> *info)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Fill a user-supplied <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RTAUDIO_DEVICE</a> structure for a specified device.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>char* const&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a8">getStreamBuffer</a> (int streamID)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>A public method which returns a pointer to the buffer for an open stream.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a9">tickStream</a> (int streamID)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Public method used to trigger processing of input/output data for a stream.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a10">closeStream</a> (int streamID)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Public method which closes a stream and frees any associated buffers.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a11">startStream</a> (int streamID)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Public method which starts a stream.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a12">stopStream</a> (int streamID)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Stop a stream, allowing any samples remaining in the queue to be played out and/or read in.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a13">abortStream</a> (int streamID)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Stop a stream, discarding any samples remaining in the input/output queue.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#a14">streamWillBlock</a> (int streamID)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Queries a stream to determine whether a call to the <a class="el" href="classRtAudio.html#a9">tickStream</a>() method will block.</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#p0">RTAUDIO_SINT8</a></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#p1">RTAUDIO_SINT16</a></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#p2">RTAUDIO_SINT24</a></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#p3">RTAUDIO_SINT32</a></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#p4">RTAUDIO_FLOAT32</a></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudio.html#p5">RTAUDIO_FLOAT64</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="RtAudio::RTAUDIO_FORMAT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef unsigned long RtAudio::RTAUDIO_FORMAT
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<a name="s1" doxytag="RtAudio::RTAUDIO_CALLBACK"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef int(* RtAudio::RTAUDIO_CALLBACK)(char *buffer, int bufferSize, void *userData)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a name="s3" doxytag="RtAudio::@0"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
anonymous enum
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
<dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="s3s2" doxytag="MAX_SAMPLE_RATES"></a><em>MAX_SAMPLE_RATES</em>
&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="RtAudio::RtAudio"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
RtAudio::RtAudio (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
The default constructor.
<p>
Probes the system to make sure at least one audio input/output device is available and determines the api-specific identifier for each device found. An <a class="el" href="classRtAudioError.html">RtAudioError</a> error can be thrown if no devices are found or if a memory allocation error occurs. </td>
</tr>
</table>
<a name="a1" doxytag="RtAudio::RtAudio"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
RtAudio::RtAudio (
</b></td>
<td valign="bottom"><b>
int * <em>streamID</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>outputDevice</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>outputChannels</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>inputDevice</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>inputChannels</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> <em>format</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>sampleRate</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int * <em>bufferSize</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>numberOfBuffers</em>&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
A constructor which can be used to open a stream during instantiation.
<p>
The specified output and/or input device identifiers correspond to those enumerated via the <a class="el" href="classRtAudio.html#a7">getDeviceInfo</a>() method. If device = 0, the default or first available devices meeting the given parameters is selected. If an output or input channel value is zero, the corresponding device value is ignored. When a stream is successfully opened, its identifier is returned via the "streamID" pointer. An <a class="el" href="classRtAudioError.html">RtAudioError</a> can be thrown if no devices are found for the given parameters, if a memory allocation error occurs, or if a driver error occurs. <dl compact><dt>
<b>See also: </b><dd>
<a class="el" href="classRtAudio.html#a3">openStream</a>() </dl> </td>
</tr>
</table>
<a name="a2" doxytag="RtAudio::~RtAudio"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
RtAudio::~RtAudio (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
The destructor.
<p>
Stops and closes any open streams and devices and deallocates buffer and structure memory. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="RtAudio::openStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int RtAudio::openStream (
</b></td>
<td valign="bottom"><b>
int <em>outputDevice</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>outputChannels</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>inputDevice</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>inputChannels</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> <em>format</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>sampleRate</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int * <em>bufferSize</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>numberOfBuffers</em>&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
A public method for opening a stream with the specified parameters.
<p>
If successful, the opened stream ID is returned. Otherwise, an <a class="el" href="classRtAudioError.html">RtAudioError</a> is thrown.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>outputDevice:</em>
&nbsp;</td><td>
If equal to 0, the default or first device found meeting the given parameters is opened. Otherwise, the device number should correspond to one of those enumerated via the <a class="el" href="classRtAudio.html#a7">getDeviceInfo</a>() method. </td></tr>
<tr><td valign=top><em>outputChannels:</em>
&nbsp;</td><td>
The desired number of output channels. If equal to zero, the outputDevice identifier is ignored. </td></tr>
<tr><td valign=top><em>inputDevice:</em>
&nbsp;</td><td>
If equal to 0, the default or first device found meeting the given parameters is opened. Otherwise, the device number should correspond to one of those enumerated via the <a class="el" href="classRtAudio.html#a7">getDeviceInfo</a>() method. </td></tr>
<tr><td valign=top><em>inputChannels:</em>
&nbsp;</td><td>
The desired number of input channels. If equal to zero, the inputDevice identifier is ignored. </td></tr>
<tr><td valign=top><em>format:</em>
&nbsp;</td><td>
An RTAUDIO_FORMAT specifying the desired sample data format. </td></tr>
<tr><td valign=top><em>sampleRate:</em>
&nbsp;</td><td>
The desired sample rate (sample frames per second). </td></tr>
<tr><td valign=top><em>bufferSize:</em>
&nbsp;</td><td>
A pointer value indicating the desired internal buffer size in sample frames. The actual value used by the device is returned via the same pointer. A value of zero can be specified, in which case the lowest allowable value is determined. </td></tr>
<tr><td valign=top><em>numberOfBuffers:</em>
&nbsp;</td><td>
A value which can be used to help control device latency. More buffers typically result in more robust performance, though at a cost of greater latency. A value of zero can be specified, in which case the lowest allowable value is used. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="RtAudio::setStreamCallback"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void RtAudio::setStreamCallback (
</b></td>
<td valign="bottom"><b>
int <em>streamID</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classRtAudio.html#s1">RTAUDIO_CALLBACK</a> <em>callback</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
void * <em>userData</em>&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
A public method which sets a user-defined callback function for a given stream.
<p>
This method assigns a callback function to a specific, previously opened stream for non-blocking stream functionality. A separate process is initiated, though the user function is called only when the stream is "running" (between calls to the <a class="el" href="classRtAudio.html#a11">startStream</a>() and <a class="el" href="classRtAudio.html#a12">stopStream</a>() methods, respectively). The callback process remains active for the duration of the stream and is automatically shutdown when the stream is closed (via the <a class="el" href="classRtAudio.html#a10">closeStream</a>() method or by object destruction). The callback process can also be shutdown and the user function de-referenced through an explicit call to the <a class="el" href="classRtAudio.html#a5">cancelStreamCallback</a>() method. Note that a single stream can use only blocking or callback functionality at the same time, though it is possible to alternate modes on the same stream through the use of the <a class="el" href="classRtAudio.html#a4">setStreamCallback</a>() and <a class="el" href="classRtAudio.html#a5">cancelStreamCallback</a>() methods (the blocking <a class="el" href="classRtAudio.html#a9">tickStream</a>() method can be used before a callback is set and/or after a callback is cancelled). An <a class="el" href="classRtAudioError.html">RtAudioError</a> will be thrown for an invalid device argument. </td>
</tr>
</table>
<a name="a5" doxytag="RtAudio::cancelStreamCallback"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void RtAudio::cancelStreamCallback (
</b></td>
<td valign="bottom"><b>
int <em>streamID</em>&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
A public method which cancels a callback process and function for a given stream.
<p>
This method shuts down a callback process and de-references the user function for a specific stream. Callback functionality can subsequently be restarted on the stream via the <a class="el" href="classRtAudio.html#a4">setStreamCallback</a>() method. An <a class="el" href="classRtAudioError.html">RtAudioError</a> will be thrown for an invalid device argument. </td>
</tr>
</table>
<a name="a6" doxytag="RtAudio::getDeviceCount"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int RtAudio::getDeviceCount (
</b></td>
<td valign="bottom"><b>
void&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
A public method which returns the number of audio devices found.
<p>
</td>
</tr>
</table>
<a name="a7" doxytag="RtAudio::getDeviceInfo"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void RtAudio::getDeviceInfo (
</b></td>
<td valign="bottom"><b>
int <em>device</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RTAUDIO_DEVICE</a> * <em>info</em>&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Fill a user-supplied <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RTAUDIO_DEVICE</a> structure for a specified device.
<p>
Any device between 0 and <a class="el" href="classRtAudio.html#a6">getDeviceCount</a>()-1 is valid. If a device is busy or otherwise unavailable, the structure member "probed" has a value of "false". The system default input and output devices are referenced by device identifier = 0. On systems which allow dynamic default device settings, the default devices are not identified by name (specific device enumerations are assigned device identifiers &gt; 0). An <a class="el" href="classRtAudioError.html">RtAudioError</a> will be thrown for an invalid device argument. </td>
</tr>
</table>
<a name="a8" doxytag="RtAudio::getStreamBuffer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
char *const RtAudio::getStreamBuffer (
</b></td>
<td valign="bottom"><b>
int <em>streamID</em>&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
A public method which returns a pointer to the buffer for an open stream.
<p>
The user should fill and/or read the buffer data in interleaved format and then call the <a class="el" href="classRtAudio.html#a9">tickStream</a>() method. An <a class="el" href="classRtAudioError.html">RtAudioError</a> will be thrown for an invalid stream identifier. </td>
</tr>
</table>
<a name="a9" doxytag="RtAudio::tickStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void RtAudio::tickStream (
</b></td>
<td valign="bottom"><b>
int <em>streamID</em>&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Public method used to trigger processing of input/output data for a stream.
<p>
This method blocks until all buffer data is read/written. An <a class="el" href="classRtAudioError.html">RtAudioError</a> will be thrown for an invalid stream identifier or if a driver error occurs. </td>
</tr>
</table>
<a name="a10" doxytag="RtAudio::closeStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void RtAudio::closeStream (
</b></td>
<td valign="bottom"><b>
int <em>streamID</em>&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Public method which closes a stream and frees any associated buffers.
<p>
If an invalid stream identifier is specified, this method issues a warning and returns (an <a class="el" href="classRtAudioError.html">RtAudioError</a> is not thrown). </td>
</tr>
</table>
<a name="a11" doxytag="RtAudio::startStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void RtAudio::startStream (
</b></td>
<td valign="bottom"><b>
int <em>streamID</em>&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Public method which starts a stream.
<p>
An <a class="el" href="classRtAudioError.html">RtAudioError</a> will be thrown for an invalid stream identifier or if a driver error occurs. </td>
</tr>
</table>
<a name="a12" doxytag="RtAudio::stopStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void RtAudio::stopStream (
</b></td>
<td valign="bottom"><b>
int <em>streamID</em>&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Stop a stream, allowing any samples remaining in the queue to be played out and/or read in.
<p>
An <a class="el" href="classRtAudioError.html">RtAudioError</a> will be thrown for an invalid stream identifier or if a driver error occurs. </td>
</tr>
</table>
<a name="a13" doxytag="RtAudio::abortStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void RtAudio::abortStream (
</b></td>
<td valign="bottom"><b>
int <em>streamID</em>&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Stop a stream, discarding any samples remaining in the input/output queue.
<p>
An <a class="el" href="classRtAudioError.html">RtAudioError</a> will be thrown for an invalid stream identifier or if a driver error occurs. </td>
</tr>
</table>
<a name="a14" doxytag="RtAudio::streamWillBlock"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int RtAudio::streamWillBlock (
</b></td>
<td valign="bottom"><b>
int <em>streamID</em>&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Queries a stream to determine whether a call to the <a class="el" href="classRtAudio.html#a9">tickStream</a>() method will block.
<p>
A return value of 0 indicates that the stream will NOT block. A positive return value indicates the number of sample frames that cannot yet be processed without blocking. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="p0" doxytag="RtAudio::RTAUDIO_SINT8"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_SINT8<code> [static]</code>
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<a name="p1" doxytag="RtAudio::RTAUDIO_SINT16"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_SINT16<code> [static]</code>
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<a name="p2" doxytag="RtAudio::RTAUDIO_SINT24"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_SINT24<code> [static]</code>
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Upper 3 bytes of 32-bit integer. </td>
</tr>
</table>
<a name="p3" doxytag="RtAudio::RTAUDIO_SINT32"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_SINT32<code> [static]</code>
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<a name="p4" doxytag="RtAudio::RTAUDIO_FLOAT32"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_FLOAT32<code> [static]</code>
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Normalized between plus/minus 1.0. </td>
</tr>
</table>
<a name="p5" doxytag="RtAudio::RTAUDIO_FLOAT64"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_FLOAT64<code> [static]</code>
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Normalized between plus/minus 1.0. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 40
- 0
doc/html/classRtAudioError-members.html View File

@@ -0,0 +1,40 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>RtAudioError Member List</h1>This is the complete list of members for <a class="el" href="classRtAudioError.html">RtAudioError</a>, including all inherited members.<ul>
<li><a class="el" href="classRtAudioError.html#s11s1">DEBUG_WARNING</a> enum value
<li><a class="el" href="classRtAudioError.html#s11s8">DRIVER_ERROR</a> enum value
<li><a class="el" href="classRtAudioError.html#n0">error_message</a>
<code> [protected]</code><li><a class="el" href="classRtAudioError.html#a4">getMessage</a>(void)
<code> [inline, virtual]</code><li><a class="el" href="classRtAudioError.html#a3">getType</a>(void)
<code> [inline, virtual]</code><li><a class="el" href="classRtAudioError.html#s11s4">INVALID_DEVICE</a> enum value
<li><a class="el" href="classRtAudioError.html#s11s7">INVALID_PARAMETER</a> enum value
<li><a class="el" href="classRtAudioError.html#s11s5">INVALID_STREAM</a> enum value
<li><a class="el" href="classRtAudioError.html#s11s6">MEMORY_ERROR</a> enum value
<li><a class="el" href="classRtAudioError.html#s11s3">NO_DEVICES_FOUND</a> enum value
<li><a class="el" href="classRtAudioError.html#a2">printMessage</a>(void)
<code> [virtual]</code><li><a class="el" href="classRtAudioError.html#a0">RtAudioError</a>(const char *p, TYPE tipe=RtAudioError::UNSPECIFIED)
<li><a class="el" href="classRtAudioError.html#s11s9">SYSTEM_ERROR</a> enum value
<li><a class="el" href="classRtAudioError.html#s11s10">THREAD_ERROR</a> enum value
<li><a class="el" href="classRtAudioError.html#s11">TYPE</a> enum name
<li><a class="el" href="classRtAudioError.html#n1">type</a>
<code> [protected]</code><li><a class="el" href="classRtAudioError.html#s11s2">UNSPECIFIED</a> enum value
<li><a class="el" href="classRtAudioError.html#s11s0">WARNING</a> enum value
<li><a class="el" href="classRtAudioError.html#a1">~RtAudioError</a>(void)
<code> [virtual]</code></ul>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 337
- 0
doc/html/classRtAudioError.html View File

@@ -0,0 +1,337 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>RtAudioError Class Reference</h1><code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>&gt;</code>
<p>
<a href="classRtAudioError-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#s11">TYPE</a> { <br>
&nbsp;&nbsp;<a class="el" href="classRtAudioError.html#s11s0">WARNING</a>,
<a class="el" href="classRtAudioError.html#s11s1">DEBUG_WARNING</a>,
<a class="el" href="classRtAudioError.html#s11s2">UNSPECIFIED</a>,
<a class="el" href="classRtAudioError.html#s11s3">NO_DEVICES_FOUND</a>,
<br>
&nbsp;&nbsp;<a class="el" href="classRtAudioError.html#s11s4">INVALID_DEVICE</a>,
<a class="el" href="classRtAudioError.html#s11s5">INVALID_STREAM</a>,
<a class="el" href="classRtAudioError.html#s11s6">MEMORY_ERROR</a>,
<a class="el" href="classRtAudioError.html#s11s7">INVALID_PARAMETER</a>,
<br>
&nbsp;&nbsp;<a class="el" href="classRtAudioError.html#s11s8">DRIVER_ERROR</a>,
<a class="el" href="classRtAudioError.html#s11s9">SYSTEM_ERROR</a>,
<a class="el" href="classRtAudioError.html#s11s10">THREAD_ERROR</a>
<br>
}</td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#a0">RtAudioError</a> (const char *p, <a class="el" href="classRtAudioError.html#s11">TYPE</a> tipe=RtAudioError::UNSPECIFIED)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The constructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#a1">~RtAudioError</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The destructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#a2">printMessage</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Prints "thrown" error message to stdout.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classRtAudioError.html#s11">TYPE</a>&amp;&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#a3">getType</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns the "thrown" error message TYPE.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const char*&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#a4">getMessage</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns the "thrown" error message string.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#n0">error_message</a> [256]</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classRtAudioError.html#s11">TYPE</a>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#n1">type</a></td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a name="s11" doxytag="RtAudioError::TYPE"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
enum RtAudioError::TYPE
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
<dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="s11s0" doxytag="WARNING"></a><em>WARNING</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s11s1" doxytag="DEBUG_WARNING"></a><em>DEBUG_WARNING</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s11s2" doxytag="UNSPECIFIED"></a><em>UNSPECIFIED</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s11s3" doxytag="NO_DEVICES_FOUND"></a><em>NO_DEVICES_FOUND</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s11s4" doxytag="INVALID_DEVICE"></a><em>INVALID_DEVICE</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s11s5" doxytag="INVALID_STREAM"></a><em>INVALID_STREAM</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s11s6" doxytag="MEMORY_ERROR"></a><em>MEMORY_ERROR</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s11s7" doxytag="INVALID_PARAMETER"></a><em>INVALID_PARAMETER</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s11s8" doxytag="DRIVER_ERROR"></a><em>DRIVER_ERROR</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s11s9" doxytag="SYSTEM_ERROR"></a><em>SYSTEM_ERROR</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s11s10" doxytag="THREAD_ERROR"></a><em>THREAD_ERROR</em>
&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="RtAudioError::RtAudioError"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
RtAudioError::RtAudioError (
</b></td>
<td valign="bottom"><b>
const char * <em>p</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classRtAudioError.html#s11">TYPE</a> <em>tipe</em> = RtAudioError::UNSPECIFIED&nbsp;)
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
The constructor.
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="RtAudioError::~RtAudioError"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
RtAudioError::~RtAudioError (
</b></td>
<td valign="bottom"><b>
void&nbsp;)<code> [virtual]</code>
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
The destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="RtAudioError::printMessage"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void RtAudioError::printMessage (
</b></td>
<td valign="bottom"><b>
void&nbsp;)<code> [virtual]</code>
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Prints "thrown" error message to stdout.
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="RtAudioError::getType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classRtAudioError.html#s11">TYPE</a> &amp; RtAudioError::getType (
</b></td>
<td valign="bottom"><b>
void&nbsp;)<code> [inline, virtual]</code>
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Returns the "thrown" error message TYPE.
<p>
</td>
</tr>
</table>
<a name="a4" doxytag="RtAudioError::getMessage"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const char * RtAudioError::getMessage (
</b></td>
<td valign="bottom"><b>
void&nbsp;)<code> [inline, virtual]</code>
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Returns the "thrown" error message string.
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="n0" doxytag="RtAudioError::error_message"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
char RtAudioError::error_message<code> [protected]</code>
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<a name="n1" doxytag="RtAudioError::type"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classRtAudioError.html#s11">TYPE</a> RtAudioError::type<code> [protected]</code>
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 20
- 0
doc/html/doxygen.css View File

@@ -0,0 +1,20 @@
H1 { text-align: center; }
A.qindex {}
A.qindexRef {}
A.el { text-decoration: none; font-weight: bold }
A.elRef { font-weight: bold }
A.code { text-decoration: none; font-weight: normal; color: #4444ee }
A.codeRef { font-weight: normal; color: #4444ee }
DL.el { margin-left: -1cm }
DIV.fragment { width: 100%; border: none; background-color: #eeeeee }
DIV.ah { background-color: black; margin-bottom: 3; margin-top: 3 }
TD.md { background-color: #f2f2ff }
DIV.groupHeader { margin-left: 16; margin-top: 12; margin-bottom: 6; font-weight: bold }
DIV.groupText { margin-left: 16; font-style: italic; font-size: smaller }
FONT.keyword { color: #008000 }
FONT.keywordtype { color: #604020 }
FONT.keywordflow { color: #e08000 }
FONT.comment { color: #800000 }
FONT.preprocessor { color: #806020 }
FONT.stringliteral { color: #002080 }
FONT.charliteral { color: #008080 }

BIN
doc/html/doxygen.gif View File

Before After
Width: 110  |  Height: 53  |  Size: 2.3KB

+ 21
- 0
doc/html/files.html View File

@@ -0,0 +1,21 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>RtAudio File List</h1>Here is a list of all files with brief descriptions:<ul>
<li><a class="el" href="RtAudio_8h.html">RtAudio.h</a> <a href="RtAudio_8h-source.html">[code]</a></ul>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 129
- 0
doc/html/functions.html View File

@@ -0,0 +1,129 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>RtAudio Compound Members</h1><center>
<a href="#index_a">a</a>&nbsp;|&nbsp;<a href="#index_c">c</a>&nbsp;|&nbsp;<a href="#index_d">d</a>&nbsp;|&nbsp;<a href="#index_e">e</a>&nbsp;|&nbsp;<a href="#index_g">g</a>&nbsp;|&nbsp;<a href="#index_h">h</a>&nbsp;|&nbsp;<a href="#index_i">i</a>&nbsp;|&nbsp;<a href="#index_m">m</a>&nbsp;|&nbsp;<a href="#index_n">n</a>&nbsp;|&nbsp;<a href="#index_o">o</a>&nbsp;|&nbsp;<a href="#index_p">p</a>&nbsp;|&nbsp;<a href="#index_r">r</a>&nbsp;|&nbsp;<a href="#index_s">s</a>&nbsp;|&nbsp;<a href="#index_t">t</a>&nbsp;|&nbsp;<a href="#index_u">u</a>&nbsp;|&nbsp;<a href="#index_w">w</a>&nbsp;|&nbsp;<a href="#index_~">~</a></center>

<p>
Here is a list of all class members with links to the class documentation for each member:<a name="index_a"><h3>- a -</h3></a>
<ul>
<li>abortStream()
: <a class="el" href="classRtAudio.html#a13">RtAudio</a></ul>
<a name="index_c"><h3>- c -</h3></a>
<ul>
<li>cancelStreamCallback()
: <a class="el" href="classRtAudio.html#a5">RtAudio</a><li>closeStream()
: <a class="el" href="classRtAudio.html#a10">RtAudio</a></ul>
<a name="index_d"><h3>- d -</h3></a>
<ul>
<li>DEBUG_WARNING
: <a class="el" href="classRtAudioError.html#s11s1">RtAudioError</a><li>DRIVER_ERROR
: <a class="el" href="classRtAudioError.html#s11s8">RtAudioError</a></ul>
<a name="index_e"><h3>- e -</h3></a>
<ul>
<li>error_message
: <a class="el" href="classRtAudioError.html#n0">RtAudioError</a></ul>
<a name="index_g"><h3>- g -</h3></a>
<ul>
<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="classRtAudioError.html#a4">RtAudioError</a><li>getStreamBuffer()
: <a class="el" href="classRtAudio.html#a8">RtAudio</a><li>getType()
: <a class="el" href="classRtAudioError.html#a3">RtAudioError</a></ul>
<a name="index_h"><h3>- h -</h3></a>
<ul>
<li>hasDuplexSupport
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m9">RtAudio::RTAUDIO_DEVICE</a></ul>
<a name="index_i"><h3>- i -</h3></a>
<ul>
<li>id
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m1">RtAudio::RTAUDIO_DEVICE</a><li>INVALID_DEVICE
: <a class="el" href="classRtAudioError.html#s11s4">RtAudioError</a><li>INVALID_PARAMETER
: <a class="el" href="classRtAudioError.html#s11s7">RtAudioError</a><li>INVALID_STREAM
: <a class="el" href="classRtAudioError.html#s11s5">RtAudioError</a></ul>
<a name="index_m"><h3>- m -</h3></a>
<ul>
<li>MAX_SAMPLE_RATES
: <a class="el" href="classRtAudio.html#s3s2">RtAudio</a><li>maxDuplexChannels
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m5">RtAudio::RTAUDIO_DEVICE</a><li>maxInputChannels
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m4">RtAudio::RTAUDIO_DEVICE</a><li>maxOutputChannels
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m3">RtAudio::RTAUDIO_DEVICE</a><li>MEMORY_ERROR
: <a class="el" href="classRtAudioError.html#s11s6">RtAudioError</a><li>minDuplexChannels
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m8">RtAudio::RTAUDIO_DEVICE</a><li>minInputChannels
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m7">RtAudio::RTAUDIO_DEVICE</a><li>minOutputChannels
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m6">RtAudio::RTAUDIO_DEVICE</a></ul>
<a name="index_n"><h3>- n -</h3></a>
<ul>
<li>name
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m0">RtAudio::RTAUDIO_DEVICE</a><li>nativeFormats
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m12">RtAudio::RTAUDIO_DEVICE</a><li>NO_DEVICES_FOUND
: <a class="el" href="classRtAudioError.html#s11s3">RtAudioError</a><li>nSampleRates
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m10">RtAudio::RTAUDIO_DEVICE</a></ul>
<a name="index_o"><h3>- o -</h3></a>
<ul>
<li>openStream()
: <a class="el" href="classRtAudio.html#a3">RtAudio</a></ul>
<a name="index_p"><h3>- p -</h3></a>
<ul>
<li>printMessage()
: <a class="el" href="classRtAudioError.html#a2">RtAudioError</a><li>probed
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m2">RtAudio::RTAUDIO_DEVICE</a></ul>
<a name="index_r"><h3>- r -</h3></a>
<ul>
<li>RtAudio()
: <a class="el" href="classRtAudio.html#a1">RtAudio</a><li>RTAUDIO_CALLBACK
: <a class="el" href="classRtAudio.html#s1">RtAudio</a><li>RTAUDIO_FLOAT32
: <a class="el" href="classRtAudio.html#p4">RtAudio</a><li>RTAUDIO_FLOAT64
: <a class="el" href="classRtAudio.html#p5">RtAudio</a><li>RTAUDIO_FORMAT
: <a class="el" href="classRtAudio.html#s0">RtAudio</a><li>RTAUDIO_SINT16
: <a class="el" href="classRtAudio.html#p1">RtAudio</a><li>RTAUDIO_SINT24
: <a class="el" href="classRtAudio.html#p2">RtAudio</a><li>RTAUDIO_SINT32
: <a class="el" href="classRtAudio.html#p3">RtAudio</a><li>RTAUDIO_SINT8
: <a class="el" href="classRtAudio.html#p0">RtAudio</a><li>RtAudioError()
: <a class="el" href="classRtAudioError.html#a0">RtAudioError</a></ul>
<a name="index_s"><h3>- s -</h3></a>
<ul>
<li>sampleRates
: <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m11">RtAudio::RTAUDIO_DEVICE</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>streamWillBlock()
: <a class="el" href="classRtAudio.html#a14">RtAudio</a><li>SYSTEM_ERROR
: <a class="el" href="classRtAudioError.html#s11s9">RtAudioError</a></ul>
<a name="index_t"><h3>- t -</h3></a>
<ul>
<li>THREAD_ERROR
: <a class="el" href="classRtAudioError.html#s11s10">RtAudioError</a><li>tickStream()
: <a class="el" href="classRtAudio.html#a9">RtAudio</a><li>TYPE
: <a class="el" href="classRtAudioError.html#s11">RtAudioError</a><li>type
: <a class="el" href="classRtAudioError.html#n1">RtAudioError</a></ul>
<a name="index_u"><h3>- u -</h3></a>
<ul>
<li>UNSPECIFIED
: <a class="el" href="classRtAudioError.html#s11s2">RtAudioError</a></ul>
<a name="index_w"><h3>- w -</h3></a>
<ul>
<li>WARNING
: <a class="el" href="classRtAudioError.html#s11s0">RtAudioError</a></ul>
<a name="index_~"><h3>- ~ -</h3></a>
<ul>
<li>~RtAudio()
: <a class="el" href="classRtAudio.html#a2">RtAudio</a><li>~RtAudioError()
: <a class="el" href="classRtAudioError.html#a1">RtAudioError</a></ul>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 27
- 0
doc/html/globals.html View File

@@ -0,0 +1,27 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>RtAudio File Members</h1><center>
<a href="#index__">_</a></center>

<p>
Here is a list of all file members with links to the files they belong to:<a name="index__"><h3>- _ -</h3></a>
<ul>
<li>__RtAudio_h
: <a class="el" href="RtAudio_8h.html#a0">RtAudio.h</a></ul>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 583
- 0
doc/html/index.html View File

@@ -0,0 +1,583 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>The <a class="el" href="classRtAudio.html">RtAudio</a> Tutorial</h1>
<p>
<p>
<center>
<a href="index.html#intro">Introduction</a> &nbsp;&nbsp; <a href="index.html#download">Download</a> &nbsp;&nbsp; <a href="index.html#start">Getting Started</a> &nbsp;&nbsp; <a href="index.html#error">Error Handling</a> &nbsp;&nbsp; <a href="index.html#probing">Probing Device Capabilities</a> &nbsp;&nbsp; <a href="index.html#settings">Device Settings</a> &nbsp;&nbsp; <a href="index.html#playbackb">Playback (blocking functionality)</a> &nbsp;&nbsp; <a href="index.html#playbackc">Playback (callback functionality)</a> &nbsp;&nbsp; <a href="index.html#recording">Recording</a> &nbsp;&nbsp; <a href="index.html#duplex">Duplex Mode</a> &nbsp;&nbsp; <a href="index.html#methods">Summary of Methods</a> &nbsp;&nbsp; <a href="index.html#compiling">Compiling</a> &nbsp;&nbsp; <a href="index.html#osnotes">OS Notes</a> &nbsp;&nbsp; <a href="index.html#acknowledge">Acknowledgments</a> </center>

<p>
<a name="intro"><h2>Introduction</h2></a>

<p>
<a class="el" href="classRtAudio.html">RtAudio</a> is a C++ class which provides a common API (Application Programming Interface) for realtime audio input/output across Linux (native ALSA and OSS), SGI, and Windows operating systems. <a class="el" href="classRtAudio.html">RtAudio</a> significantly simplifies the process of interacting with computer audio hardware. It was designed with the following goals:
<p>
<ul>
<li>object oriented C++ design <li>simple, common API across all supported platforms <li>single independent header and source file for easy inclusion in programming projects (no libraries!) <li>blocking functionality <li>callback functionality <li>extensive audio device parameter control <li>audio device capability probing <li>automatic internal conversion for data format, channel number compensation, de-interleaving, and byte-swapping <li>control over multiple audio streams and devices with a single instance </ul>

<p>
<a class="el" href="classRtAudio.html">RtAudio</a> incorporates the concept of audio streams, which represent audio output (playback) and/or input (recording). Available audio devices and their capabilities can be enumerated and then specified when opening a stream. Multiple streams can run at the same time and, when allowed by the underlying audio API, a single device can serve multiple streams.
<p>
The <a class="el" href="classRtAudio.html">RtAudio</a> API provides both blocking (synchronous) and callback (asynchronous) functionality. Callbacks are typically used in conjunction with graphical user interfaces (GUI). Blocking functionality is often necessary for explicit control of multiple input/output stream synchronization or when audio must be synchronized with other system events.
<p>
<a name="download"><h2>Download</h2></a>

<p>
Latest Release (22 January 2002): <a href="release/rtaudio-2.0.tgz">Version 2.0 (111 kB tar/gzipped)</a>
<p>
<a name="start"><h2>Getting Started</h2></a>

<p>
The first thing that must be done when using <a class="el" href="classRtAudio.html">RtAudio</a> is to create an instance of the class. The default constructor <a class="el" href="classRtAudio.html#a0">RtAudio::RtAudio</a>() scans the underlying audio system to verify that at least one device is available. <a class="el" href="classRtAudio.html">RtAudio</a> often uses C++ exceptions to report errors, necessitating try/catch blocks around most member functions. The following code example demonstrates default object construction and destruction:
<p>
<div class="fragment"><pre><font class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</font>

<font class="keywordtype">int</font> main()<font class="keyword"></font>
<font class="keyword"></font>{
<a class="code" href="classRtAudio.html">RtAudio</a> *audio;

<font class="comment">// Default RtAudio constructor</font>
<font class="keywordflow">try</font> {
audio = <font class="keyword">new</font> RtAudio();
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
<font class="comment">// Handle the exception here</font>
}

<font class="comment">// Clean up</font>
<font class="keyword">delete</font> audio;
}</pre></div>
<p>
Obviously, this example doesn't demonstrate any of the real functionality of <a class="el" href="classRtAudio.html">RtAudio</a>. However, all uses of <a class="el" href="classRtAudio.html">RtAudio</a> must begin with a constructor (either default or overloaded varieties) and must end with class destruction. Further, it is necessary that all class methods which can throw a C++ exception be called within a try/catch block.
<p>
<a name="error"><h2>Error Handling</h2></a>

<p>
<a class="el" href="classRtAudio.html">RtAudio</a> uses a C++ exception handler called <a class="el" href="classRtAudioError.html">RtAudioError</a>, which is declared and defined within the <a class="el" href="classRtAudio.html">RtAudio</a> class files. The <a class="el" href="classRtAudioError.html">RtAudioError</a> class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtAudioError.html#s11">RtAudioError::TYPE</a>. Almost all <a class="el" href="classRtAudio.html">RtAudio</a> methods can "throw" an <a class="el" href="classRtAudioError.html">RtAudioError</a>, most typically if an invalid stream identifier is supplied to a method or a driver error occurs. There are a number of cases within <a class="el" href="classRtAudio.html">RtAudio</a> where warning messages may be displayed but an exception is not thrown. There is a private <a class="el" href="classRtAudio.html">RtAudio</a> method, error(), which can be modified to globally control how these messages are handled and reported.
<p>
<a name="probing"><h2>Probing Device Capabilities</h2></a>

<p>
A programmer may wish to query the available audio device capabilities before deciding which to use. The following example outlines how this can be done.
<p>
<div class="fragment"><pre><font class="comment">// probe.cpp</font>

<font class="preprocessor">#include &lt;iostream.h&gt;</font>
<font class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</font>

<font class="keywordtype">int</font> main()<font class="keyword"></font>
<font class="keyword"></font>{
<a class="code" href="classRtAudio.html">RtAudio</a> *audio;

<font class="comment">// Default RtAudio constructor</font>
<font class="keywordflow">try</font> {
audio = <font class="keyword">new</font> RtAudio();
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
exit(EXIT_FAILURE);
}

<font class="comment">// Determine the number of devices available</font>
<font class="keywordtype">int</font> devices = audio-&gt;<a class="code" href="classRtAudio.html#a6">getDeviceCount</a>();

<font class="comment">// Scan through devices for various capabilities</font>
<a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RtAudio::RTAUDIO_DEVICE</a> info;
<font class="keywordflow">for</font> (<font class="keywordtype">int</font> i=0; i&lt;devices; i++) {

<font class="keywordflow">try</font> {
audio-&gt;<a class="code" href="classRtAudio.html#a7">getDeviceInfo</a>(i, &amp;info);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
<font class="keywordflow">break</font>;
}

<font class="comment">// Print, for example, the maximum number of output channels for each device</font>
cout &lt;&lt; <font class="stringliteral">"device = "</font> &lt;&lt; i;
cout &lt;&lt; <font class="stringliteral">": maximum output channels = "</font> &lt;&lt; info.maxOutputChannels &lt;&lt; endl;
}

<font class="comment">// Clean up</font>
<font class="keyword">delete</font> audio;

<font class="keywordflow">return</font> 0;
}</pre></div>
<p>
The RTAUDIO_DEVICE structure is defined in <a class="el" href="RtAudio_8h.html">RtAudio.h</a> and provides a variety of information useful in assessing the capabilities of a device:
<p>
<div class="fragment"><pre> <font class="keyword">typedef</font> <font class="keyword">struct </font>{
<font class="keywordtype">char</font> name[128];
DEVICE_ID id[2]; <font class="comment">// No value reported by getDeviceInfo().</font>
<font class="keywordtype">bool</font> probed; <font class="comment">// true if the device probe was successful.</font>
<font class="keywordtype">int</font> maxOutputChannels;
<font class="keywordtype">int</font> maxInputChannels;
<font class="keywordtype">int</font> maxDuplexChannels;
<font class="keywordtype">int</font> minOutputChannels;
<font class="keywordtype">int</font> minInputChannels;
<font class="keywordtype">int</font> minDuplexChannels;
<font class="keywordtype">bool</font> hasDuplexSupport; <font class="comment">// true if duplex supported</font>
<font class="keywordtype">int</font> nSampleRates; <font class="comment">// Number of discrete rates, or -1 if range supported.</font>
<font class="keywordtype">double</font> sampleRates[MAX_SAMPLE_RATES]; <font class="comment">// Supported sample rates, or {min, max} if range.</font>
RTAUDIO_FORMAT nativeFormats;
} RTAUDIO_DEVICE;</pre></div>
<p>
The following data formats are defined and fully supported by <a class="el" href="classRtAudio.html">RtAudio</a>:
<p>
<div class="fragment"><pre> <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> RTAUDIO_FORMAT;
<font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT8; <font class="comment">// Signed 8-bit integer</font>
<font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT16; <font class="comment">// Signed 16-bit integer</font>
<font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT24; <font class="comment">// Signed 24-bit integer</font>
<font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT32; <font class="comment">// Signed 32-bit integer</font>
<font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_FLOAT32; <font class="comment">// 32-bit float</font>
<font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_FLOAT64; <font class="comment">// 64-bit double</font></pre></div>
<p>
The <em>nativeFormats</em> member of the <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RtAudio::RTAUDIO_DEVICE</a> structure is a bit mask of the above formats which are natively supported by the device. However, <a class="el" href="classRtAudio.html">RtAudio</a> will automatically provide format conversion if a particular format is not natively supported. When the <em>probed</em> member of the RTAUDIO_DEVICE structure is false, the remaining structure members are likely unknown and the device is probably unusable.
<p>
In general, the user need not be concerned with the minimum channel values reported in the RTAUDIO_DEVICE structure. While some audio devices may require a minimum channel value &gt; 1, <a class="el" href="classRtAudio.html">RtAudio</a> will provide automatic channel number compensation when the number of channels set by the user is less than that required by the device. Channel compensation is <em>NOT</em> possible when the number of channels set by the user is greater than that supported by the device.
<p>
It should be noted that the capabilities reported by a device driver or underlying audio API are not always accurate and/or may be dependent on a combination of device settings.
<p>
<a name="settings"><h2>Device Settings</h2></a>

<p>
The next step in using <a class="el" href="classRtAudio.html">RtAudio</a> is to open a stream with a particular set of device settings.
<p>
<div class="fragment"><pre><font class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</font>

<font class="keywordtype">int</font> main()<font class="keyword"></font>
<font class="keyword"></font>{
<font class="keywordtype">int</font> channels = 2;
<font class="keywordtype">int</font> sample_rate = 44100;
<font class="keywordtype">int</font> buffer_size = 256; <font class="comment">// 256 sample frames</font>
<font class="keywordtype">int</font> n_buffers = 4; <font class="comment">// number of internal buffers used by device</font>
<font class="keywordtype">int</font> device = 0; <font class="comment">// 0 indicates the default or first available device</font>
<font class="keywordtype">int</font> stream; <font class="comment">// our stream identifier</font>
<a class="code" href="classRtAudio.html">RtAudio</a> *audio;

<font class="comment">// Instantiate RtAudio and open a stream within a try/catch block</font>
<font class="keywordflow">try</font> {
audio = <font class="keyword">new</font> RtAudio();
stream = audio-&gt;<a class="code" href="classRtAudio.html#a3">openStream</a>(device, channels, 0, 0, RtAudio::RTAUDIO_FLOAT32,
sample_rate, &amp;buffer_size, n_buffers);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
exit(EXIT_FAILURE);
}

<font class="comment">// Clean up</font>
<font class="keyword">delete</font> audio;

<font class="keywordflow">return</font> 0;
}</pre></div>
<p>
The <a class="el" href="classRtAudio.html#a3">RtAudio::openStream</a>() method attempts to open a stream with a specified set of parameter values. When successful, a stream identifier is returned. In this case, we attempt to open a playback stream on device 0 with two channels, 32-bit floating point data, a sample rate of 44100 Hz, a frame rate of 256 sample frames per read/write, and 4 internal device buffers. When device = 0, <a class="el" href="classRtAudio.html">RtAudio</a> first attempts to open the default audio device with the given parameters. If that attempt fails, an attempt is made to find a device or set of devices which will meet the given parameters. If all attempts are unsuccessful, an <a class="el" href="classRtAudioError.html">RtAudioError</a> is thrown. When a non-zero device value is specified, an attempt is made to open that device only.
<p>
<a class="el" href="classRtAudio.html">RtAudio</a> provides four signed integer and two floating point data formats which can be specified using the <a class="el" href="classRtAudio.html#s0">RtAudio::RTAUDIO_FORMAT</a> parameter values mentioned earlier. If the opened device does not natively support the given format, <a class="el" href="classRtAudio.html">RtAudio</a> will automatically perform the necessary data format conversion.
<p>
Buffer sizes in <a class="el" href="classRtAudio.html">RtAudio</a> are <em>ALWAYS</em> given in sample frame units. For example, if you open an output stream with 4 channels and set <em>bufferSize</em> to 512, you will have to write 2048 samples of data to the output buffer within your callback or between calls to <a class="el" href="classRtAudio.html#a9">RtAudio::tickStream</a>(). In this case, a single sample frame of data contains 4 samples of data.
<p>
The <em>bufferSize</em> parameter specifies the desired number of sample frames which will be written to and/or read from a device per write/read operation. The <em>nBuffers</em> parameter is used in setting the underlying device buffer parameters. Both the <em>bufferSize</em> and <em>nBuffers</em> parameters can be used to control stream latency though there is no guarantee that the passed values will be those used by a device. In general, lower values for both parameters will produce less latency but perhaps less robust performance. Both parameters can be specified with values of zero, in which case the smallest allowable values will be used. The <em>bufferSize</em> parameter is passed as a pointer and the actual value used by the stream is set during the device setup procedure. <em>bufferSize</em> values should be a power of two. Optimal and allowable buffer values tend to vary between systems and devices. Check the <a href="index.html#osnotes">OS Notes</a> section for general guidelines.
<p>
As noted earlier, the device capabilities reported by a driver or underlying audio API are not always accurate and/or may be dependent on a combination of device settings. Because of this, <a class="el" href="classRtAudio.html">RtAudio</a> does not attempt to query a device's capabilities or use previously reported values when opening a device. Instead, <a class="el" href="classRtAudio.html">RtAudio</a> simply attempts to set the given parameters on a specified device and then checks whether the setup is successful or not.
<p>
<a name="playbackb"><h2>Playback (blocking functionality)</h2></a>

<p>
Once the device is open for playback, there are only a few final steps necessary for realtime audio output. We'll first provide an example (blocking functionality) and then discuss the details.
<p>
<div class="fragment"><pre><font class="comment">// playback.cpp</font>

<font class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</font>

<font class="keywordtype">int</font> main()<font class="keyword"></font>
<font class="keyword"></font>{
<font class="keywordtype">int</font> count;
<font class="keywordtype">int</font> channels = 2;
<font class="keywordtype">int</font> sample_rate = 44100;
<font class="keywordtype">int</font> buffer_size = 256; <font class="comment">// 256 sample frames</font>
<font class="keywordtype">int</font> n_buffers = 4; <font class="comment">// number of internal buffers used by device</font>
<font class="keywordtype">float</font> *buffer;
<font class="keywordtype">int</font> device = 0; <font class="comment">// 0 indicates the default or first available device</font>
<font class="keywordtype">int</font> stream; <font class="comment">// our stream identifier</font>
<a class="code" href="classRtAudio.html">RtAudio</a> *audio;

<font class="comment">// Open a stream during RtAudio instantiation</font>
<font class="keywordflow">try</font> {
audio = <font class="keyword">new</font> RtAudio(&amp;stream, device, channels, 0, 0, RtAudio::RTAUDIO_FLOAT32,
sample_rate, &amp;buffer_size, n_buffers);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
exit(EXIT_FAILURE);
}

<font class="keywordflow">try</font> {
<font class="comment">// Get a pointer to the stream buffer</font>
buffer = (<font class="keywordtype">float</font> *) audio-&gt;<a class="code" href="classRtAudio.html#a8">getStreamBuffer</a>(stream);

<font class="comment">// Start the stream</font>
audio-&gt;<a class="code" href="classRtAudio.html#a11">startStream</a>(stream);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
<font class="keywordflow">goto</font> cleanup;
}

<font class="comment">// An example loop which runs for about 40000 sample frames</font>
count = 0;
<font class="keywordflow">while</font> (count &lt; 40000) {
<font class="comment">// Generate your samples and fill the buffer with buffer_size sample frames of data</font>
...

<font class="comment">// Trigger the output of the data buffer</font>
<font class="keywordflow">try</font> {
audio-&gt;<a class="code" href="classRtAudio.html#a9">tickStream</a>(stream);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
<font class="keywordflow">goto</font> cleanup;
}

count += buffer_size;
}

<font class="keywordflow">try</font> {
<font class="comment">// Stop and close the stream</font>
audio-&gt;<a class="code" href="classRtAudio.html#a12">stopStream</a>(stream);
audio-&gt;<a class="code" href="classRtAudio.html#a10">closeStream</a>(stream);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
}

cleanup:
<font class="keyword">delete</font> audio;

<font class="keywordflow">return</font> 0;
}</pre></div>
<p>
The first thing to notice in this example is that we attempt to open a stream during class instantiation with an overloaded constructor. This constructor simply combines the functionality of the default constructor, used earlier, and the <a class="el" href="classRtAudio.html#a3">RtAudio::openStream</a>() method. Again, we have specified a device value of 0, indicating that the default or first available device meeting the given parameters should be used. The integer identifier of the opened stream is returned via the <em>stream</em> pointer value. An attempt is made to open the stream with the specified <em>bufferSize</em> value. However, it is possible that the device will not accept this value, in which case the closest allowable size is used and returned via the pointer value. The constructor can fail if no available devices are found, or a memory allocation or device driver error occurs. Note that you should not call the <a class="el" href="classRtAudio.html">RtAudio</a> destructor if an exception is thrown during instantiation.
<p>
Because <a class="el" href="classRtAudio.html">RtAudio</a> can be used to simultaneously control more than a single stream, it is necessary that the stream identifier be provided to nearly all public methods. Assuming the constructor is successful, it is necessary to get a pointer to the buffer, provided by <a class="el" href="classRtAudio.html">RtAudio</a>, for use in feeding data to/from the opened stream. Note that the user should <em>NOT</em> attempt to deallocate the stream buffer memory ... memory management for the stream buffer will be automatically controlled by <a class="el" href="classRtAudio.html">RtAudio</a>. After starting the stream with <a class="el" href="classRtAudio.html#a11">RtAudio::startStream</a>(), one simply fills that buffer, which is of length equal to the returned <em>bufferSize</em> value, with interleaved audio data (in the specified format) for playback. Finally, a call to the <a class="el" href="classRtAudio.html#a9">RtAudio::tickStream</a>() routine triggers a blocking write call for the stream.
<p>
In general, one should call the <a class="el" href="classRtAudio.html#a12">RtAudio::stopStream</a>() and <a class="el" href="classRtAudio.html#a10">RtAudio::closeStream</a>() methods after finishing with a stream. However, both methods will implicitly be called during object destruction if necessary.
<p>
<a name="playbackc"><h2>Playback (callback functionality)</h2></a>

<p>
The primary difference in using <a class="el" href="classRtAudio.html">RtAudio</a> with callback functionality involves the creation of a user-defined callback function. Here is an example which produces a sawtooth waveform for playback.
<p>
<div class="fragment"><pre><font class="preprocessor">#include &lt;iostream.h&gt;</font>
<font class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</font>

<font class="comment">// Two-channel sawtooth wave generator.</font>
<font class="keywordtype">int</font> sawtooth(<font class="keywordtype">char</font> *buffer, <font class="keywordtype">int</font> buffer_size, <font class="keywordtype">void</font> *data)<font class="keyword"></font>
<font class="keyword"></font>{
<font class="keywordtype">int</font> i, j;
<font class="keywordtype">double</font> *my_buffer = (<font class="keywordtype">double</font> *) buffer;
<font class="keywordtype">double</font> *my_data = (<font class="keywordtype">double</font> *) data;

<font class="comment">// Write interleaved audio data.</font>
<font class="keywordflow">for</font> (i=0; i&lt;buffer_size; i++) {
<font class="keywordflow">for</font> (j=0; j&lt;2; j++) {
*my_buffer++ = my_data[j];

my_data[j] += 0.005 * (j+1+(j*0.1));
<font class="keywordflow">if</font> (my_data[j] &gt;= 1.0) my_data[j] -= 2.0;
}
}

<font class="keywordflow">return</font> 0;
}

<font class="keywordtype">int</font> main()<font class="keyword"></font>
<font class="keyword"></font>{
<font class="keywordtype">int</font> channels = 2;
<font class="keywordtype">int</font> sample_rate = 44100;
<font class="keywordtype">int</font> buffer_size = 256; <font class="comment">// 256 sample frames</font>
<font class="keywordtype">int</font> n_buffers = 4; <font class="comment">// number of internal buffers used by device</font>
<font class="keywordtype">int</font> device = 0; <font class="comment">// 0 indicates the default or first available device</font>
<font class="keywordtype">int</font> stream; <font class="comment">// our stream identifier</font>
<font class="keywordtype">double</font> data[2];
<font class="keywordtype">char</font> input;
<a class="code" href="classRtAudio.html">RtAudio</a> *audio;

<font class="comment">// Open a stream during RtAudio instantiation</font>
<font class="keywordflow">try</font> {
audio = <font class="keyword">new</font> RtAudio(&amp;stream, device, channels, 0, 0, RtAudio::RTAUDIO_FLOAT64,
sample_rate, &amp;buffer_size, n_buffers);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
exit(EXIT_FAILURE);
}

<font class="keywordflow">try</font> {
<font class="comment">// Set the stream callback function</font>
audio-&gt;<a class="code" href="classRtAudio.html#a4">setStreamCallback</a>(stream, &amp;sawtooth, (<font class="keywordtype">void</font> *)data);

<font class="comment">// Start the stream</font>
audio-&gt;<a class="code" href="classRtAudio.html#a11">startStream</a>(stream);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
<font class="keywordflow">goto</font> cleanup;
}

cout &lt;&lt; <font class="stringliteral">"\nPlaying ... press &lt;enter&gt; to quit.\n"</font>;
cin.get(input);

<font class="keywordflow">try</font> {
<font class="comment">// Stop and close the stream</font>
audio-&gt;<a class="code" href="classRtAudio.html#a12">stopStream</a>(stream);
audio-&gt;<a class="code" href="classRtAudio.html#a10">closeStream</a>(stream);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
}

cleanup:
<font class="keyword">delete</font> audio;

<font class="keywordflow">return</font> 0;
}</pre></div>
<p>
After opening the device in exactly the same way as the previous example (except with a data format change), we must set our callback function for the stream using <a class="el" href="classRtAudio.html#a4">RtAudio::setStreamCallback</a>(). This method will spawn a new process (or thread) which automatically calls the callback function when more data is needed. Note that the callback function is called only when the stream is "running" (between calls to the <a class="el" href="classRtAudio.html#a11">RtAudio::startStream</a>() and <a class="el" href="classRtAudio.html#a12">RtAudio::stopStream</a>() methods). The last argument to <a class="el" href="classRtAudio.html#a4">RtAudio::setStreamCallback</a>() is a pointer to arbitrary data that you wish to access from within your callback function.
<p>
In this example, we stop the stream with an explicit call to <a class="el" href="classRtAudio.html#a12">RtAudio::stopStream</a>(). When using callback functionality, it is also possible to stop a stream by returning a non-zero value from the callback function.
<p>
Once set with <a class="el" href="classRtAudio.html#a4">RtAudio::setStreamCallback</a>, the callback process will continue to run for the life of the stream (until the stream is closed with <a class="el" href="classRtAudio.html#a10">RtAudio::closeStream</a>() or the <a class="el" href="classRtAudio.html">RtAudio</a> instance is deleted). It is possible to disassociate a callback function and cancel its process for an open stream using the <a class="el" href="classRtAudio.html#a5">RtAudio::cancelStreamCallback</a>() method. The stream can then be used with blocking functionality or a new callback can be associated with it.
<p>
<a name="recording"><h2>Recording</h2></a>

<p>
Using <a class="el" href="classRtAudio.html">RtAudio</a> for audio input is almost identical to the way it is used for playback. Here's the blocking playback example rewritten for recording:
<p>
<div class="fragment"><pre><font class="comment">// record.cpp</font>

<font class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</font>

<font class="keywordtype">int</font> main()<font class="keyword"></font>
<font class="keyword"></font>{
<font class="keywordtype">int</font> count;
<font class="keywordtype">int</font> channels = 2;
<font class="keywordtype">int</font> sample_rate = 44100;
<font class="keywordtype">int</font> buffer_size = 256; <font class="comment">// 256 sample frames</font>
<font class="keywordtype">int</font> n_buffers = 4; <font class="comment">// number of internal buffers used by device</font>
<font class="keywordtype">float</font> *buffer;
<font class="keywordtype">int</font> device = 0; <font class="comment">// 0 indicates the default or first available device</font>
<font class="keywordtype">int</font> stream; <font class="comment">// our stream identifier</font>
<a class="code" href="classRtAudio.html">RtAudio</a> *audio;

<font class="comment">// Instantiate RtAudio and open a stream.</font>
<font class="keywordflow">try</font> {
audio = <font class="keyword">new</font> RtAudio(&amp;stream, 0, 0, device, channels,
RtAudio::RTAUDIO_FLOAT32, sample_rate, &amp;buffer_size, n_buffers);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
exit(EXIT_FAILURE);
}

<font class="keywordflow">try</font> {
<font class="comment">// Get a pointer to the stream buffer</font>
buffer = (<font class="keywordtype">float</font> *) audio-&gt;<a class="code" href="classRtAudio.html#a8">getStreamBuffer</a>(stream);

<font class="comment">// Start the stream</font>
audio-&gt;<a class="code" href="classRtAudio.html#a11">startStream</a>(stream);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
<font class="keywordflow">goto</font> cleanup;
}

<font class="comment">// An example loop which runs for about 40000 sample frames</font>
count = 0;
<font class="keywordflow">while</font> (count &lt; 40000) {

<font class="comment">// Read a buffer of data</font>
<font class="keywordflow">try</font> {
audio-&gt;<a class="code" href="classRtAudio.html#a9">tickStream</a>(stream);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
<font class="keywordflow">goto</font> cleanup;
}

<font class="comment">// Process the input samples (buffer_size sample frames) that were read</font>
...

count += buffer_size;
}

<font class="keywordflow">try</font> {
<font class="comment">// Stop the stream</font>
audio-&gt;<a class="code" href="classRtAudio.html#a12">stopStream</a>(stream);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
}

cleanup:
<font class="keyword">delete</font> audio;

<font class="keywordflow">return</font> 0;
}</pre></div>
<p>
In this example, the stream was opened for recording with a non-zero <em>inputChannels</em> value. The only other difference between this example and that for playback involves the order of data processing in the loop, where it is necessary to first read a buffer of input data before manipulating it.
<p>
<a name="duplex"><h2>Duplex Mode</h2></a>

<p>
Finally, it is easy to use <a class="el" href="classRtAudio.html">RtAudio</a> for simultaneous audio input/output, or duplex operation. In this example, we use a callback function and pass our recorded data directly through for playback.
<p>
<div class="fragment"><pre><font class="comment">// duplex.cpp</font>

<font class="preprocessor">#include &lt;iostream.h&gt;</font>
<font class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</font>

<font class="comment">// Pass-through function.</font>
<font class="keywordtype">int</font> pass(<font class="keywordtype">char</font> *buffer, <font class="keywordtype">int</font> buffer_size, <font class="keywordtype">void</font> *)<font class="keyword"></font>
<font class="keyword"></font>{
<font class="comment">// Surprise!! We do nothing to pass the data through.</font>
<font class="keywordflow">return</font> 0;
}

<font class="keywordtype">int</font> main()<font class="keyword"></font>
<font class="keyword"></font>{
<font class="keywordtype">int</font> channels = 2;
<font class="keywordtype">int</font> sample_rate = 44100;
<font class="keywordtype">int</font> buffer_size = 256; <font class="comment">// 256 sample frames</font>
<font class="keywordtype">int</font> n_buffers = 4; <font class="comment">// number of internal buffers used by device</font>
<font class="keywordtype">int</font> device = 0; <font class="comment">// 0 indicates the default or first available device</font>
<font class="keywordtype">int</font> stream; <font class="comment">// our stream identifier</font>
<font class="keywordtype">double</font> data[2];
<font class="keywordtype">char</font> input;
<a class="code" href="classRtAudio.html">RtAudio</a> *audio;

<font class="comment">// Open a stream during RtAudio instantiation</font>
<font class="keywordflow">try</font> {
audio = <font class="keyword">new</font> RtAudio(&amp;stream, device, channels, device, channels, RtAudio::RTAUDIO_FLOAT64,
sample_rate, &amp;buffer_size, n_buffers);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
exit(EXIT_FAILURE);
}

<font class="keywordflow">try</font> {
<font class="comment">// Set the stream callback function</font>
audio-&gt;<a class="code" href="classRtAudio.html#a4">setStreamCallback</a>(stream, &amp;pass, NULL);

<font class="comment">// Start the stream</font>
audio-&gt;<a class="code" href="classRtAudio.html#a11">startStream</a>(stream);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
<font class="keywordflow">goto</font> cleanup;
}

cout &lt;&lt; <font class="stringliteral">"\nRunning duplex ... press &lt;enter&gt; to quit.\n"</font>;
cin.get(input);

<font class="keywordflow">try</font> {
<font class="comment">// Stop and close the stream</font>
audio-&gt;<a class="code" href="classRtAudio.html#a12">stopStream</a>(stream);
audio-&gt;<a class="code" href="classRtAudio.html#a10">closeStream</a>(stream);
}
<font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &amp;error) {
error.printMessage();
}

cleanup:
<font class="keyword">delete</font> audio;

<font class="keywordflow">return</font> 0;
}</pre></div>
<p>
When an <a class="el" href="classRtAudio.html">RtAudio</a> stream is running in duplex mode (nonzero input <em>AND</em> output channels), the audio write (playback) operation always occurs before the audio read (record) operation. This sequence allows the use of a single buffer to store both output and input data.
<p>
As we see with this example, the write-read sequence of operations does not preclude the use of <a class="el" href="classRtAudio.html">RtAudio</a> in situations where input data is first processed and then output through a duplex stream. When the stream buffer is first allocated, it is initialized with zeros, which produces no audible result when output to the device. In this example, anything recorded by the audio stream input will be played out during the next round of audio processing.
<p>
Note that duplex operation can also be achieved by opening one output stream and one input stream using the same or different devices. However, there may be timing problems when attempting to use two different devices, due to possible device clock variations. This becomes even more difficult to achieve using two separate callback streams because it is not possible to explicitly control the calling order of the callback functions.
<p>
<a name="methods"><h2>Summary of Methods</h2></a>

<p>
The following is short summary of public methods (not including constructors and the destructor) provided by <a class="el" href="classRtAudio.html">RtAudio</a>:
<p>
<ul>
<li><a class="el" href="classRtAudio.html#a3">RtAudio::openStream</a>(): opens a stream with the specified parameters. <li><a class="el" href="classRtAudio.html#a4">RtAudio::setStreamCallback</a>(): sets a user-defined callback function for a given stream. <li><a class="el" href="classRtAudio.html#a5">RtAudio::cancelStreamCallback</a>(): cancels a callback process and function for a given stream. <li><a class="el" href="classRtAudio.html#a6">RtAudio::getDeviceCount</a>(): returns the number of audio devices available. <li><a class="el" href="classRtAudio.html#a7">RtAudio::getDeviceInfo</a>(): fills a user-supplied RTAUDIO_DEVICE structure for a specified device. <li><a class="el" href="classRtAudio.html#a8">RtAudio::getStreamBuffer</a>(): returns a pointer to the stream buffer. <li><a class="el" href="classRtAudio.html#a9">RtAudio::tickStream</a>(): triggers processing of input/output data for a stream (blocking). <li><a class="el" href="classRtAudio.html#a10">RtAudio::closeStream</a>(): closes the specified stream (implicitly called during object destruction). Once a stream is closed, the stream identifier is invalid and should not be used in calling any other <a class="el" href="classRtAudio.html">RtAudio</a> methods. <li><a class="el" href="classRtAudio.html#a11">RtAudio::startStream</a>(): (re)starts the specified stream, typically after it has been stopped with either stopStream() or abortStream() or after first opening the stream. <li><a class="el" href="classRtAudio.html#a12">RtAudio::stopStream</a>(): stops the specified stream, allowing any remaining samples in the queue to be played out and/or read in. This does not implicitly call <a class="el" href="classRtAudio.html#a10">RtAudio::closeStream</a>(). <li><a class="el" href="classRtAudio.html#a13">RtAudio::abortStream</a>(): stops the specified stream, discarding any remaining samples in the queue. This does not implicitly call closeStream(). <li><a class="el" href="classRtAudio.html#a14">RtAudio::streamWillBlock</a>(): queries a stream to determine whether a call to the <em>tickStream()</em> method will block. A return value of 0 indicates that the stream will NOT block. A positive return value indicates the number of sample frames that cannot yet be processed without blocking. </ul>

<p>
<a name="compiling"><h2>Compiling</h2></a>

<p>
In order to compile <a class="el" href="classRtAudio.html">RtAudio</a> for a specific OS and audio API, it is necessary to supply the appropriate preprocessor definition and library within the compiler statement:
<p>

<p>
<table border=1 cellspacing=3 cellpadding=3><tr><td><b>OS:</b> </td><td><b>Audio API:</b> </td><td><b>Preprocessor Definition:</b> </td><td><b>Library:</b> </td><td><b>Example Compiler Statement:</b> </td></tr>
<tr><td>Linux </td><td>ALSA </td><td>__LINUX_ALSA_ </td><td><code>libasound, libpthread</code> </td><td><code>g++ -Wall -D__LINUX_ALSA_ -o probe probe.cpp RtAudio.cpp -lasound -lpthread</code> </td></tr>
<tr><td>Linux </td><td>OSS </td><td>__LINUX_OSS_ </td><td><code>libpthread</code> </td><td><code>g++ -Wall -D__LINUX_OSS_ -o probe probe.cpp RtAudio.cpp -lpthread</code> </td></tr>
<tr><td>Irix </td><td>AL </td><td>__IRIX_AL_ </td><td><code>libaudio, libpthread</code> </td><td><code>CC -Wall -D__IRIX_AL_ -o probe probe.cpp RtAudio.cpp -laudio -lpthread</code> </td></tr>
<tr><td>Windows </td><td>Direct Sound </td><td>__WINDOWS_DS_ </td><td><code>dsound.lib (ver. 5.0 or higher), multithreaded</code> </td><td><em>compiler specific</em> </td></table>
<p>

<p>
The example compiler statements above could be used to compile the <code>probe.cpp</code> example file, assuming that <code>probe.cpp</code>, <code><a class="el" href="RtAudio_8h.html">RtAudio.h</a></code>, and <code>RtAudio.cpp</code> all exist in the same directory.
<p>
<a name="osnotes"><h2>OS Notes</h2></a>

<p>
<a class="el" href="classRtAudio.html">RtAudio</a> is designed to provide a common API across the various supported operating systems and audio libraries. Despite that, however, some issues need to be mentioned with regard to each.
<p>
<a name="linux"><h3>Linux:</h3></a>

<p>
<a class="el" href="classRtAudio.html">RtAudio</a> for Linux was developed under Redhat distributions 7.0 - 7.2. Two different audio APIs are supported on Linux platforms: OSS and <a href="http://www.alsa-project.org/">ALSA</a>. The OSS API has existed for at least 6 years and the Linux kernel is distributed with free versions of OSS audio drivers. Therefore, a generic Linux system is most likely to have OSS support. The ALSA API is relatively new and at this time is not part of the Linux kernel distribution. Work is in progress to make ALSA part of the 2.5 development kernel series. Despite that, the ALSA API offers significantly better functionality than the OSS API. <a class="el" href="classRtAudio.html">RtAudio</a> provides support for the 0.9 and higher versions of ALSA. Input/output latency on the order of 15-20 milliseconds can typically be achieved under both OSS or ALSA by fine-tuning the <a class="el" href="classRtAudio.html">RtAudio</a> buffer parameters (without kernel modifications). Latencies on the order of 5 milliseconds or less can be achieved using a low-latency kernel patch and increasing FIFO scheduling priority. The pthread library, which is used for callback functionality, is a standard component of all Linux distributions.
<p>
The ALSA library includes OSS emulation support. That means that you can run programs compiled for the OSS API even when using the ALSA drivers and library. It should be noted however that OSS emulation under ALSA is not perfect. Specifically, channel number queries seem to consistently produce invalid results. While OSS emulation is successful for the majority of <a class="el" href="classRtAudio.html">RtAudio</a> tests, it is recommended that the native ALSA implementation of <a class="el" href="classRtAudio.html">RtAudio</a> be used on systems which have ALSA drivers installed.
<p>
The ALSA implementation of <a class="el" href="classRtAudio.html">RtAudio</a> makes no use of the ALSA "plug" interface. All necessary data format conversions, channel compensation, deinterleaving, and byte-swapping is handled by internal <a class="el" href="classRtAudio.html">RtAudio</a> routines.
<p>
<a name="irix"><h3>Irix (SGI):</h3></a>

<p>
The Irix version of <a class="el" href="classRtAudio.html">RtAudio</a> was written and tested on an SGI Indy running Irix version 6.5 and the newer "al" audio library. <a class="el" href="classRtAudio.html">RtAudio</a> does not compile under Irix version 6.3 because the C++ compiler is too old. Despite the relatively slow speed of the Indy, <a class="el" href="classRtAudio.html">RtAudio</a> was found to behave quite well and input/output latency was very good. No problems were found with respect to using the pthread library.
<p>
<a name="windows"><h3>Windows:</h3></a>

<p>
<a class="el" href="classRtAudio.html">RtAudio</a> under Windows is written using the DirectSound API. In order to compile <a class="el" href="classRtAudio.html">RtAudio</a> under Windows, you must have the header and source files for DirectSound version 0.5 or higher. As far as I know, you cannot compile <a class="el" href="classRtAudio.html">RtAudio</a> for Windows NT because there is not sufficient DirectSound support. Audio output latency with DirectSound can be reasonably good (on the order of 20 milliseconds). On the other hand, input audio latency tends to be terrible (100 milliseconds or more). Further, DirectSound drivers tend to crash easily when experimenting with buffer parameters. On my system, I found it necessary to use values around nBuffers = 8 and bufferSize = 512 to avoid crashing my system. <a class="el" href="classRtAudio.html">RtAudio</a> was developed with Visual C++ version 6.0. I was forced in several instances to modify code in order to get it to compile under the non-standard version of C++ that Microsoft so unprofessionally implemented. We can only hope that the developers of Visual C++ 7.0 will have time to read the C++ standard.
<p>
<a name="acknowledge"><h2>Acknowledgments</h2></a>

<p>
The <a class="el" href="classRtAudio.html">RtAudio</a> API incorporates many of the concepts developed in the <a href="http://www.portaudio.com/">PortAudio</a> project by Phil Burk and Ross Bencina. Early development also incorporated ideas from Bill Schottstaedt's <a href="http://www-ccrma.stanford.edu/software/snd/sndlib/">sndlib</a>. The CCRMA <a href="http://www-ccrma.stanford.edu/groups/soundwire/">SoundWire group</a> provided valuable feedback during the API proposal stages.
<p>
<a class="el" href="classRtAudio.html">RtAudio</a> was slowly developed over the course of many months while in residence at the <a href="http://www.iua.upf.es/">Institut Universitari de L'Audiovisual (IUA)</a> in Barcelona, Spain, the <a href="http://www.acoustics.hut.fi/">Laboratory of Acoustics and Audio Signal Processing</a> at the Helsinki University of Technology, Finland, and the <a href="http://www-ccrma.stanford.edu/">Center for Computer Research in Music and Acoustics (CCRMA)</a> at <a href="http://www.stanford.edu/">Stanford University</a>. This work was supported in part by the United States Air Force Office of Scientific Research (grant #F49620-99-1-0293).
<p>
These documentation files were generated using <a href="http://www.doxygen.org/">doxygen</a> by Dimitri van Heesch.
<p>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 34
- 0
doc/html/structRtAudio_1_1RTAUDIO__DEVICE-members.html View File

@@ -0,0 +1,34 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>RtAudio::RTAUDIO_DEVICE Member List</h1>This is the complete list of members for <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RtAudio::RTAUDIO_DEVICE</a>, including all inherited members.<ul>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m9">hasDuplexSupport</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m1">id</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m5">maxDuplexChannels</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m4">maxInputChannels</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m3">maxOutputChannels</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m8">minDuplexChannels</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m7">minInputChannels</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m6">minOutputChannels</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m0">name</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m12">nativeFormats</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m10">nSampleRates</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m2">probed</a>
<li><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m11">sampleRates</a>
</ul>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 378
- 0
doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html View File

@@ -0,0 +1,378 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>RtAudio::RTAUDIO_DEVICE Struct Reference</h1><code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>&gt;</code>
<p>
<a href="structRtAudio_1_1RTAUDIO__DEVICE-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m0">name</a> [128]</td></tr>
<tr><td nowrap align=right valign=top>DEVICE_ID&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m1">id</a> [2]</td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m2">probed</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m3">maxOutputChannels</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m4">maxInputChannels</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m5">maxDuplexChannels</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m6">minOutputChannels</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m7">minInputChannels</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m8">minDuplexChannels</a></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m9">hasDuplexSupport</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m10">nSampleRates</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m11">sampleRates</a> [MAX_SAMPLE_RATES]</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a>&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m12">nativeFormats</a></td></tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="m0" doxytag="RtAudio::RTAUDIO_DEVICE::name"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
char RtAudio::RTAUDIO_DEVICE::name
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<a name="m1" doxytag="RtAudio::RTAUDIO_DEVICE::id"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
DEVICE_ID RtAudio::RTAUDIO_DEVICE::id
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
No value reported by <a class="el" href="classRtAudio.html#a7">getDeviceInfo</a>(). </td>
</tr>
</table>
<a name="m2" doxytag="RtAudio::RTAUDIO_DEVICE::probed"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool RtAudio::RTAUDIO_DEVICE::probed
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
true if the device capabilities were successfully probed. </td>
</tr>
</table>
<a name="m3" doxytag="RtAudio::RTAUDIO_DEVICE::maxOutputChannels"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int RtAudio::RTAUDIO_DEVICE::maxOutputChannels
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<a name="m4" doxytag="RtAudio::RTAUDIO_DEVICE::maxInputChannels"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int RtAudio::RTAUDIO_DEVICE::maxInputChannels
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<a name="m5" doxytag="RtAudio::RTAUDIO_DEVICE::maxDuplexChannels"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int RtAudio::RTAUDIO_DEVICE::maxDuplexChannels
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<a name="m6" doxytag="RtAudio::RTAUDIO_DEVICE::minOutputChannels"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int RtAudio::RTAUDIO_DEVICE::minOutputChannels
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<a name="m7" doxytag="RtAudio::RTAUDIO_DEVICE::minInputChannels"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int RtAudio::RTAUDIO_DEVICE::minInputChannels
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<a name="m8" doxytag="RtAudio::RTAUDIO_DEVICE::minDuplexChannels"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int RtAudio::RTAUDIO_DEVICE::minDuplexChannels
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
</td>
</tr>
</table>
<a name="m9" doxytag="RtAudio::RTAUDIO_DEVICE::hasDuplexSupport"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool RtAudio::RTAUDIO_DEVICE::hasDuplexSupport
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
true if device supports duplex mode. </td>
</tr>
</table>
<a name="m10" doxytag="RtAudio::RTAUDIO_DEVICE::nSampleRates"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int RtAudio::RTAUDIO_DEVICE::nSampleRates
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Number of discrete rates or -1 if range supported. </td>
</tr>
</table>
<a name="m11" doxytag="RtAudio::RTAUDIO_DEVICE::sampleRates"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int RtAudio::RTAUDIO_DEVICE::sampleRates
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Supported rates or (min, max) if range. </td>
</tr>
</table>
<a name="m12" doxytag="RtAudio::RTAUDIO_DEVICE::nativeFormats"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_DEVICE::nativeFormats
</b></td>
</tr>

</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>

<p>
Bit mask of supported data formats. </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 21
- 0
doc/html/tutorial_8txt.html View File

@@ -0,0 +1,21 @@
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>tutorial.txt File Reference</h1><table border=0 cellpadding=0 cellspacing=0>
</table>
<HR>
<table><tr><td><img src="../ccrma.gif">
<td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
</BODY>
</HTML>

+ 31
- 0
doc/latex/Makefile View File

@@ -0,0 +1,31 @@
all: refman.dvi

ps: refman.ps

pdf: refman.pdf

ps_2on1: refman_2on1.ps

pdf_2on1: refman_2on1.pdf

refman.ps: refman.dvi
dvips -o refman.ps refman.dvi

refman.pdf: refman.ps
ps2pdf refman.ps refman.pdf

refman_2on1.ps: refman.ps
psnup -2 refman.ps >refman_2on1.ps

refman_2on1.pdf: refman_2on1.ps
ps2pdf refman_2on1.ps refman_2on1.pdf

refman.dvi: refman.tex doxygen.sty
echo "Running latex..."
latex refman.tex
echo "Running makeindex..."
makeindex refman.idx
echo "Rerunning latex...."
latex refman.tex
clean:
rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out

+ 29
- 0
doc/latex/RtAudio_8h.tex View File

@@ -0,0 +1,29 @@
\section{Rt\-Audio.h File Reference}
\label{RtAudio_8h}\index{RtAudio.h@{Rt\-Audio.h}}
{\tt \#include $<$map$>$}\par
\subsection*{Compounds}
\begin{CompactItemize}
\item
class {\bf Rt\-Audio\-Error}
\item
class {\bf Rt\-Audio}
\item
struct {\bf Rt\-Audio::RTAUDIO\_\-DEVICE}
\item
struct {\bf Rt\-Audio::RTAUDIO\_\-STREAM}
\end{CompactItemize}
\subsection*{Defines}
\begin{CompactItemize}
\item
\#define {\bf \_\-\_\-Rt\-Audio\_\-h}
\end{CompactItemize}


\subsection{Define Documentation}
\index{RtAudio.h@{Rt\-Audio.h}!__RtAudio_h@{\_\-\_\-RtAudio\_\-h}}
\index{__RtAudio_h@{\_\-\_\-RtAudio\_\-h}!RtAudio.h@{Rt\-Audio.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define \_\-\_\-Rt\-Audio\_\-h}\label{RtAudio_8h_a0}


{\bf Value:}\footnotesize\begin{verbatim}
\end{verbatim}\normalsize

+ 6
- 0
doc/latex/annotated.tex View File

@@ -0,0 +1,6 @@
\section{Rt\-Audio Compound List}
Here are the classes, structs, unions and interfaces with brief descriptions:\begin{CompactList}
\item\contentsline{section}{{\bf Rt\-Audio} }{\pageref{classRtAudio}}{}
\item\contentsline{section}{{\bf Rt\-Audio::RTAUDIO\_\-DEVICE} }{\pageref{structRtAudio_1_1RTAUDIO__DEVICE}}{}
\item\contentsline{section}{{\bf Rt\-Audio\-Error} }{\pageref{classRtAudioError}}{}
\end{CompactList}

+ 254
- 0
doc/latex/classRtAudio.tex View File

@@ -0,0 +1,254 @@
\section{Rt\-Audio Class Reference}
\label{classRtAudio}\index{RtAudio@{Rt\-Audio}}
{\tt \#include $<$Rt\-Audio.h$>$}

\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef unsigned long {\bf RTAUDIO\_\-FORMAT}
\item
typedef int ($\ast$ {\bf RTAUDIO\_\-CALLBACK} )(char $\ast$buffer, int buffer\-Size, void $\ast$user\-Data)
\item
enum \{ {\bf MAX\_\-SAMPLE\_\-RATES} = 14
\}
\end{CompactItemize}
\subsection*{Public Methods}
\begin{CompactItemize}
\item
{\bf Rt\-Audio} ()
\begin{CompactList}\small\item\em The default constructor.\item\end{CompactList}\item
{\bf Rt\-Audio} (int $\ast$stream\-ID, int output\-Device, int output\-Channels, int input\-Device, int input\-Channels, {\bf RTAUDIO\_\-FORMAT} format, int sample\-Rate, int $\ast$buffer\-Size, int number\-Of\-Buffers)
\begin{CompactList}\small\item\em A constructor which can be used to open a stream during instantiation.\item\end{CompactList}\item
{\bf $\sim$Rt\-Audio} ()
\begin{CompactList}\small\item\em The destructor.\item\end{CompactList}\item
int {\bf open\-Stream} (int output\-Device, int output\-Channels, int input\-Device, int input\-Channels, {\bf RTAUDIO\_\-FORMAT} format, int sample\-Rate, int $\ast$buffer\-Size, int number\-Of\-Buffers)
\begin{CompactList}\small\item\em A public method for opening a stream with the specified parameters.\item\end{CompactList}\item
void {\bf set\-Stream\-Callback} (int stream\-ID, {\bf RTAUDIO\_\-CALLBACK} callback, void $\ast$user\-Data)
\begin{CompactList}\small\item\em A public method which sets a user-defined callback function for a given stream.\item\end{CompactList}\item
void {\bf cancel\-Stream\-Callback} (int stream\-ID)
\begin{CompactList}\small\item\em A public method which cancels a callback process and function for a given stream.\item\end{CompactList}\item
int {\bf get\-Device\-Count} (void)
\begin{CompactList}\small\item\em A public method which returns the number of audio devices found.\item\end{CompactList}\item
void {\bf get\-Device\-Info} (int device, {\bf RTAUDIO\_\-DEVICE} $\ast$info)
\begin{CompactList}\small\item\em Fill a user-supplied {\bf RTAUDIO\_\-DEVICE} {\rm (p.\,\pageref{structRtAudio_1_1RTAUDIO__DEVICE})} structure for a specified device.\item\end{CompactList}\item
char$\ast$ const {\bf get\-Stream\-Buffer} (int stream\-ID)
\begin{CompactList}\small\item\em A public method which returns a pointer to the buffer for an open stream.\item\end{CompactList}\item
void {\bf tick\-Stream} (int stream\-ID)
\begin{CompactList}\small\item\em Public method used to trigger processing of input/output data for a stream.\item\end{CompactList}\item
void {\bf close\-Stream} (int stream\-ID)
\begin{CompactList}\small\item\em Public method which closes a stream and frees any associated buffers.\item\end{CompactList}\item
void {\bf start\-Stream} (int stream\-ID)
\begin{CompactList}\small\item\em Public method which starts a stream.\item\end{CompactList}\item
void {\bf stop\-Stream} (int stream\-ID)
\begin{CompactList}\small\item\em Stop a stream, allowing any samples remaining in the queue to be played out and/or read in.\item\end{CompactList}\item
void {\bf abort\-Stream} (int stream\-ID)
\begin{CompactList}\small\item\em Stop a stream, discarding any samples remaining in the input/output queue.\item\end{CompactList}\item
int {\bf stream\-Will\-Block} (int stream\-ID)
\begin{CompactList}\small\item\em Queries a stream to determine whether a call to the {\bf tick\-Stream}() {\rm (p.\,\pageref{classRtAudio_a9})} method will block.\item\end{CompactList}\end{CompactItemize}
\subsection*{Static Public Attributes}
\begin{CompactItemize}
\item
const {\bf RTAUDIO\_\-FORMAT} {\bf RTAUDIO\_\-SINT8}
\item
const {\bf RTAUDIO\_\-FORMAT} {\bf RTAUDIO\_\-SINT16}
\item
const {\bf RTAUDIO\_\-FORMAT} {\bf RTAUDIO\_\-SINT24}
\item
const {\bf RTAUDIO\_\-FORMAT} {\bf RTAUDIO\_\-SINT32}
\item
const {\bf RTAUDIO\_\-FORMAT} {\bf RTAUDIO\_\-FLOAT32}
\item
const {\bf RTAUDIO\_\-FORMAT} {\bf RTAUDIO\_\-FLOAT64}
\end{CompactItemize}


\subsection{Member Typedef Documentation}
\index{RtAudio@{Rt\-Audio}!RTAUDIO_FORMAT@{RTAUDIO\_\-FORMAT}}
\index{RTAUDIO_FORMAT@{RTAUDIO\_\-FORMAT}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned long Rt\-Audio::RTAUDIO\_\-FORMAT}\label{classRtAudio_s0}


\index{RtAudio@{Rt\-Audio}!RTAUDIO_CALLBACK@{RTAUDIO\_\-CALLBACK}}
\index{RTAUDIO_CALLBACK@{RTAUDIO\_\-CALLBACK}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef int($\ast$ Rt\-Audio::RTAUDIO\_\-CALLBACK)(char $\ast$buffer, int buffer\-Size, void $\ast$user\-Data)}\label{classRtAudio_s1}




\subsection{Member Enumeration Documentation}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}anonymous enum}\label{classRtAudio_s3}


\begin{Desc}
\item[{\bf Enumeration values:}]\par
\begin{description}
\index{MAX_SAMPLE_RATES@{MAX\_\-SAMPLE\_\-RATES}!RtAudio@{Rt\-Audio}}\index{RtAudio@{RtAudio}!MAX_SAMPLE_RATES@{MAX\_\-SAMPLE\_\-RATES}}\item[
{\em MAX\_\-SAMPLE\_\-RATES}\label{classRtAudio_s3s2}
]\end{description}
\end{Desc}



\subsection{Constructor \& Destructor Documentation}
\index{RtAudio@{Rt\-Audio}!RtAudio@{RtAudio}}
\index{RtAudio@{RtAudio}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Rt\-Audio::Rt\-Audio ()}\label{classRtAudio_a0}


The default constructor.

Probes the system to make sure at least one audio input/output device is available and determines the api-specific identifier for each device found. An {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} error can be thrown if no devices are found or if a memory allocation error occurs. \index{RtAudio@{Rt\-Audio}!RtAudio@{RtAudio}}
\index{RtAudio@{RtAudio}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Rt\-Audio::Rt\-Audio (int $\ast$ {\em stream\-ID}, int {\em output\-Device}, int {\em output\-Channels}, int {\em input\-Device}, int {\em input\-Channels}, {\bf RTAUDIO\_\-FORMAT} {\em format}, int {\em sample\-Rate}, int $\ast$ {\em buffer\-Size}, int {\em number\-Of\-Buffers})}\label{classRtAudio_a1}


A constructor which can be used to open a stream during instantiation.

The specified output and/or input device identifiers correspond to those enumerated via the {\bf get\-Device\-Info}() {\rm (p.\,\pageref{classRtAudio_a7})} method. If device = 0, the default or first available devices meeting the given parameters is selected. If an output or input channel value is zero, the corresponding device value is ignored. When a stream is successfully opened, its identifier is returned via the \char`\"{}stream\-ID\char`\"{} pointer. An {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} can be thrown if no devices are found for the given parameters, if a memory allocation error occurs, or if a driver error occurs. \begin{Desc}
\item[{\bf See also: }]\par
{\bf open\-Stream}() {\rm (p.\,\pageref{classRtAudio_a3})} \end{Desc}
\index{RtAudio@{Rt\-Audio}!~RtAudio@{$\sim$RtAudio}}
\index{~RtAudio@{$\sim$RtAudio}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Rt\-Audio::$\sim$Rt\-Audio ()}\label{classRtAudio_a2}


The destructor.

Stops and closes any open streams and devices and deallocates buffer and structure memory.

\subsection{Member Function Documentation}
\index{RtAudio@{Rt\-Audio}!openStream@{openStream}}
\index{openStream@{openStream}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Rt\-Audio::open\-Stream (int {\em output\-Device}, int {\em output\-Channels}, int {\em input\-Device}, int {\em input\-Channels}, {\bf RTAUDIO\_\-FORMAT} {\em format}, int {\em sample\-Rate}, int $\ast$ {\em buffer\-Size}, int {\em number\-Of\-Buffers})}\label{classRtAudio_a3}


A public method for opening a stream with the specified parameters.

If successful, the opened stream ID is returned. Otherwise, an {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} is thrown.\begin{Desc}
\item[{\bf Parameters: }]\par
\begin{description}
\item[
{\em output\-Device:}]If equal to 0, the default or first device found meeting the given parameters is opened. Otherwise, the device number should correspond to one of those enumerated via the {\bf get\-Device\-Info}() {\rm (p.\,\pageref{classRtAudio_a7})} method. \item[
{\em output\-Channels:}]The desired number of output channels. If equal to zero, the output\-Device identifier is ignored. \item[
{\em input\-Device:}]If equal to 0, the default or first device found meeting the given parameters is opened. Otherwise, the device number should correspond to one of those enumerated via the {\bf get\-Device\-Info}() {\rm (p.\,\pageref{classRtAudio_a7})} method. \item[
{\em input\-Channels:}]The desired number of input channels. If equal to zero, the input\-Device identifier is ignored. \item[
{\em format:}]An RTAUDIO\_\-FORMAT specifying the desired sample data format. \item[
{\em sample\-Rate:}]The desired sample rate (sample frames per second). \item[
{\em buffer\-Size:}]A pointer value indicating the desired internal buffer size in sample frames. The actual value used by the device is returned via the same pointer. A value of zero can be specified, in which case the lowest allowable value is determined. \item[
{\em number\-Of\-Buffers:}]A value which can be used to help control device latency. More buffers typically result in more robust performance, though at a cost of greater latency. A value of zero can be specified, in which case the lowest allowable value is used. \end{description}
\end{Desc}
\index{RtAudio@{Rt\-Audio}!setStreamCallback@{setStreamCallback}}
\index{setStreamCallback@{setStreamCallback}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Rt\-Audio::set\-Stream\-Callback (int {\em stream\-ID}, {\bf RTAUDIO\_\-CALLBACK} {\em callback}, void $\ast$ {\em user\-Data})}\label{classRtAudio_a4}


A public method which sets a user-defined callback function for a given stream.

This method assigns a callback function to a specific, previously opened stream for non-blocking stream functionality. A separate process is initiated, though the user function is called only when the stream is \char`\"{}running\char`\"{} (between calls to the {\bf start\-Stream}() {\rm (p.\,\pageref{classRtAudio_a11})} and {\bf stop\-Stream}() {\rm (p.\,\pageref{classRtAudio_a12})} methods, respectively). The callback process remains active for the duration of the stream and is automatically shutdown when the stream is closed (via the {\bf close\-Stream}() {\rm (p.\,\pageref{classRtAudio_a10})} method or by object destruction). The callback process can also be shutdown and the user function de-referenced through an explicit call to the {\bf cancel\-Stream\-Callback}() {\rm (p.\,\pageref{classRtAudio_a5})} method. Note that a single stream can use only blocking or callback functionality at the same time, though it is possible to alternate modes on the same stream through the use of the {\bf set\-Stream\-Callback}() {\rm (p.\,\pageref{classRtAudio_a4})} and {\bf cancel\-Stream\-Callback}() {\rm (p.\,\pageref{classRtAudio_a5})} methods (the blocking {\bf tick\-Stream}() {\rm (p.\,\pageref{classRtAudio_a9})} method can be used before a callback is set and/or after a callback is cancelled). An {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} will be thrown for an invalid device argument. \index{RtAudio@{Rt\-Audio}!cancelStreamCallback@{cancelStreamCallback}}
\index{cancelStreamCallback@{cancelStreamCallback}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Rt\-Audio::cancel\-Stream\-Callback (int {\em stream\-ID})}\label{classRtAudio_a5}


A public method which cancels a callback process and function for a given stream.

This method shuts down a callback process and de-references the user function for a specific stream. Callback functionality can subsequently be restarted on the stream via the {\bf set\-Stream\-Callback}() {\rm (p.\,\pageref{classRtAudio_a4})} method. An {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} will be thrown for an invalid device argument. \index{RtAudio@{Rt\-Audio}!getDeviceCount@{getDeviceCount}}
\index{getDeviceCount@{getDeviceCount}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Rt\-Audio::get\-Device\-Count (void)}\label{classRtAudio_a6}


A public method which returns the number of audio devices found.

\index{RtAudio@{Rt\-Audio}!getDeviceInfo@{getDeviceInfo}}
\index{getDeviceInfo@{getDeviceInfo}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Rt\-Audio::get\-Device\-Info (int {\em device}, {\bf RTAUDIO\_\-DEVICE} $\ast$ {\em info})}\label{classRtAudio_a7}


Fill a user-supplied {\bf RTAUDIO\_\-DEVICE} {\rm (p.\,\pageref{structRtAudio_1_1RTAUDIO__DEVICE})} structure for a specified device.

Any device between 0 and {\bf get\-Device\-Count}() {\rm (p.\,\pageref{classRtAudio_a6})}-1 is valid. If a device is busy or otherwise unavailable, the structure member \char`\"{}probed\char`\"{} has a value of \char`\"{}false\char`\"{}. The system default input and output devices are referenced by device identifier = 0. On systems which allow dynamic default device settings, the default devices are not identified by name (specific device enumerations are assigned device identifiers $>$ 0). An {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} will be thrown for an invalid device argument. \index{RtAudio@{Rt\-Audio}!getStreamBuffer@{getStreamBuffer}}
\index{getStreamBuffer@{getStreamBuffer}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char $\ast$const Rt\-Audio::get\-Stream\-Buffer (int {\em stream\-ID})}\label{classRtAudio_a8}


A public method which returns a pointer to the buffer for an open stream.

The user should fill and/or read the buffer data in interleaved format and then call the {\bf tick\-Stream}() {\rm (p.\,\pageref{classRtAudio_a9})} method. An {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} will be thrown for an invalid stream identifier. \index{RtAudio@{Rt\-Audio}!tickStream@{tickStream}}
\index{tickStream@{tickStream}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Rt\-Audio::tick\-Stream (int {\em stream\-ID})}\label{classRtAudio_a9}


Public method used to trigger processing of input/output data for a stream.

This method blocks until all buffer data is read/written. An {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} will be thrown for an invalid stream identifier or if a driver error occurs. \index{RtAudio@{Rt\-Audio}!closeStream@{closeStream}}
\index{closeStream@{closeStream}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Rt\-Audio::close\-Stream (int {\em stream\-ID})}\label{classRtAudio_a10}


Public method which closes a stream and frees any associated buffers.

If an invalid stream identifier is specified, this method issues a warning and returns (an {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} is not thrown). \index{RtAudio@{Rt\-Audio}!startStream@{startStream}}
\index{startStream@{startStream}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Rt\-Audio::start\-Stream (int {\em stream\-ID})}\label{classRtAudio_a11}


Public method which starts a stream.

An {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} will be thrown for an invalid stream identifier or if a driver error occurs. \index{RtAudio@{Rt\-Audio}!stopStream@{stopStream}}
\index{stopStream@{stopStream}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Rt\-Audio::stop\-Stream (int {\em stream\-ID})}\label{classRtAudio_a12}


Stop a stream, allowing any samples remaining in the queue to be played out and/or read in.

An {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} will be thrown for an invalid stream identifier or if a driver error occurs. \index{RtAudio@{Rt\-Audio}!abortStream@{abortStream}}
\index{abortStream@{abortStream}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Rt\-Audio::abort\-Stream (int {\em stream\-ID})}\label{classRtAudio_a13}


Stop a stream, discarding any samples remaining in the input/output queue.

An {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} will be thrown for an invalid stream identifier or if a driver error occurs. \index{RtAudio@{Rt\-Audio}!streamWillBlock@{streamWillBlock}}
\index{streamWillBlock@{streamWillBlock}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Rt\-Audio::stream\-Will\-Block (int {\em stream\-ID})}\label{classRtAudio_a14}


Queries a stream to determine whether a call to the {\bf tick\-Stream}() {\rm (p.\,\pageref{classRtAudio_a9})} method will block.

A return value of 0 indicates that the stream will NOT block. A positive return value indicates the number of sample frames that cannot yet be processed without blocking.

\subsection{Member Data Documentation}
\index{RtAudio@{Rt\-Audio}!RTAUDIO_SINT8@{RTAUDIO\_\-SINT8}}
\index{RTAUDIO_SINT8@{RTAUDIO\_\-SINT8}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf RTAUDIO\_\-FORMAT} Rt\-Audio::RTAUDIO\_\-SINT8\hspace{0.3cm}{\tt [static]}}\label{classRtAudio_p0}


\index{RtAudio@{Rt\-Audio}!RTAUDIO_SINT16@{RTAUDIO\_\-SINT16}}
\index{RTAUDIO_SINT16@{RTAUDIO\_\-SINT16}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf RTAUDIO\_\-FORMAT} Rt\-Audio::RTAUDIO\_\-SINT16\hspace{0.3cm}{\tt [static]}}\label{classRtAudio_p1}


\index{RtAudio@{Rt\-Audio}!RTAUDIO_SINT24@{RTAUDIO\_\-SINT24}}
\index{RTAUDIO_SINT24@{RTAUDIO\_\-SINT24}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf RTAUDIO\_\-FORMAT} Rt\-Audio::RTAUDIO\_\-SINT24\hspace{0.3cm}{\tt [static]}}\label{classRtAudio_p2}


Upper 3 bytes of 32-bit integer. \index{RtAudio@{Rt\-Audio}!RTAUDIO_SINT32@{RTAUDIO\_\-SINT32}}
\index{RTAUDIO_SINT32@{RTAUDIO\_\-SINT32}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf RTAUDIO\_\-FORMAT} Rt\-Audio::RTAUDIO\_\-SINT32\hspace{0.3cm}{\tt [static]}}\label{classRtAudio_p3}


\index{RtAudio@{Rt\-Audio}!RTAUDIO_FLOAT32@{RTAUDIO\_\-FLOAT32}}
\index{RTAUDIO_FLOAT32@{RTAUDIO\_\-FLOAT32}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf RTAUDIO\_\-FORMAT} Rt\-Audio::RTAUDIO\_\-FLOAT32\hspace{0.3cm}{\tt [static]}}\label{classRtAudio_p4}


Normalized between plus/minus 1.0. \index{RtAudio@{Rt\-Audio}!RTAUDIO_FLOAT64@{RTAUDIO\_\-FLOAT64}}
\index{RTAUDIO_FLOAT64@{RTAUDIO\_\-FLOAT64}!RtAudio@{Rt\-Audio}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf RTAUDIO\_\-FORMAT} Rt\-Audio::RTAUDIO\_\-FLOAT64\hspace{0.3cm}{\tt [static]}}\label{classRtAudio_p5}


Normalized between plus/minus 1.0.

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
{\bf Rt\-Audio.h}\end{CompactItemize}

+ 135
- 0
doc/latex/classRtAudioError.tex View File

@@ -0,0 +1,135 @@
\section{Rt\-Audio\-Error Class Reference}
\label{classRtAudioError}\index{RtAudioError@{Rt\-Audio\-Error}}
{\tt \#include $<$Rt\-Audio.h$>$}

\subsection*{Public Types}
\begin{CompactItemize}
\item
enum {\bf TYPE} \{ {\bf WARNING},
{\bf DEBUG\_\-WARNING},
{\bf UNSPECIFIED},
{\bf NO\_\-DEVICES\_\-FOUND},
{\bf INVALID\_\-DEVICE},
{\bf INVALID\_\-STREAM},
{\bf MEMORY\_\-ERROR},
{\bf INVALID\_\-PARAMETER},
{\bf DRIVER\_\-ERROR},
{\bf SYSTEM\_\-ERROR},
{\bf THREAD\_\-ERROR}
\}
\end{CompactItemize}
\subsection*{Public Methods}
\begin{CompactItemize}
\item
{\bf Rt\-Audio\-Error} (const char $\ast$p, {\bf TYPE} tipe=Rt\-Audio\-Error::UNSPECIFIED)
\begin{CompactList}\small\item\em The constructor.\item\end{CompactList}\item
virtual {\bf $\sim$Rt\-Audio\-Error} (void)
\begin{CompactList}\small\item\em The destructor.\item\end{CompactList}\item
virtual void {\bf print\-Message} (void)
\begin{CompactList}\small\item\em Prints \char`\"{}thrown\char`\"{} error message to stdout.\item\end{CompactList}\item
virtual const {\bf TYPE}\& {\bf get\-Type} (void)
\begin{CompactList}\small\item\em Returns the \char`\"{}thrown\char`\"{} error message TYPE.\item\end{CompactList}\item
virtual const char$\ast$ {\bf get\-Message} (void)
\begin{CompactList}\small\item\em Returns the \char`\"{}thrown\char`\"{} error message string.\item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item
char {\bf error\_\-message} [256]
\item
{\bf TYPE} {\bf type}
\end{CompactItemize}


\subsection{Member Enumeration Documentation}
\index{RtAudioError@{Rt\-Audio\-Error}!TYPE@{TYPE}}
\index{TYPE@{TYPE}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum Rt\-Audio\-Error::TYPE}\label{classRtAudioError_s11}


\begin{Desc}
\item[{\bf Enumeration values:}]\par
\begin{description}
\index{WARNING@{WARNING}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!WARNING@{WARNING}}\item[
{\em WARNING}\label{classRtAudioError_s11s0}
]\index{DEBUG_WARNING@{DEBUG\_\-WARNING}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!DEBUG_WARNING@{DEBUG\_\-WARNING}}\item[
{\em DEBUG\_\-WARNING}\label{classRtAudioError_s11s1}
]\index{UNSPECIFIED@{UNSPECIFIED}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!UNSPECIFIED@{UNSPECIFIED}}\item[
{\em UNSPECIFIED}\label{classRtAudioError_s11s2}
]\index{NO_DEVICES_FOUND@{NO\_\-DEVICES\_\-FOUND}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!NO_DEVICES_FOUND@{NO\_\-DEVICES\_\-FOUND}}\item[
{\em NO\_\-DEVICES\_\-FOUND}\label{classRtAudioError_s11s3}
]\index{INVALID_DEVICE@{INVALID\_\-DEVICE}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!INVALID_DEVICE@{INVALID\_\-DEVICE}}\item[
{\em INVALID\_\-DEVICE}\label{classRtAudioError_s11s4}
]\index{INVALID_STREAM@{INVALID\_\-STREAM}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!INVALID_STREAM@{INVALID\_\-STREAM}}\item[
{\em INVALID\_\-STREAM}\label{classRtAudioError_s11s5}
]\index{MEMORY_ERROR@{MEMORY\_\-ERROR}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!MEMORY_ERROR@{MEMORY\_\-ERROR}}\item[
{\em MEMORY\_\-ERROR}\label{classRtAudioError_s11s6}
]\index{INVALID_PARAMETER@{INVALID\_\-PARAMETER}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!INVALID_PARAMETER@{INVALID\_\-PARAMETER}}\item[
{\em INVALID\_\-PARAMETER}\label{classRtAudioError_s11s7}
]\index{DRIVER_ERROR@{DRIVER\_\-ERROR}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!DRIVER_ERROR@{DRIVER\_\-ERROR}}\item[
{\em DRIVER\_\-ERROR}\label{classRtAudioError_s11s8}
]\index{SYSTEM_ERROR@{SYSTEM\_\-ERROR}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!SYSTEM_ERROR@{SYSTEM\_\-ERROR}}\item[
{\em SYSTEM\_\-ERROR}\label{classRtAudioError_s11s9}
]\index{THREAD_ERROR@{THREAD\_\-ERROR}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!THREAD_ERROR@{THREAD\_\-ERROR}}\item[
{\em THREAD\_\-ERROR}\label{classRtAudioError_s11s10}
]\end{description}
\end{Desc}



\subsection{Constructor \& Destructor Documentation}
\index{RtAudioError@{Rt\-Audio\-Error}!RtAudioError@{RtAudioError}}
\index{RtAudioError@{RtAudioError}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Rt\-Audio\-Error::Rt\-Audio\-Error (const char $\ast$ {\em p}, {\bf TYPE} {\em tipe} = Rt\-Audio\-Error::UNSPECIFIED)}\label{classRtAudioError_a0}


The constructor.

\index{RtAudioError@{Rt\-Audio\-Error}!~RtAudioError@{$\sim$RtAudioError}}
\index{~RtAudioError@{$\sim$RtAudioError}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Rt\-Audio\-Error::$\sim$Rt\-Audio\-Error (void)\hspace{0.3cm}{\tt [virtual]}}\label{classRtAudioError_a1}


The destructor.



\subsection{Member Function Documentation}
\index{RtAudioError@{Rt\-Audio\-Error}!printMessage@{printMessage}}
\index{printMessage@{printMessage}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Rt\-Audio\-Error::print\-Message (void)\hspace{0.3cm}{\tt [virtual]}}\label{classRtAudioError_a2}


Prints \char`\"{}thrown\char`\"{} error message to stdout.

\index{RtAudioError@{Rt\-Audio\-Error}!getType@{getType}}
\index{getType@{getType}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf TYPE} \& Rt\-Audio\-Error::get\-Type (void)\hspace{0.3cm}{\tt [inline, virtual]}}\label{classRtAudioError_a3}


Returns the \char`\"{}thrown\char`\"{} error message TYPE.

\index{RtAudioError@{Rt\-Audio\-Error}!getMessage@{getMessage}}
\index{getMessage@{getMessage}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ Rt\-Audio\-Error::get\-Message (void)\hspace{0.3cm}{\tt [inline, virtual]}}\label{classRtAudioError_a4}


Returns the \char`\"{}thrown\char`\"{} error message string.



\subsection{Member Data Documentation}
\index{RtAudioError@{Rt\-Audio\-Error}!error_message@{error\_\-message}}
\index{error_message@{error\_\-message}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char Rt\-Audio\-Error::error\_\-message\hspace{0.3cm}{\tt [protected]}}\label{classRtAudioError_n0}


\index{RtAudioError@{Rt\-Audio\-Error}!type@{type}}
\index{type@{type}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf TYPE} Rt\-Audio\-Error::type\hspace{0.3cm}{\tt [protected]}}\label{classRtAudioError_n1}




The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
{\bf Rt\-Audio.h}\end{CompactItemize}

+ 65
- 0
doc/latex/doxygen.sty View File

@@ -0,0 +1,65 @@
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{doxygen}
\RequirePackage{calc}
\RequirePackage{array}
\pagestyle{fancyplain}
\addtolength{\headwidth}{\marginparsep}
\addtolength{\headwidth}{\marginparwidth}
\newcommand{\clearemptydoublepage}{\newpage{\pagestyle{empty}\cleardoublepage}}
\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
\renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}}
\lhead[\fancyplain{}{\bfseries\thepage}]
{\fancyplain{}{\bfseries\rightmark}}
\rhead[\fancyplain{}{\bfseries\leftmark}]
{\fancyplain{}{\bfseries\thepage}}
\rfoot[\fancyplain{}{\bfseries\scriptsize Generated at Tue Jan 22 15:27:40 2002 for Rt\-Audio by Doxygen written by Dimitri van Heesch \copyright~1997-2001}]{}
\lfoot[]{\fancyplain{}{\bfseries\scriptsize Generated at Tue Jan 22 15:27:40 2002 for Rt\-Audio by Doxygen written by Dimitri van Heesch \copyright~1997-2001}}
\cfoot{}
\newenvironment{CompactList}
{\begin{list}{}{
\setlength{\leftmargin}{0.5cm}
\setlength{\itemsep}{0pt}
\setlength{\parsep}{0pt}
\setlength{\topsep}{0pt}
\renewcommand{\makelabel}{}}}
{\end{list}}
\newenvironment{CompactItemize}
{
\begin{itemize}
\setlength{\itemsep}{-3pt}
\setlength{\parsep}{0pt}
\setlength{\topsep}{0pt}
\setlength{\partopsep}{0pt}
}
{\end{itemize}}
\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
\newlength{\tmplength}
\newenvironment{TabularC}[1]
{
\setlength{\tmplength}
{\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}
\par\begin{tabular*}{\linewidth}
{*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}
}
{\end{tabular*}\par}
\newcommand{\entrylabel}[1]{
{\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\\}}}
\newenvironment{Desc}
{\begin{list}{}
{
\settowidth{\labelwidth}{40pt}
\setlength{\leftmargin}{\labelwidth}
\setlength{\parsep}{0pt}
\setlength{\itemsep}{-4pt}
\renewcommand{\makelabel}{\entrylabel}
}
}
{\end{list}}
\newenvironment{Indent}
{\begin{list}{}{\setlength{\leftmargin}{0.5cm}}
\item[]\ignorespaces}
{\unskip\end{list}}
\setlength{\parindent}{0cm}
\setlength{\parskip}{0.2cm}
\addtocounter{secnumdepth}{1}
\sloppy

+ 4
- 0
doc/latex/files.tex View File

@@ -0,0 +1,4 @@
\section{Rt\-Audio File List}
Here is a list of all files with brief descriptions:\begin{CompactList}
\item\contentsline{section}{{\bf Rt\-Audio.h} }{\pageref{RtAudio_8h}}{}
\end{CompactList}

+ 595
- 0
doc/latex/index.tex View File

@@ -0,0 +1,595 @@

\begin{center}
{\bf Introduction} {\rm (p.\,\pageref{intro})} \ \ {\bf Download} {\rm (p.\,\pageref{download})} \ \ {\bf Getting Started} {\rm (p.\,\pageref{start})} \ \ {\bf Error Handling} {\rm (p.\,\pageref{error})} \ \ {\bf Probing Device Capabilities} {\rm (p.\,\pageref{probing})} \ \ {\bf Device Settings} {\rm (p.\,\pageref{settings})} \ \ {\bf Playback (blocking functionality)} {\rm (p.\,\pageref{playbackb})} \ \ {\bf Playback (callback functionality)} {\rm (p.\,\pageref{playbackc})} \ \ {\bf Recording} {\rm (p.\,\pageref{recording})} \ \ {\bf Duplex Mode} {\rm (p.\,\pageref{duplex})} \ \ {\bf Summary of Methods} {\rm (p.\,\pageref{methods})} \ \ {\bf Compiling} {\rm (p.\,\pageref{compiling})} \ \ {\bf OS Notes} {\rm (p.\,\pageref{osnotes})} \ \ {\bf Acknowledgments} {\rm (p.\,\pageref{acknowledge})} \end{center}


\section{Introduction}\label{intro}


{\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} is a C++ class which provides a common API (Application Programming Interface) for realtime audio input/output across Linux (native ALSA and OSS), SGI, and Windows operating systems. {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} significantly simplifies the process of interacting with computer audio hardware. It was designed with the following goals:

\begin{CompactItemize}
\item
object oriented C++ design \item
simple, common API across all supported platforms \item
single independent header and source file for easy inclusion in programming projects (no libraries!) \item
blocking functionality \item
callback functionality \item
extensive audio device parameter control \item
audio device capability probing \item
automatic internal conversion for data format, channel number compensation, de-interleaving, and byte-swapping \item
control over multiple audio streams and devices with a single instance \end{CompactItemize}


{\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} incorporates the concept of audio streams, which represent audio output (playback) and/or input (recording). Available audio devices and their capabilities can be enumerated and then specified when opening a stream. Multiple streams can run at the same time and, when allowed by the underlying audio API, a single device can serve multiple streams.

The {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} API provides both blocking (synchronous) and callback (asynchronous) functionality. Callbacks are typically used in conjunction with graphical user interfaces (GUI). Blocking functionality is often necessary for explicit control of multiple input/output stream synchronization or when audio must be synchronized with other system events.

\section{Download}\label{download}


Latest Release (22 January 2002): {\tt Version 2.0 (111 k\-B tar/gzipped)}

\section{Getting Started}\label{start}


The first thing that must be done when using {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} is to create an instance of the class. The default constructor {\bf Rt\-Audio::Rt\-Audio}() {\rm (p.\,\pageref{classRtAudio_a0})} scans the underlying audio system to verify that at least one device is available. {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} often uses C++ exceptions to report errors, necessitating try/catch blocks around most member functions. The following code example demonstrates default object construction and destruction:

\footnotesize\begin{verbatim}#include "RtAudio.h"

int main()
{
RtAudio *audio;

// Default RtAudio constructor
try {
audio = new RtAudio();
}
catch (RtAudioError &error) {
// Handle the exception here
}

// Clean up
delete audio;
}\end{verbatim}\normalsize


Obviously, this example doesn't demonstrate any of the real functionality of {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})}. However, all uses of {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} must begin with a constructor (either default or overloaded varieties) and must end with class destruction. Further, it is necessary that all class methods which can throw a C++ exception be called within a try/catch block.

\section{Error Handling}\label{error}


{\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} uses a C++ exception handler called {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})}, which is declared and defined within the {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} class files. The {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} class is quite simple but it does allow errors to be \char`\"{}caught\char`\"{} by {\bf Rt\-Audio\-Error::TYPE} {\rm (p.\,\pageref{classRtAudioError_s11})}. Almost all {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} methods can \char`\"{}throw\char`\"{} an {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})}, most typically if an invalid stream identifier is supplied to a method or a driver error occurs. There are a number of cases within {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} where warning messages may be displayed but an exception is not thrown. There is a private {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} method, error(), which can be modified to globally control how these messages are handled and reported.

\section{Probing Device Capabilities}\label{probing}


A programmer may wish to query the available audio device capabilities before deciding which to use. The following example outlines how this can be done.

\footnotesize\begin{verbatim}// probe.cpp

#include <iostream.h>
#include "RtAudio.h"

int main()
{
RtAudio *audio;

// Default RtAudio constructor
try {
audio = new RtAudio();
}
catch (RtAudioError &error) {
error.printMessage();
exit(EXIT_FAILURE);
}

// Determine the number of devices available
int devices = audio->getDeviceCount();

// Scan through devices for various capabilities
RtAudio::RTAUDIO_DEVICE info;
for (int i=0; i<devices; i++) {

try {
audio->getDeviceInfo(i, &info);
}
catch (RtAudioError &error) {
error.printMessage();
break;
}

// Print, for example, the maximum number of output channels for each device
cout << "device = " << i;
cout << ": maximum output channels = " << info.maxOutputChannels << endl;
}

// Clean up
delete audio;

return 0;
}\end{verbatim}\normalsize


The RTAUDIO\_\-DEVICE structure is defined in {\bf Rt\-Audio.h} and provides a variety of information useful in assessing the capabilities of a device:

\footnotesize\begin{verbatim} typedef struct {
char name[128];
DEVICE_ID id[2]; // No value reported by getDeviceInfo().
bool probed; // true if the device probe was successful.
int maxOutputChannels;
int maxInputChannels;
int maxDuplexChannels;
int minOutputChannels;
int minInputChannels;
int minDuplexChannels;
bool hasDuplexSupport; // true if duplex supported
int nSampleRates; // Number of discrete rates, or -1 if range supported.
double sampleRates[MAX_SAMPLE_RATES]; // Supported sample rates, or {min, max} if range.
RTAUDIO_FORMAT nativeFormats;
} RTAUDIO_DEVICE;\end{verbatim}\normalsize


The following data formats are defined and fully supported by {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})}:

\footnotesize\begin{verbatim} typedef unsigned long RTAUDIO_FORMAT;
static const RTAUDIO_FORMAT RTAUDIO_SINT8; // Signed 8-bit integer
static const RTAUDIO_FORMAT RTAUDIO_SINT16; // Signed 16-bit integer
static const RTAUDIO_FORMAT RTAUDIO_SINT24; // Signed 24-bit integer
static const RTAUDIO_FORMAT RTAUDIO_SINT32; // Signed 32-bit integer
static const RTAUDIO_FORMAT RTAUDIO_FLOAT32; // 32-bit float
static const RTAUDIO_FORMAT RTAUDIO_FLOAT64; // 64-bit double\end{verbatim}\normalsize


The {\em native\-Formats} member of the {\bf Rt\-Audio::RTAUDIO\_\-DEVICE} {\rm (p.\,\pageref{structRtAudio_1_1RTAUDIO__DEVICE})} structure is a bit mask of the above formats which are natively supported by the device. However, {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} will automatically provide format conversion if a particular format is not natively supported. When the {\em probed} member of the RTAUDIO\_\-DEVICE structure is false, the remaining structure members are likely unknown and the device is probably unusable.

In general, the user need not be concerned with the minimum channel values reported in the RTAUDIO\_\-DEVICE structure. While some audio devices may require a minimum channel value $>$ 1, {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} will provide automatic channel number compensation when the number of channels set by the user is less than that required by the device. Channel compensation is {\em NOT} possible when the number of channels set by the user is greater than that supported by the device.

It should be noted that the capabilities reported by a device driver or underlying audio API are not always accurate and/or may be dependent on a combination of device settings.

\section{Device Settings}\label{settings}


The next step in using {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} is to open a stream with a particular set of device settings.

\footnotesize\begin{verbatim}#include "RtAudio.h"

int main()
{
int channels = 2;
int sample_rate = 44100;
int buffer_size = 256; // 256 sample frames
int n_buffers = 4; // number of internal buffers used by device
int device = 0; // 0 indicates the default or first available device
int stream; // our stream identifier
RtAudio *audio;

// Instantiate RtAudio and open a stream within a try/catch block
try {
audio = new RtAudio();
stream = audio->openStream(device, channels, 0, 0, RtAudio::RTAUDIO_FLOAT32,
sample_rate, &buffer_size, n_buffers);
}
catch (RtAudioError &error) {
error.printMessage();
exit(EXIT_FAILURE);
}

// Clean up
delete audio;

return 0;
}\end{verbatim}\normalsize


The {\bf Rt\-Audio::open\-Stream}() {\rm (p.\,\pageref{classRtAudio_a3})} method attempts to open a stream with a specified set of parameter values. When successful, a stream identifier is returned. In this case, we attempt to open a playback stream on device 0 with two channels, 32-bit floating point data, a sample rate of 44100 Hz, a frame rate of 256 sample frames per read/write, and 4 internal device buffers. When device = 0, {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} first attempts to open the default audio device with the given parameters. If that attempt fails, an attempt is made to find a device or set of devices which will meet the given parameters. If all attempts are unsuccessful, an {\bf Rt\-Audio\-Error} {\rm (p.\,\pageref{classRtAudioError})} is thrown. When a non-zero device value is specified, an attempt is made to open that device only.

{\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} provides four signed integer and two floating point data formats which can be specified using the {\bf Rt\-Audio::RTAUDIO\_\-FORMAT} {\rm (p.\,\pageref{classRtAudio_s0})} parameter values mentioned earlier. If the opened device does not natively support the given format, {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} will automatically perform the necessary data format conversion.

Buffer sizes in {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} are {\em ALWAYS} given in sample frame units. For example, if you open an output stream with 4 channels and set {\em buffer\-Size} to 512, you will have to write 2048 samples of data to the output buffer within your callback or between calls to {\bf Rt\-Audio::tick\-Stream}() {\rm (p.\,\pageref{classRtAudio_a9})}. In this case, a single sample frame of data contains 4 samples of data.

The {\em buffer\-Size} parameter specifies the desired number of sample frames which will be written to and/or read from a device per write/read operation. The {\em n\-Buffers} parameter is used in setting the underlying device buffer parameters. Both the {\em buffer\-Size} and {\em n\-Buffers} parameters can be used to control stream latency though there is no guarantee that the passed values will be those used by a device. In general, lower values for both parameters will produce less latency but perhaps less robust performance. Both parameters can be specified with values of zero, in which case the smallest allowable values will be used. The {\em buffer\-Size} parameter is passed as a pointer and the actual value used by the stream is set during the device setup procedure. {\em buffer\-Size} values should be a power of two. Optimal and allowable buffer values tend to vary between systems and devices. Check the {\bf OS Notes} {\rm (p.\,\pageref{osnotes})} section for general guidelines.

As noted earlier, the device capabilities reported by a driver or underlying audio API are not always accurate and/or may be dependent on a combination of device settings. Because of this, {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} does not attempt to query a device's capabilities or use previously reported values when opening a device. Instead, {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} simply attempts to set the given parameters on a specified device and then checks whether the setup is successful or not.

\section{Playback (blocking functionality)}\label{playbackb}


Once the device is open for playback, there are only a few final steps necessary for realtime audio output. We'll first provide an example (blocking functionality) and then discuss the details.

\footnotesize\begin{verbatim}// playback.cpp

#include "RtAudio.h"

int main()
{
int count;
int channels = 2;
int sample_rate = 44100;
int buffer_size = 256; // 256 sample frames
int n_buffers = 4; // number of internal buffers used by device
float *buffer;
int device = 0; // 0 indicates the default or first available device
int stream; // our stream identifier
RtAudio *audio;

// Open a stream during RtAudio instantiation
try {
audio = new RtAudio(&stream, device, channels, 0, 0, RtAudio::RTAUDIO_FLOAT32,
sample_rate, &buffer_size, n_buffers);
}
catch (RtAudioError &error) {
error.printMessage();
exit(EXIT_FAILURE);
}

try {
// Get a pointer to the stream buffer
buffer = (float *) audio->getStreamBuffer(stream);

// Start the stream
audio->startStream(stream);
}
catch (RtAudioError &error) {
error.printMessage();
goto cleanup;
}

// An example loop which runs for about 40000 sample frames
count = 0;
while (count < 40000) {
// Generate your samples and fill the buffer with buffer_size sample frames of data
...

// Trigger the output of the data buffer
try {
audio->tickStream(stream);
}
catch (RtAudioError &error) {
error.printMessage();
goto cleanup;
}

count += buffer_size;
}

try {
// Stop and close the stream
audio->stopStream(stream);
audio->closeStream(stream);
}
catch (RtAudioError &error) {
error.printMessage();
}

cleanup:
delete audio;

return 0;
}\end{verbatim}\normalsize


The first thing to notice in this example is that we attempt to open a stream during class instantiation with an overloaded constructor. This constructor simply combines the functionality of the default constructor, used earlier, and the {\bf Rt\-Audio::open\-Stream}() {\rm (p.\,\pageref{classRtAudio_a3})} method. Again, we have specified a device value of 0, indicating that the default or first available device meeting the given parameters should be used. The integer identifier of the opened stream is returned via the {\em stream} pointer value. An attempt is made to open the stream with the specified {\em buffer\-Size} value. However, it is possible that the device will not accept this value, in which case the closest allowable size is used and returned via the pointer value. The constructor can fail if no available devices are found, or a memory allocation or device driver error occurs. Note that you should not call the {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} destructor if an exception is thrown during instantiation.

Because {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} can be used to simultaneously control more than a single stream, it is necessary that the stream identifier be provided to nearly all public methods. Assuming the constructor is successful, it is necessary to get a pointer to the buffer, provided by {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})}, for use in feeding data to/from the opened stream. Note that the user should {\em NOT} attempt to deallocate the stream buffer memory ... memory management for the stream buffer will be automatically controlled by {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})}. After starting the stream with {\bf Rt\-Audio::start\-Stream}() {\rm (p.\,\pageref{classRtAudio_a11})}, one simply fills that buffer, which is of length equal to the returned {\em buffer\-Size} value, with interleaved audio data (in the specified format) for playback. Finally, a call to the {\bf Rt\-Audio::tick\-Stream}() {\rm (p.\,\pageref{classRtAudio_a9})} routine triggers a blocking write call for the stream.

In general, one should call the {\bf Rt\-Audio::stop\-Stream}() {\rm (p.\,\pageref{classRtAudio_a12})} and {\bf Rt\-Audio::close\-Stream}() {\rm (p.\,\pageref{classRtAudio_a10})} methods after finishing with a stream. However, both methods will implicitly be called during object destruction if necessary.

\section{Playback (callback functionality)}\label{playbackc}


The primary difference in using {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} with callback functionality involves the creation of a user-defined callback function. Here is an example which produces a sawtooth waveform for playback.

\footnotesize\begin{verbatim}#include <iostream.h>
#include "RtAudio.h"

// Two-channel sawtooth wave generator.
int sawtooth(char *buffer, int buffer_size, void *data)
{
int i, j;
double *my_buffer = (double *) buffer;
double *my_data = (double *) data;

// Write interleaved audio data.
for (i=0; i<buffer_size; i++) {
for (j=0; j<2; j++) {
*my_buffer++ = my_data[j];

my_data[j] += 0.005 * (j+1+(j*0.1));
if (my_data[j] >= 1.0) my_data[j] -= 2.0;
}
}

return 0;
}

int main()
{
int channels = 2;
int sample_rate = 44100;
int buffer_size = 256; // 256 sample frames
int n_buffers = 4; // number of internal buffers used by device
int device = 0; // 0 indicates the default or first available device
int stream; // our stream identifier
double data[2];
char input;
RtAudio *audio;

// Open a stream during RtAudio instantiation
try {
audio = new RtAudio(&stream, device, channels, 0, 0, RtAudio::RTAUDIO_FLOAT64,
sample_rate, &buffer_size, n_buffers);
}
catch (RtAudioError &error) {
error.printMessage();
exit(EXIT_FAILURE);
}

try {
// Set the stream callback function
audio->setStreamCallback(stream, &sawtooth, (void *)data);

// Start the stream
audio->startStream(stream);
}
catch (RtAudioError &error) {
error.printMessage();
goto cleanup;
}

cout << "\nPlaying ... press <enter> to quit.\n";
cin.get(input);

try {
// Stop and close the stream
audio->stopStream(stream);
audio->closeStream(stream);
}
catch (RtAudioError &error) {
error.printMessage();
}

cleanup:
delete audio;

return 0;
}\end{verbatim}\normalsize


After opening the device in exactly the same way as the previous example (except with a data format change), we must set our callback function for the stream using {\bf Rt\-Audio::set\-Stream\-Callback}() {\rm (p.\,\pageref{classRtAudio_a4})}. This method will spawn a new process (or thread) which automatically calls the callback function when more data is needed. Note that the callback function is called only when the stream is \char`\"{}running\char`\"{} (between calls to the {\bf Rt\-Audio::start\-Stream}() {\rm (p.\,\pageref{classRtAudio_a11})} and {\bf Rt\-Audio::stop\-Stream}() {\rm (p.\,\pageref{classRtAudio_a12})} methods). The last argument to {\bf Rt\-Audio::set\-Stream\-Callback}() {\rm (p.\,\pageref{classRtAudio_a4})} is a pointer to arbitrary data that you wish to access from within your callback function.

In this example, we stop the stream with an explicit call to {\bf Rt\-Audio::stop\-Stream}() {\rm (p.\,\pageref{classRtAudio_a12})}. When using callback functionality, it is also possible to stop a stream by returning a non-zero value from the callback function.

Once set with {\bf Rt\-Audio::set\-Stream\-Callback} {\rm (p.\,\pageref{classRtAudio_a4})}, the callback process will continue to run for the life of the stream (until the stream is closed with {\bf Rt\-Audio::close\-Stream}() {\rm (p.\,\pageref{classRtAudio_a10})} or the {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} instance is deleted). It is possible to disassociate a callback function and cancel its process for an open stream using the {\bf Rt\-Audio::cancel\-Stream\-Callback}() {\rm (p.\,\pageref{classRtAudio_a5})} method. The stream can then be used with blocking functionality or a new callback can be associated with it.

\section{Recording}\label{recording}


Using {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} for audio input is almost identical to the way it is used for playback. Here's the blocking playback example rewritten for recording:

\footnotesize\begin{verbatim}// record.cpp

#include "RtAudio.h"

int main()
{
int count;
int channels = 2;
int sample_rate = 44100;
int buffer_size = 256; // 256 sample frames
int n_buffers = 4; // number of internal buffers used by device
float *buffer;
int device = 0; // 0 indicates the default or first available device
int stream; // our stream identifier
RtAudio *audio;

// Instantiate RtAudio and open a stream.
try {
audio = new RtAudio(&stream, 0, 0, device, channels,
RtAudio::RTAUDIO_FLOAT32, sample_rate, &buffer_size, n_buffers);
}
catch (RtAudioError &error) {
error.printMessage();
exit(EXIT_FAILURE);
}

try {
// Get a pointer to the stream buffer
buffer = (float *) audio->getStreamBuffer(stream);

// Start the stream
audio->startStream(stream);
}
catch (RtAudioError &error) {
error.printMessage();
goto cleanup;
}

// An example loop which runs for about 40000 sample frames
count = 0;
while (count < 40000) {

// Read a buffer of data
try {
audio->tickStream(stream);
}
catch (RtAudioError &error) {
error.printMessage();
goto cleanup;
}

// Process the input samples (buffer_size sample frames) that were read
...

count += buffer_size;
}

try {
// Stop the stream
audio->stopStream(stream);
}
catch (RtAudioError &error) {
error.printMessage();
}

cleanup:
delete audio;

return 0;
}\end{verbatim}\normalsize


In this example, the stream was opened for recording with a non-zero {\em input\-Channels} value. The only other difference between this example and that for playback involves the order of data processing in the loop, where it is necessary to first read a buffer of input data before manipulating it.

\section{Duplex Mode}\label{duplex}


Finally, it is easy to use {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} for simultaneous audio input/output, or duplex operation. In this example, we use a callback function and pass our recorded data directly through for playback.

\footnotesize\begin{verbatim}// duplex.cpp

#include <iostream.h>
#include "RtAudio.h"

// Pass-through function.
int pass(char *buffer, int buffer_size, void *)
{
// Surprise!! We do nothing to pass the data through.
return 0;
}

int main()
{
int channels = 2;
int sample_rate = 44100;
int buffer_size = 256; // 256 sample frames
int n_buffers = 4; // number of internal buffers used by device
int device = 0; // 0 indicates the default or first available device
int stream; // our stream identifier
double data[2];
char input;
RtAudio *audio;

// Open a stream during RtAudio instantiation
try {
audio = new RtAudio(&stream, device, channels, device, channels, RtAudio::RTAUDIO_FLOAT64,
sample_rate, &buffer_size, n_buffers);
}
catch (RtAudioError &error) {
error.printMessage();
exit(EXIT_FAILURE);
}

try {
// Set the stream callback function
audio->setStreamCallback(stream, &pass, NULL);

// Start the stream
audio->startStream(stream);
}
catch (RtAudioError &error) {
error.printMessage();
goto cleanup;
}

cout << "\nRunning duplex ... press <enter> to quit.\n";
cin.get(input);

try {
// Stop and close the stream
audio->stopStream(stream);
audio->closeStream(stream);
}
catch (RtAudioError &error) {
error.printMessage();
}

cleanup:
delete audio;

return 0;
}\end{verbatim}\normalsize


When an {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} stream is running in duplex mode (nonzero input {\em AND} output channels), the audio write (playback) operation always occurs before the audio read (record) operation. This sequence allows the use of a single buffer to store both output and input data.

As we see with this example, the write-read sequence of operations does not preclude the use of {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} in situations where input data is first processed and then output through a duplex stream. When the stream buffer is first allocated, it is initialized with zeros, which produces no audible result when output to the device. In this example, anything recorded by the audio stream input will be played out during the next round of audio processing.

Note that duplex operation can also be achieved by opening one output stream and one input stream using the same or different devices. However, there may be timing problems when attempting to use two different devices, due to possible device clock variations. This becomes even more difficult to achieve using two separate callback streams because it is not possible to explicitly control the calling order of the callback functions.

\section{Summary of Methods}\label{methods}


The following is short summary of public methods (not including constructors and the destructor) provided by {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})}:

\begin{CompactItemize}
\item
{\bf Rt\-Audio::open\-Stream}() {\rm (p.\,\pageref{classRtAudio_a3})}: opens a stream with the specified parameters. \item
{\bf Rt\-Audio::set\-Stream\-Callback}() {\rm (p.\,\pageref{classRtAudio_a4})}: sets a user-defined callback function for a given stream. \item
{\bf Rt\-Audio::cancel\-Stream\-Callback}() {\rm (p.\,\pageref{classRtAudio_a5})}: cancels a callback process and function for a given stream. \item
{\bf Rt\-Audio::get\-Device\-Count}() {\rm (p.\,\pageref{classRtAudio_a6})}: returns the number of audio devices available. \item
{\bf Rt\-Audio::get\-Device\-Info}() {\rm (p.\,\pageref{classRtAudio_a7})}: fills a user-supplied RTAUDIO\_\-DEVICE structure for a specified device. \item
{\bf Rt\-Audio::get\-Stream\-Buffer}() {\rm (p.\,\pageref{classRtAudio_a8})}: returns a pointer to the stream buffer. \item
{\bf Rt\-Audio::tick\-Stream}() {\rm (p.\,\pageref{classRtAudio_a9})}: triggers processing of input/output data for a stream (blocking). \item
{\bf Rt\-Audio::close\-Stream}() {\rm (p.\,\pageref{classRtAudio_a10})}: closes the specified stream (implicitly called during object destruction). Once a stream is closed, the stream identifier is invalid and should not be used in calling any other {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} methods. \item
{\bf Rt\-Audio::start\-Stream}() {\rm (p.\,\pageref{classRtAudio_a11})}: (re)starts the specified stream, typically after it has been stopped with either stop\-Stream() or abort\-Stream() or after first opening the stream. \item
{\bf Rt\-Audio::stop\-Stream}() {\rm (p.\,\pageref{classRtAudio_a12})}: stops the specified stream, allowing any remaining samples in the queue to be played out and/or read in. This does not implicitly call {\bf Rt\-Audio::close\-Stream}() {\rm (p.\,\pageref{classRtAudio_a10})}. \item
{\bf Rt\-Audio::abort\-Stream}() {\rm (p.\,\pageref{classRtAudio_a13})}: stops the specified stream, discarding any remaining samples in the queue. This does not implicitly call close\-Stream(). \item
{\bf Rt\-Audio::stream\-Will\-Block}() {\rm (p.\,\pageref{classRtAudio_a14})}: queries a stream to determine whether a call to the {\em tick\-Stream()} method will block. A return value of 0 indicates that the stream will NOT block. A positive return value indicates the number of sample frames that cannot yet be processed without blocking. \end{CompactItemize}


\section{Compiling}\label{compiling}


In order to compile {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} for a specific OS and audio API, it is necessary to supply the appropriate preprocessor definition and library within the compiler statement:



\begin{TabularC}{5}
\hline
{\bf OS:} &{\bf Audio API:} &{\bf Preprocessor Definition:} &{\bf Library:} &{\bf Example Compiler Statement:} \\\hline
Linux &ALSA &\_\-\_\-LINUX\_\-ALSA\_\- &{\tt libasound, libpthread} &{\tt g++ -Wall -D\_\-\_\-LINUX\_\-ALSA\_\- -o probe probe.cpp Rt\-Audio.cpp -lasound -lpthread} \\\hline
Linux &OSS &\_\-\_\-LINUX\_\-OSS\_\- &{\tt libpthread} &{\tt g++ -Wall -D\_\-\_\-LINUX\_\-OSS\_\- -o probe probe.cpp Rt\-Audio.cpp -lpthread} \\\hline
Irix &AL &\_\-\_\-IRIX\_\-AL\_\- &{\tt libaudio, libpthread} &{\tt CC -Wall -D\_\-\_\-IRIX\_\-AL\_\- -o probe probe.cpp Rt\-Audio.cpp -laudio -lpthread} \\\hline
Windows &Direct Sound &\_\-\_\-WINDOWS\_\-DS\_\- &{\tt dsound.lib (ver. 5.0 or higher), multithreaded} &{\em compiler specific} \\\hline
\end{TabularC}



The example compiler statements above could be used to compile the {\tt probe.cpp} example file, assuming that {\tt probe.cpp}, {\tt {\bf Rt\-Audio.h}}, and {\tt Rt\-Audio.cpp} all exist in the same directory.

\section{OS Notes}\label{osnotes}


{\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} is designed to provide a common API across the various supported operating systems and audio libraries. Despite that, however, some issues need to be mentioned with regard to each.

\subsection{Linux:}\label{linux}


{\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} for Linux was developed under Redhat distributions 7.0 - 7.2. Two different audio APIs are supported on Linux platforms: OSS and {\tt ALSA}. The OSS API has existed for at least 6 years and the Linux kernel is distributed with free versions of OSS audio drivers. Therefore, a generic Linux system is most likely to have OSS support. The ALSA API is relatively new and at this time is not part of the Linux kernel distribution. Work is in progress to make ALSA part of the 2.5 development kernel series. Despite that, the ALSA API offers significantly better functionality than the OSS API. {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} provides support for the 0.9 and higher versions of ALSA. Input/output latency on the order of 15-20 milliseconds can typically be achieved under both OSS or ALSA by fine-tuning the {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} buffer parameters (without kernel modifications). Latencies on the order of 5 milliseconds or less can be achieved using a low-latency kernel patch and increasing FIFO scheduling priority. The pthread library, which is used for callback functionality, is a standard component of all Linux distributions.

The ALSA library includes OSS emulation support. That means that you can run programs compiled for the OSS API even when using the ALSA drivers and library. It should be noted however that OSS emulation under ALSA is not perfect. Specifically, channel number queries seem to consistently produce invalid results. While OSS emulation is successful for the majority of {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} tests, it is recommended that the native ALSA implementation of {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} be used on systems which have ALSA drivers installed.

The ALSA implementation of {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} makes no use of the ALSA \char`\"{}plug\char`\"{} interface. All necessary data format conversions, channel compensation, deinterleaving, and byte-swapping is handled by internal {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} routines.

\subsection{Irix (SGI):}\label{irix}


The Irix version of {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} was written and tested on an SGI Indy running Irix version 6.5 and the newer \char`\"{}al\char`\"{} audio library. {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} does not compile under Irix version 6.3 because the C++ compiler is too old. Despite the relatively slow speed of the Indy, {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} was found to behave quite well and input/output latency was very good. No problems were found with respect to using the pthread library.

\subsection{Windows:}\label{windows}


{\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} under Windows is written using the Direct\-Sound API. In order to compile {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} under Windows, you must have the header and source files for Direct\-Sound version 0.5 or higher. As far as I know, you cannot compile {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} for Windows NT because there is not sufficient Direct\-Sound support. Audio output latency with Direct\-Sound can be reasonably good (on the order of 20 milliseconds). On the other hand, input audio latency tends to be terrible (100 milliseconds or more). Further, Direct\-Sound drivers tend to crash easily when experimenting with buffer parameters. On my system, I found it necessary to use values around n\-Buffers = 8 and buffer\-Size = 512 to avoid crashing my system. {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} was developed with Visual C++ version 6.0. I was forced in several instances to modify code in order to get it to compile under the non-standard version of C++ that Microsoft so unprofessionally implemented. We can only hope that the developers of Visual C++ 7.0 will have time to read the C++ standard.

\section{Acknowledgments}\label{acknowledge}


The {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} API incorporates many of the concepts developed in the {\tt Port\-Audio} project by Phil Burk and Ross Bencina. Early development also incorporated ideas from Bill Schottstaedt's {\tt sndlib}. The CCRMA {\tt Sound\-Wire group} provided valuable feedback during the API proposal stages.

{\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} was slowly developed over the course of many months while in residence at the {\tt Institut Universitari de L'Audiovisual (IUA)} in Barcelona, Spain, the {\tt Laboratory of Acoustics and Audio Signal Processing} at the Helsinki University of Technology, Finland, and the {\tt Center for Computer Research in Music and Acoustics (CCRMA)} at {\tt Stanford University}. This work was supported in part by the United States Air Force Office of Scientific Research (grant \#F49620-99-1-0293).

These documentation files were generated using {\tt doxygen} by Dimitri van Heesch.


+ 42
- 0
doc/latex/refman.tex View File

@@ -0,0 +1,42 @@
\documentclass[a4paper]{book}
\usepackage{a4wide}
\usepackage{makeidx}
\usepackage{fancyhdr}
\usepackage{graphicx}
\usepackage{float}
\usepackage{alltt}
\usepackage{doxygen}
\makeindex
\setcounter{tocdepth}{1}
\setlength{\footrulewidth}{0.4pt}
\begin{document}
\begin{titlepage}
\vspace*{7cm}
\begin{center}
{\Large Rt\-Audio Reference Manual}\\
\vspace*{1cm}
{\large Generated by Doxygen 1.2.8.1}\\
\vspace*{0.5cm}
{\small Tue Jan 22 15:27:40 2002}\\
\end{center}
\end{titlepage}
\clearemptydoublepage
\pagenumbering{roman}
\tableofcontents
\clearemptydoublepage
\pagenumbering{arabic}
\chapter{The {\bf Rt\-Audio} {\rm (p.\,\pageref{classRtAudio})} Tutorial}
\label{index}\input{index}
\chapter{Rt\-Audio Compound Index}
\input{annotated}
\chapter{Rt\-Audio File Index}
\input{files}
\chapter{Rt\-Audio Class Documentation}
\input{classRtAudio}
\include{structRtAudio_1_1RTAUDIO__DEVICE}
\include{classRtAudioError}
\chapter{Rt\-Audio File Documentation}
\input{RtAudio_8h}
\include{tutorial_8txt}
\printindex
\end{document}

+ 106
- 0
doc/latex/structRtAudio_1_1RTAUDIO__DEVICE.tex View File

@@ -0,0 +1,106 @@
\section{Rt\-Audio::RTAUDIO\_\-DEVICE Struct Reference}
\label{structRtAudio_1_1RTAUDIO__DEVICE}\index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
{\tt \#include $<$Rt\-Audio.h$>$}

\subsection*{Public Attributes}
\begin{CompactItemize}
\item
char {\bf name} [128]
\item
DEVICE\_\-ID {\bf id} [2]
\item
bool {\bf probed}
\item
int {\bf max\-Output\-Channels}
\item
int {\bf max\-Input\-Channels}
\item
int {\bf max\-Duplex\-Channels}
\item
int {\bf min\-Output\-Channels}
\item
int {\bf min\-Input\-Channels}
\item
int {\bf min\-Duplex\-Channels}
\item
bool {\bf has\-Duplex\-Support}
\item
int {\bf n\-Sample\-Rates}
\item
int {\bf sample\-Rates} [MAX\_\-SAMPLE\_\-RATES]
\item
{\bf RTAUDIO\_\-FORMAT} {\bf native\-Formats}
\end{CompactItemize}


\subsection{Member Data Documentation}
\index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!name@{name}}
\index{name@{name}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char Rt\-Audio::RTAUDIO\_\-DEVICE::name}\label{structRtAudio_1_1RTAUDIO__DEVICE_m0}


\index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!id@{id}}
\index{id@{id}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}DEVICE\_\-ID Rt\-Audio::RTAUDIO\_\-DEVICE::id}\label{structRtAudio_1_1RTAUDIO__DEVICE_m1}


No value reported by {\bf get\-Device\-Info}() {\rm (p.\,\pageref{classRtAudio_a7})}. \index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!probed@{probed}}
\index{probed@{probed}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Rt\-Audio::RTAUDIO\_\-DEVICE::probed}\label{structRtAudio_1_1RTAUDIO__DEVICE_m2}


true if the device capabilities were successfully probed. \index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!maxOutputChannels@{maxOutputChannels}}
\index{maxOutputChannels@{maxOutputChannels}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Rt\-Audio::RTAUDIO\_\-DEVICE::max\-Output\-Channels}\label{structRtAudio_1_1RTAUDIO__DEVICE_m3}


\index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!maxInputChannels@{maxInputChannels}}
\index{maxInputChannels@{maxInputChannels}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Rt\-Audio::RTAUDIO\_\-DEVICE::max\-Input\-Channels}\label{structRtAudio_1_1RTAUDIO__DEVICE_m4}


\index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!maxDuplexChannels@{maxDuplexChannels}}
\index{maxDuplexChannels@{maxDuplexChannels}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Rt\-Audio::RTAUDIO\_\-DEVICE::max\-Duplex\-Channels}\label{structRtAudio_1_1RTAUDIO__DEVICE_m5}


\index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!minOutputChannels@{minOutputChannels}}
\index{minOutputChannels@{minOutputChannels}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Rt\-Audio::RTAUDIO\_\-DEVICE::min\-Output\-Channels}\label{structRtAudio_1_1RTAUDIO__DEVICE_m6}


\index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!minInputChannels@{minInputChannels}}
\index{minInputChannels@{minInputChannels}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Rt\-Audio::RTAUDIO\_\-DEVICE::min\-Input\-Channels}\label{structRtAudio_1_1RTAUDIO__DEVICE_m7}


\index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!minDuplexChannels@{minDuplexChannels}}
\index{minDuplexChannels@{minDuplexChannels}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Rt\-Audio::RTAUDIO\_\-DEVICE::min\-Duplex\-Channels}\label{structRtAudio_1_1RTAUDIO__DEVICE_m8}


\index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!hasDuplexSupport@{hasDuplexSupport}}
\index{hasDuplexSupport@{hasDuplexSupport}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Rt\-Audio::RTAUDIO\_\-DEVICE::has\-Duplex\-Support}\label{structRtAudio_1_1RTAUDIO__DEVICE_m9}


true if device supports duplex mode. \index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!nSampleRates@{nSampleRates}}
\index{nSampleRates@{nSampleRates}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Rt\-Audio::RTAUDIO\_\-DEVICE::n\-Sample\-Rates}\label{structRtAudio_1_1RTAUDIO__DEVICE_m10}


Number of discrete rates or -1 if range supported. \index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!sampleRates@{sampleRates}}
\index{sampleRates@{sampleRates}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Rt\-Audio::RTAUDIO\_\-DEVICE::sample\-Rates}\label{structRtAudio_1_1RTAUDIO__DEVICE_m11}


Supported rates or (min, max) if range. \index{RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}!nativeFormats@{nativeFormats}}
\index{nativeFormats@{nativeFormats}!RtAudio::RTAUDIO_DEVICE@{Rt\-Audio::RTAUDIO\_\-DEVICE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf RTAUDIO\_\-FORMAT} Rt\-Audio::RTAUDIO\_\-DEVICE::native\-Formats}\label{structRtAudio_1_1RTAUDIO__DEVICE_m12}


Bit mask of supported data formats.

The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf Rt\-Audio.h}\end{CompactItemize}

+ 2
- 0
doc/latex/tutorial_8txt.tex View File

@@ -0,0 +1,2 @@
\section{tutorial.txt File Reference}
\label{tutorial_8txt}\index{tutorial.txt@{tutorial.txt}}

+ 254
- 0
doc/man/man3/RtAudio.3 View File

@@ -0,0 +1,254 @@
.TH "RtAudio" 3 "22 Jan 2002" "RtAudio" \" -*- nroff -*-
.ad l
.nh
.SH NAME
RtAudio \-
.SH SYNOPSIS
.br
.PP
\fC#include <RtAudio.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "typedef unsigned long \fBRTAUDIO_FORMAT\fP"
.br
.ti -1c
.RI "typedef int (* \fBRTAUDIO_CALLBACK\fP )(char *buffer, int bufferSize, void *userData)"
.br
.ti -1c
.RI "enum { \fBMAX_SAMPLE_RATES\fP = 14 }"
.br
.in -1c
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBRtAudio\fP ()"
.br
.RI "\fIThe default constructor.\fP"
.ti -1c
.RI "\fBRtAudio\fP (int *streamID, int outputDevice, int outputChannels, int inputDevice, int inputChannels, \fBRTAUDIO_FORMAT\fP format, int sampleRate, int *bufferSize, int numberOfBuffers)"
.br
.RI "\fIA constructor which can be used to open a stream during instantiation.\fP"
.ti -1c
.RI "\fB~RtAudio\fP ()"
.br
.RI "\fIThe destructor.\fP"
.ti -1c
.RI "int \fBopenStream\fP (int outputDevice, int outputChannels, int inputDevice, int inputChannels, \fBRTAUDIO_FORMAT\fP format, int sampleRate, int *bufferSize, int numberOfBuffers)"
.br
.RI "\fIA public method for opening a stream with the specified parameters.\fP"
.ti -1c
.RI "void \fBsetStreamCallback\fP (int streamID, \fBRTAUDIO_CALLBACK\fP callback, void *userData)"
.br
.RI "\fIA public method which sets a user-defined callback function for a given stream.\fP"
.ti -1c
.RI "void \fBcancelStreamCallback\fP (int streamID)"
.br
.RI "\fIA public method which cancels a callback process and function for a given stream.\fP"
.ti -1c
.RI "int \fBgetDeviceCount\fP (void)"
.br
.RI "\fIA public method which returns the number of audio devices found.\fP"
.ti -1c
.RI "void \fBgetDeviceInfo\fP (int device, \fBRTAUDIO_DEVICE\fP *info)"
.br
.RI "\fIFill a user-supplied \fBRTAUDIO_DEVICE\fP structure for a specified device.\fP"
.ti -1c
.RI "char* const \fBgetStreamBuffer\fP (int streamID)"
.br
.RI "\fIA public method which returns a pointer to the buffer for an open stream.\fP"
.ti -1c
.RI "void \fBtickStream\fP (int streamID)"
.br
.RI "\fIPublic method used to trigger processing of input/output data for a stream.\fP"
.ti -1c
.RI "void \fBcloseStream\fP (int streamID)"
.br
.RI "\fIPublic method which closes a stream and frees any associated buffers.\fP"
.ti -1c
.RI "void \fBstartStream\fP (int streamID)"
.br
.RI "\fIPublic method which starts a stream.\fP"
.ti -1c
.RI "void \fBstopStream\fP (int streamID)"
.br
.RI "\fIStop a stream, allowing any samples remaining in the queue to be played out and/or read in.\fP"
.ti -1c
.RI "void \fBabortStream\fP (int streamID)"
.br
.RI "\fIStop a stream, discarding any samples remaining in the input/output queue.\fP"
.ti -1c
.RI "int \fBstreamWillBlock\fP (int streamID)"
.br
.RI "\fIQueries a stream to determine whether a call to the \fBtickStream\fP() method will block.\fP"
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "const \fBRTAUDIO_FORMAT\fP \fBRTAUDIO_SINT8\fP"
.br
.ti -1c
.RI "const \fBRTAUDIO_FORMAT\fP \fBRTAUDIO_SINT16\fP"
.br
.ti -1c
.RI "const \fBRTAUDIO_FORMAT\fP \fBRTAUDIO_SINT24\fP"
.br
.ti -1c
.RI "const \fBRTAUDIO_FORMAT\fP \fBRTAUDIO_SINT32\fP"
.br
.ti -1c
.RI "const \fBRTAUDIO_FORMAT\fP \fBRTAUDIO_FLOAT32\fP"
.br
.ti -1c
.RI "const \fBRTAUDIO_FORMAT\fP \fBRTAUDIO_FLOAT64\fP"
.br
.in -1c
.SH "MEMBER TYPEDEF DOCUMENTATION"
.PP
.SS "typedef unsigned long RtAudio::RTAUDIO_FORMAT"
.PP
.SS "typedef int(* RtAudio::RTAUDIO_CALLBACK)(char *buffer, int bufferSize, void *userData)"
.PP
.SH "MEMBER ENUMERATION DOCUMENTATION"
.PP
.SS "anonymous enum"
.PP
\fBEnumeration values:\fP
.in +1c
.TP
\fB\fIMAX_SAMPLE_RATES\fP \fP

.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP
.SS "RtAudio::RtAudio ()"
.PP
The default constructor.
.PP
Probes the system to make sure at least one audio input/output device is available and determines the api-specific identifier for each device found. An \fBRtAudioError\fP error can be thrown if no devices are found or if a memory allocation error occurs.
.SS "RtAudio::RtAudio (int * streamID, int outputDevice, int outputChannels, int inputDevice, int inputChannels, \fBRTAUDIO_FORMAT\fP format, int sampleRate, int * bufferSize, int numberOfBuffers)"
.PP
A constructor which can be used to open a stream during instantiation.
.PP
The specified output and/or input device identifiers correspond to those enumerated via the \fBgetDeviceInfo\fP() method. If device = 0, the default or first available devices meeting the given parameters is selected. If an output or input channel value is zero, the corresponding device value is ignored. When a stream is successfully opened, its identifier is returned via the 'streamID' pointer. An \fBRtAudioError\fP can be thrown if no devices are found for the given parameters, if a memory allocation error occurs, or if a driver error occurs.
.PP
\fBSee also: \fP
.in +1c
\fBopenStream\fP()
.SS "RtAudio::~RtAudio ()"
.PP
The destructor.
.PP
Stops and closes any open streams and devices and deallocates buffer and structure memory.
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP
.SS "int RtAudio::openStream (int outputDevice, int outputChannels, int inputDevice, int inputChannels, \fBRTAUDIO_FORMAT\fP format, int sampleRate, int * bufferSize, int numberOfBuffers)"
.PP
A public method for opening a stream with the specified parameters.
.PP
If successful, the opened stream ID is returned. Otherwise, an \fBRtAudioError\fP is thrown.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIoutputDevice:\fP\fP
If equal to 0, the default or first device found meeting the given parameters is opened. Otherwise, the device number should correspond to one of those enumerated via the \fBgetDeviceInfo\fP() method.
.TP
\fB\fIoutputChannels:\fP\fP
The desired number of output channels. If equal to zero, the outputDevice identifier is ignored.
.TP
\fB\fIinputDevice:\fP\fP
If equal to 0, the default or first device found meeting the given parameters is opened. Otherwise, the device number should correspond to one of those enumerated via the \fBgetDeviceInfo\fP() method.
.TP
\fB\fIinputChannels:\fP\fP
The desired number of input channels. If equal to zero, the inputDevice identifier is ignored.
.TP
\fB\fIformat:\fP\fP
An RTAUDIO_FORMAT specifying the desired sample data format.
.TP
\fB\fIsampleRate:\fP\fP
The desired sample rate (sample frames per second).
.TP
\fB\fIbufferSize:\fP\fP
A pointer value indicating the desired internal buffer size in sample frames. The actual value used by the device is returned via the same pointer. A value of zero can be specified, in which case the lowest allowable value is determined.
.TP
\fB\fInumberOfBuffers:\fP\fP
A value which can be used to help control device latency. More buffers typically result in more robust performance, though at a cost of greater latency. A value of zero can be specified, in which case the lowest allowable value is used.
.SS "void RtAudio::setStreamCallback (int streamID, \fBRTAUDIO_CALLBACK\fP callback, void * userData)"
.PP
A public method which sets a user-defined callback function for a given stream.
.PP
This method assigns a callback function to a specific, previously opened stream for non-blocking stream functionality. A separate process is initiated, though the user function is called only when the stream is 'running' (between calls to the \fBstartStream\fP() and \fBstopStream\fP() methods, respectively). The callback process remains active for the duration of the stream and is automatically shutdown when the stream is closed (via the \fBcloseStream\fP() method or by object destruction). The callback process can also be shutdown and the user function de-referenced through an explicit call to the \fBcancelStreamCallback\fP() method. Note that a single stream can use only blocking or callback functionality at the same time, though it is possible to alternate modes on the same stream through the use of the \fBsetStreamCallback\fP() and \fBcancelStreamCallback\fP() methods (the blocking \fBtickStream\fP() method can be used before a callback is set and/or after a callback is cancelled). An \fBRtAudioError\fP will be thrown for an invalid device argument.
.SS "void RtAudio::cancelStreamCallback (int streamID)"
.PP
A public method which cancels a callback process and function for a given stream.
.PP
This method shuts down a callback process and de-references the user function for a specific stream. Callback functionality can subsequently be restarted on the stream via the \fBsetStreamCallback\fP() method. An \fBRtAudioError\fP will be thrown for an invalid device argument.
.SS "int RtAudio::getDeviceCount (void)"
.PP
A public method which returns the number of audio devices found.
.PP
.SS "void RtAudio::getDeviceInfo (int device, \fBRTAUDIO_DEVICE\fP * info)"
.PP
Fill a user-supplied \fBRTAUDIO_DEVICE\fP structure for a specified device.
.PP
Any device between 0 and \fBgetDeviceCount\fP()-1 is valid. If a device is busy or otherwise unavailable, the structure member 'probed' has a value of 'false'. The system default input and output devices are referenced by device identifier = 0. On systems which allow dynamic default device settings, the default devices are not identified by name (specific device enumerations are assigned device identifiers > 0). An \fBRtAudioError\fP will be thrown for an invalid device argument.
.SS "char *const RtAudio::getStreamBuffer (int streamID)"
.PP
A public method which returns a pointer to the buffer for an open stream.
.PP
The user should fill and/or read the buffer data in interleaved format and then call the \fBtickStream\fP() method. An \fBRtAudioError\fP will be thrown for an invalid stream identifier.
.SS "void RtAudio::tickStream (int streamID)"
.PP
Public method used to trigger processing of input/output data for a stream.
.PP
This method blocks until all buffer data is read/written. An \fBRtAudioError\fP will be thrown for an invalid stream identifier or if a driver error occurs.
.SS "void RtAudio::closeStream (int streamID)"
.PP
Public method which closes a stream and frees any associated buffers.
.PP
If an invalid stream identifier is specified, this method issues a warning and returns (an \fBRtAudioError\fP is not thrown).
.SS "void RtAudio::startStream (int streamID)"
.PP
Public method which starts a stream.
.PP
An \fBRtAudioError\fP will be thrown for an invalid stream identifier or if a driver error occurs.
.SS "void RtAudio::stopStream (int streamID)"
.PP
Stop a stream, allowing any samples remaining in the queue to be played out and/or read in.
.PP
An \fBRtAudioError\fP will be thrown for an invalid stream identifier or if a driver error occurs.
.SS "void RtAudio::abortStream (int streamID)"
.PP
Stop a stream, discarding any samples remaining in the input/output queue.
.PP
An \fBRtAudioError\fP will be thrown for an invalid stream identifier or if a driver error occurs.
.SS "int RtAudio::streamWillBlock (int streamID)"
.PP
Queries a stream to determine whether a call to the \fBtickStream\fP() method will block.
.PP
A return value of 0 indicates that the stream will NOT block. A positive return value indicates the number of sample frames that cannot yet be processed without blocking.
.SH "MEMBER DATA DOCUMENTATION"
.PP
.SS "const \fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_SINT8\fC [static]\fP"
.PP
.SS "const \fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_SINT16\fC [static]\fP"
.PP
.SS "const \fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_SINT24\fC [static]\fP"
.PP
Upper 3 bytes of 32-bit integer.
.SS "const \fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_SINT32\fC [static]\fP"
.PP
.SS "const \fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_FLOAT32\fC [static]\fP"
.PP
Normalized between plus/minus 1.0.
.SS "const \fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_FLOAT64\fC [static]\fP"
.PP
Normalized between plus/minus 1.0.

.SH "AUTHOR"
.PP
Generated automatically by Doxygen for RtAudio from the source code.

+ 45
- 0
doc/man/man3/RtAudio.h.3 View File

@@ -0,0 +1,45 @@
.TH "RtAudio.h" 3 "22 Jan 2002" "RtAudio" \" -*- nroff -*-
.ad l
.nh
.SH NAME
RtAudio.h \-
.SH SYNOPSIS
.br
.PP
\fC#include <map>\fP
.br
.SS "Compounds"

.in +1c
.ti -1c
.RI "class \fBRtAudioError\fP"
.br
.ti -1c
.RI "class \fBRtAudio\fP"
.br
.ti -1c
.RI "struct \fBRtAudio::RTAUDIO_DEVICE\fP"
.br
.ti -1c
.RI "struct \fBRtAudio::RTAUDIO_STREAM\fP"
.br
.in -1c
.SS "Defines"

.in +1c
.ti -1c
.RI "#define \fB__RtAudio_h\fP"
.br
.in -1c
.SH "DEFINE DOCUMENTATION"
.PP
.SS "#define __RtAudio_h"
.PP
\fBValue:\fP
.PP
.nf

.fi
.SH "AUTHOR"
.PP
Generated automatically by Doxygen for RtAudio from the source code.

+ 115
- 0
doc/man/man3/RtAudioError.3 View File

@@ -0,0 +1,115 @@
.TH "RtAudioError" 3 "22 Jan 2002" "RtAudio" \" -*- nroff -*-
.ad l
.nh
.SH NAME
RtAudioError \-
.SH SYNOPSIS
.br
.PP
\fC#include <RtAudio.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBTYPE\fP { \fBWARNING\fP, \fBDEBUG_WARNING\fP, \fBUNSPECIFIED\fP, \fBNO_DEVICES_FOUND\fP, \fBINVALID_DEVICE\fP, \fBINVALID_STREAM\fP, \fBMEMORY_ERROR\fP, \fBINVALID_PARAMETER\fP, \fBDRIVER_ERROR\fP, \fBSYSTEM_ERROR\fP, \fBTHREAD_ERROR\fP }"
.br
.in -1c
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBRtAudioError\fP (const char *p, \fBTYPE\fP tipe=RtAudioError::UNSPECIFIED)"
.br
.RI "\fIThe constructor.\fP"
.ti -1c
.RI "virtual \fB~RtAudioError\fP (void)"
.br
.RI "\fIThe destructor.\fP"
.ti -1c
.RI "virtual void \fBprintMessage\fP (void)"
.br
.RI "\fIPrints 'thrown' error message to stdout.\fP"
.ti -1c
.RI "virtual const \fBTYPE\fP& \fBgetType\fP (void)"
.br
.RI "\fIReturns the 'thrown' error message TYPE.\fP"
.ti -1c
.RI "virtual const char* \fBgetMessage\fP (void)"
.br
.RI "\fIReturns the 'thrown' error message string.\fP"
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "char \fBerror_message\fP [256]"
.br
.ti -1c
.RI "\fBTYPE\fP \fBtype\fP"
.br
.in -1c
.SH "MEMBER ENUMERATION DOCUMENTATION"
.PP
.SS "enum RtAudioError::TYPE"
.PP
\fBEnumeration values:\fP
.in +1c
.TP
\fB\fIWARNING\fP \fP
.TP
\fB\fIDEBUG_WARNING\fP \fP
.TP
\fB\fIUNSPECIFIED\fP \fP
.TP
\fB\fINO_DEVICES_FOUND\fP \fP
.TP
\fB\fIINVALID_DEVICE\fP \fP
.TP
\fB\fIINVALID_STREAM\fP \fP
.TP
\fB\fIMEMORY_ERROR\fP \fP
.TP
\fB\fIINVALID_PARAMETER\fP \fP
.TP
\fB\fIDRIVER_ERROR\fP \fP
.TP
\fB\fISYSTEM_ERROR\fP \fP
.TP
\fB\fITHREAD_ERROR\fP \fP

.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP
.SS "RtAudioError::RtAudioError (const char * p, \fBTYPE\fP tipe = RtAudioError::UNSPECIFIED)"
.PP
The constructor.
.PP
.SS "RtAudioError::~RtAudioError (void)\fC [virtual]\fP"
.PP
The destructor.
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP
.SS "void RtAudioError::printMessage (void)\fC [virtual]\fP"
.PP
Prints 'thrown' error message to stdout.
.PP
.SS "const \fBTYPE\fP & RtAudioError::getType (void)\fC [inline, virtual]\fP"
.PP
Returns the 'thrown' error message TYPE.
.PP
.SS "const char * RtAudioError::getMessage (void)\fC [inline, virtual]\fP"
.PP
Returns the 'thrown' error message string.
.PP
.SH "MEMBER DATA DOCUMENTATION"
.PP
.SS "char RtAudioError::error_message\fC [protected]\fP"
.PP
.SS "\fBTYPE\fP RtAudioError::type\fC [protected]\fP"
.PP


.SH "AUTHOR"
.PP
Generated automatically by Doxygen for RtAudio from the source code.

+ 91
- 0
doc/man/man3/RtAudio_RTAUDIO_DEVICE.3 View File

@@ -0,0 +1,91 @@
.TH "RtAudio::RTAUDIO_DEVICE" 3 "22 Jan 2002" "RtAudio" \" -*- nroff -*-
.ad l
.nh
.SH NAME
RtAudio::RTAUDIO_DEVICE \-
.SH SYNOPSIS
.br
.PP
\fC#include <RtAudio.h>\fP
.PP
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "char \fBname\fP [128]"
.br
.ti -1c
.RI "DEVICE_ID \fBid\fP [2]"
.br
.ti -1c
.RI "bool \fBprobed\fP"
.br
.ti -1c
.RI "int \fBmaxOutputChannels\fP"
.br
.ti -1c
.RI "int \fBmaxInputChannels\fP"
.br
.ti -1c
.RI "int \fBmaxDuplexChannels\fP"
.br
.ti -1c
.RI "int \fBminOutputChannels\fP"
.br
.ti -1c
.RI "int \fBminInputChannels\fP"
.br
.ti -1c
.RI "int \fBminDuplexChannels\fP"
.br
.ti -1c
.RI "bool \fBhasDuplexSupport\fP"
.br
.ti -1c
.RI "int \fBnSampleRates\fP"
.br
.ti -1c
.RI "int \fBsampleRates\fP [MAX_SAMPLE_RATES]"
.br
.ti -1c
.RI "\fBRTAUDIO_FORMAT\fP \fBnativeFormats\fP"
.br
.in -1c
.SH "MEMBER DATA DOCUMENTATION"
.PP
.SS "char RtAudio::RTAUDIO_DEVICE::name"
.PP
.SS "DEVICE_ID RtAudio::RTAUDIO_DEVICE::id"
.PP
No value reported by \fBgetDeviceInfo\fP().
.SS "bool RtAudio::RTAUDIO_DEVICE::probed"
.PP
true if the device capabilities were successfully probed.
.SS "int RtAudio::RTAUDIO_DEVICE::maxOutputChannels"
.PP
.SS "int RtAudio::RTAUDIO_DEVICE::maxInputChannels"
.PP
.SS "int RtAudio::RTAUDIO_DEVICE::maxDuplexChannels"
.PP
.SS "int RtAudio::RTAUDIO_DEVICE::minOutputChannels"
.PP
.SS "int RtAudio::RTAUDIO_DEVICE::minInputChannels"
.PP
.SS "int RtAudio::RTAUDIO_DEVICE::minDuplexChannels"
.PP
.SS "bool RtAudio::RTAUDIO_DEVICE::hasDuplexSupport"
.PP
true if device supports duplex mode.
.SS "int RtAudio::RTAUDIO_DEVICE::nSampleRates"
.PP
Number of discrete rates or -1 if range supported.
.SS "int RtAudio::RTAUDIO_DEVICE::sampleRates"
.PP
Supported rates or (min, max) if range.
.SS "\fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_DEVICE::nativeFormats"
.PP
Bit mask of supported data formats.

.SH "AUTHOR"
.PP
Generated automatically by Doxygen for RtAudio from the source code.

+ 11
- 0
doc/man/man3/tutorial.txt.3 View File

@@ -0,0 +1,11 @@
.TH "tutorial.txt" 3 "22 Jan 2002" "RtAudio" \" -*- nroff -*-
.ad l
.nh
.SH NAME
tutorial.txt \-
.SH SYNOPSIS
.br
.PP
.SH "AUTHOR"
.PP
Generated automatically by Doxygen for RtAudio from the source code.

+ 1781
- 0
doc/rtf/refman.rtf
File diff suppressed because it is too large
View File


Write Preview
Loading…
Cancel
Save