diff options
| author | Gary Scavone <gary@music.mcgill.ca> | 2013-10-10 23:55:02 +0200 |
|---|---|---|
| committer | Stephen Sinclair <sinclair@music.mcgill.ca> | 2013-10-10 23:55:02 +0200 |
| commit | 9f727b28665547db7609c0baf5c39ca96af71565 (patch) | |
| tree | 65d5391e3ba84bc843e81e52f46918f93c19dda7 /doc/html | |
| parent | a1bbe4d94da4e9fd19f54bf83de23a6f5dc345df (diff) | |
Release 2.0.1 tarball2.0.1
Diffstat (limited to 'doc/html')
| -rw-r--r-- | doc/html/RtAudio_8h-source.html | 511 | ||||
| -rw-r--r-- | doc/html/RtAudio_8h.html | 10 | ||||
| -rw-r--r-- | doc/html/annotated.html | 4 | ||||
| -rw-r--r-- | doc/html/classRtAudio-members.html | 22 | ||||
| -rw-r--r-- | doc/html/classRtAudio.html | 66 | ||||
| -rw-r--r-- | doc/html/classRtAudioError-members.html | 40 | ||||
| -rw-r--r-- | doc/html/classRtError-members.html | 40 | ||||
| -rw-r--r-- | doc/html/classRtError.html (renamed from doc/html/classRtAudioError.html) | 78 | ||||
| -rw-r--r-- | doc/html/files.html | 2 | ||||
| -rw-r--r-- | doc/html/functions.html | 44 | ||||
| -rw-r--r-- | doc/html/globals.html | 4 | ||||
| -rw-r--r-- | doc/html/index.html | 85 | ||||
| -rw-r--r-- | doc/html/structRtAudio_1_1RTAUDIO__DEVICE-members.html | 2 | ||||
| -rw-r--r-- | doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html | 2 | ||||
| -rw-r--r-- | doc/html/tutorial_8txt.html | 2 |
15 files changed, 453 insertions, 459 deletions
diff --git a/doc/html/RtAudio_8h-source.html b/doc/html/RtAudio_8h-source.html index cd9bc20..964e1e5 100644 --- a/doc/html/RtAudio_8h-source.html +++ b/doc/html/RtAudio_8h-source.html @@ -11,282 +11,287 @@ <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> +00004 <font class="comment"> 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> +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 <map></font> 00012 -00013 <font class="preprocessor">#if defined(__LINUX_ALSA_)</font> +00013 <font class="preprocessor">#if defined(__LINUX_ALSA__)</font> 00014 <font class="preprocessor"></font><font class="preprocessor"> #include <alsa/asoundlib.h></font> 00015 <font class="preprocessor"> #include <pthread.h></font> 00016 <font class="preprocessor"> #include <unistd.h></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 <pthread.h></font> -00025 <font class="preprocessor"> #include <unistd.h></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 <windows.h></font> -00034 <font class="preprocessor"> #include <process.h></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 <dmedia/audio.h></font> -00050 <font class="preprocessor"> #include <pthread.h></font> -00051 <font class="preprocessor"> #include <unistd.h></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> +00018 <font class="preprocessor"> #define THREAD_TYPE</font> +00019 <font class="preprocessor"></font> <font class="keyword">typedef</font> snd_pcm_t *AUDIO_HANDLE; +00020 <font class="keyword">typedef</font> <font class="keywordtype">int</font> DEVICE_ID; +00021 <font class="keyword">typedef</font> pthread_t THREAD_HANDLE; +00022 <font class="keyword">typedef</font> pthread_mutex_t MUTEX; +00023 +00024 <font class="preprocessor">#elif defined(__LINUX_OSS__)</font> +00025 <font class="preprocessor"></font><font class="preprocessor"> #include <pthread.h></font> +00026 <font class="preprocessor"> #include <unistd.h></font> +00027 +00028 <font class="preprocessor"> #define THREAD_TYPE</font> +00029 <font class="preprocessor"></font> <font class="keyword">typedef</font> <font class="keywordtype">int</font> AUDIO_HANDLE; +00030 <font class="keyword">typedef</font> <font class="keywordtype">int</font> DEVICE_ID; +00031 <font class="keyword">typedef</font> pthread_t THREAD_HANDLE; +00032 <font class="keyword">typedef</font> pthread_mutex_t MUTEX; +00033 +00034 <font class="preprocessor">#elif defined(__WINDOWS_DS__)</font> +00035 <font class="preprocessor"></font><font class="preprocessor"> #include <windows.h></font> +00036 <font class="preprocessor"> #include <process.h></font> +00037 +00038 <font class="comment">// The following struct is used to hold the extra variables</font> +00039 <font class="comment">// specific to the DirectSound implementation.</font> +00040 <font class="keyword">typedef</font> <font class="keyword">struct </font>{ +00041 <font class="keywordtype">void</font> * object; +00042 <font class="keywordtype">void</font> * buffer; +00043 UINT bufferPointer; +00044 } AUDIO_HANDLE; +00045 +00046 <font class="preprocessor"> #define THREAD_TYPE __stdcall</font> +00047 <font class="preprocessor"></font> <font class="keyword">typedef</font> LPGUID DEVICE_ID; +00048 <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> THREAD_HANDLE; +00049 <font class="keyword">typedef</font> CRITICAL_SECTION MUTEX; +00050 +00051 <font class="preprocessor">#elif defined(__IRIX_AL__)</font> +00052 <font class="preprocessor"></font><font class="preprocessor"> #include <dmedia/audio.h></font> +00053 <font class="preprocessor"> #include <pthread.h></font> +00054 <font class="preprocessor"> #include <unistd.h></font> +00055 +00056 <font class="preprocessor"> #define THREAD_TYPE</font> +00057 <font class="preprocessor"></font> <font class="keyword">typedef</font> ALport AUDIO_HANDLE; +00058 <font class="keyword">typedef</font> <font class="keywordtype">int</font> DEVICE_ID; +00059 <font class="keyword">typedef</font> pthread_t THREAD_HANDLE; +00060 <font class="keyword">typedef</font> pthread_mutex_t MUTEX; +00061 +00062 <font class="preprocessor">#endif</font> +00063 <font class="preprocessor"></font> +00064 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; +00066 <font class="comment">//</font> +00067 <font class="comment">// RtError class declaration.</font> +00068 <font class="comment">//</font> +00069 <font class="comment">// *************************************************** //</font> +00070 +<a name="l00071"></a><a class="code" href="classRtError.html">00071</a> <font class="keyword">class </font><a class="code" href="classRtError.html">RtError</a> +00072 { +00073 <font class="keyword">public</font>: +<a name="l00074"></a><a class="code" href="classRtError.html#s11">00074</a> <font class="keyword">enum</font> TYPE { +00075 WARNING, +00076 DEBUG_WARNING, +00077 UNSPECIFIED, +00078 NO_DEVICES_FOUND, +00079 INVALID_DEVICE, +00080 INVALID_STREAM, +00081 MEMORY_ERROR, +00082 INVALID_PARAMETER, +00083 DRIVER_ERROR, +00084 SYSTEM_ERROR, +00085 THREAD_ERROR +00086 }; 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); +00088 <font class="keyword">protected</font>: +<a name="l00089"></a><a class="code" href="classRtError.html#n0">00089</a> <font class="keywordtype">char</font> error_message[256]; +<a name="l00090"></a><a class="code" href="classRtError.html#n1">00090</a> TYPE type; 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& <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 }; +00092 <font class="keyword">public</font>: +00094 <a class="code" href="classRtError.html#a0">RtError</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *p, TYPE tipe = RtError::UNSPECIFIED); +00095 +00097 <font class="keyword">virtual</font> <a class="code" href="classRtError.html#a1">~RtError</a>(<font class="keywordtype">void</font>); +00098 +00100 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classRtError.html#a2">printMessage</a>(<font class="keywordtype">void</font>); +00101 +<a name="l00103"></a><a class="code" href="classRtError.html#a3">00103</a> <font class="keyword">virtual</font> <font class="keyword">const</font> TYPE& <a class="code" href="classRtError.html#a3">getType</a>(<font class="keywordtype">void</font>)<font class="keyword"> </font>{ <font class="keywordflow">return</font> type; } 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> +<a name="l00106"></a><a class="code" href="classRtError.html#a4">00106</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="classRtError.html#a4">getMessage</a>(<font class="keywordtype">void</font>)<font class="keyword"> </font>{ <font class="keywordflow">return</font> error_message; } +00107 }; +00108 +00109 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>: +00111 <font class="comment">//</font> +00112 <font class="comment">// RtAudio class declaration.</font> +00113 <font class="comment">//</font> +00114 <font class="comment">// *************************************************** //</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>: +<a name="l00116"></a><a class="code" href="classRtAudio.html">00116</a> <font class="keyword">class </font><a class="code" href="classRtAudio.html">RtAudio</a> +00117 { +00118 <font class="keyword">public</font>: +00119 +00120 <font class="comment">// Support for signed integers and floats. Audio data fed to/from</font> +00121 <font class="comment">// the tickStream() routine is assumed to ALWAYS be in host</font> +00122 <font class="comment">// byte order. The internal routines will automatically take care of</font> +00123 <font class="comment">// any necessary byte-swapping between the host format and the</font> +00124 <font class="comment">// soundcard. Thus, endian-ness is not a concern in the following</font> +00125 <font class="comment">// format definitions.</font> +<a name="l00126"></a><a class="code" href="classRtAudio.html#s0">00126</a> <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> RTAUDIO_FORMAT; +<a name="l00127"></a><a class="code" href="classRtAudio.html#p0">00127</a> <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT8; +<a name="l00128"></a><a class="code" href="classRtAudio.html#p1">00128</a> <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT16; +<a name="l00129"></a><a class="code" href="classRtAudio.html#p2">00129</a> <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT24; +<a name="l00130"></a><a class="code" href="classRtAudio.html#p3">00130</a> <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT32; +<a name="l00131"></a><a class="code" href="classRtAudio.html#p4">00131</a> <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_FLOAT32; +<a name="l00132"></a><a class="code" href="classRtAudio.html#p5">00132</a> <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_FLOAT64; +00133 +00134 <font class="comment">//static const int MAX_SAMPLE_RATES = 14;</font> +00135 <font class="keyword">enum</font> { MAX_SAMPLE_RATES = 14 }; +00136 +00137 <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); +00138 +<a name="l00139"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html">00139</a> <font class="keyword">typedef</font> <font class="keyword">struct </font>{ +<a name="l00140"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m0">00140</a> <font class="keywordtype">char</font> name[128]; +<a name="l00141"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m1">00141</a> DEVICE_ID id[2]; +<a name="l00142"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m2">00142</a> <font class="keywordtype">bool</font> probed; +<a name="l00143"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m3">00143</a> <font class="keywordtype">int</font> maxOutputChannels; +<a name="l00144"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m4">00144</a> <font class="keywordtype">int</font> maxInputChannels; +<a name="l00145"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m5">00145</a> <font class="keywordtype">int</font> maxDuplexChannels; +<a name="l00146"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m6">00146</a> <font class="keywordtype">int</font> minOutputChannels; +<a name="l00147"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m7">00147</a> <font class="keywordtype">int</font> minInputChannels; +<a name="l00148"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m8">00148</a> <font class="keywordtype">int</font> minDuplexChannels; +<a name="l00149"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m9">00149</a> <font class="keywordtype">bool</font> hasDuplexSupport; +<a name="l00150"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m10">00150</a> <font class="keywordtype">int</font> nSampleRates; +<a name="l00151"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m11">00151</a> <font class="keywordtype">int</font> sampleRates[MAX_SAMPLE_RATES]; +<a name="l00152"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m12">00152</a> RTAUDIO_FORMAT nativeFormats; +00153 } RTAUDIO_DEVICE; +00154 +00156 +00163 <a class="code" href="classRtAudio.html#a0">RtAudio</a>(); +00164 +00166 +00177 <a class="code" href="classRtAudio.html#a0">RtAudio</a>(<font class="keywordtype">int</font> *streamId, +00178 <font class="keywordtype">int</font> outputDevice, <font class="keywordtype">int</font> outputChannels, +00179 <font class="keywordtype">int</font> inputDevice, <font class="keywordtype">int</font> inputChannels, +00180 RTAUDIO_FORMAT format, <font class="keywordtype">int</font> sampleRate, +00181 <font class="keywordtype">int</font> *bufferSize, <font class="keywordtype">int</font> numberOfBuffers); +00182 +00184 +00188 <a class="code" href="classRtAudio.html#a2">~RtAudio</a>(); +00189 +00191 +00218 <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, +00219 <font class="keywordtype">int</font> inputDevice, <font class="keywordtype">int</font> inputChannels, +00220 RTAUDIO_FORMAT format, <font class="keywordtype">int</font> sampleRate, +00221 <font class="keywordtype">int</font> *bufferSize, <font class="keywordtype">int</font> numberOfBuffers); +00222 +00224 +00243 <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); +00244 +00246 +00253 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a5">cancelStreamCallback</a>(<font class="keywordtype">int</font> streamId); +00254 +00256 <font class="keywordtype">int</font> <a class="code" href="classRtAudio.html#a6">getDeviceCount</a>(<font class="keywordtype">void</font>); +00257 +00259 +00269 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a7">getDeviceInfo</a>(<font class="keywordtype">int</font> device, RTAUDIO_DEVICE *info); +00270 +00272 +00277 <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); +00278 +00280 +00285 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a9">tickStream</a>(<font class="keywordtype">int</font> streamId); +00286 +00288 +00292 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a10">closeStream</a>(<font class="keywordtype">int</font> streamId); +00293 +00295 +00299 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a11">startStream</a>(<font class="keywordtype">int</font> streamId); +00300 +00302 +00306 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a12">stopStream</a>(<font class="keywordtype">int</font> streamId); +00307 +00309 +00313 <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a13">abortStream</a>(<font class="keywordtype">int</font> streamId); +00314 +00316 +00321 <font class="keywordtype">int</font> <a class="code" href="classRtAudio.html#a14">streamWillBlock</a>(<font class="keywordtype">int</font> streamId); 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]; +00323 <font class="keyword">protected</font>: 00324 -00325 <font class="keyword">enum</font> { FAILURE, SUCCESS }; +00325 <font class="keyword">private</font>: 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; +00327 <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]; +00328 +00329 <font class="keyword">enum</font> { FAILURE, SUCCESS }; +00330 +00331 <font class="keyword">enum</font> STREAM_MODE { +00332 PLAYBACK, +00333 RECORD, +00334 DUPLEX, +00335 UNINITIALIZED = -75 +00336 }; +00337 +00338 <font class="keyword">enum</font> STREAM_STATE { +00339 STREAM_STOPPED, +00340 STREAM_RUNNING +00341 }; +00342 +00343 <font class="keyword">typedef</font> <font class="keyword">struct </font>{ +00344 <font class="keywordtype">int</font> device[2]; <font class="comment">// Playback and record, respectively.</font> +00345 STREAM_MODE mode; <font class="comment">// PLAYBACK, RECORD, or DUPLEX.</font> +00346 AUDIO_HANDLE handle[2]; <font class="comment">// Playback and record handles, respectively.</font> +00347 STREAM_STATE state; <font class="comment">// STOPPED or RUNNING</font> +00348 <font class="keywordtype">char</font> *userBuffer; +00349 <font class="keywordtype">char</font> *deviceBuffer; +00350 <font class="keywordtype">bool</font> doConvertBuffer[2]; <font class="comment">// Playback and record, respectively.</font> +00351 <font class="keywordtype">bool</font> deInterleave[2]; <font class="comment">// Playback and record, respectively.</font> +00352 <font class="keywordtype">bool</font> doByteSwap[2]; <font class="comment">// Playback and record, respectively.</font> +00353 <font class="keywordtype">int</font> sampleRate; +00354 <font class="keywordtype">int</font> bufferSize; +00355 <font class="keywordtype">int</font> nBuffers; +00356 <font class="keywordtype">int</font> nUserChannels[2]; <font class="comment">// Playback and record, respectively.</font> +00357 <font class="keywordtype">int</font> nDeviceChannels[2]; <font class="comment">// Playback and record channels, respectively.</font> +00358 RTAUDIO_FORMAT userFormat; +00359 RTAUDIO_FORMAT deviceFormat[2]; <font class="comment">// Playback and record, respectively.</font> +00360 <font class="keywordtype">bool</font> usingCallback; +00361 THREAD_HANDLE thread; +00362 MUTEX mutex; +00363 RTAUDIO_CALLBACK callback; +00364 <font class="keywordtype">void</font> *userData; +00365 } RTAUDIO_STREAM; +00366 +00367 <font class="keyword">typedef</font> <font class="keywordtype">signed</font> <font class="keywordtype">short</font> INT16; +00368 <font class="keyword">typedef</font> <font class="keywordtype">signed</font> <font class="keywordtype">int</font> INT32; +00369 <font class="keyword">typedef</font> <font class="keywordtype">float</font> FLOAT32; +00370 <font class="keyword">typedef</font> <font class="keywordtype">double</font> FLOAT64; 00371 -00372 std::map<int, void *> 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 }; +00372 <font class="keywordtype">char</font> message[256]; +00373 <font class="keywordtype">int</font> nDevices; +00374 RTAUDIO_DEVICE *devices; +00375 +00376 std::map<int, void *> streams; +00377 +00379 <font class="keywordtype">void</font> error(RtError::TYPE type); +00380 +00385 <font class="keywordtype">void</font> initialize(<font class="keywordtype">void</font>); +00386 +00388 <font class="keywordtype">void</font> clearDeviceInfo(RTAUDIO_DEVICE *info); +00389 +00397 <font class="keywordtype">void</font> probeDeviceInfo(RTAUDIO_DEVICE *info); +00398 +00405 <font class="keywordtype">bool</font> probeDeviceOpen(<font class="keywordtype">int</font> device, RTAUDIO_STREAM *stream, +00406 STREAM_MODE mode, <font class="keywordtype">int</font> channels, +00407 <font class="keywordtype">int</font> sampleRate, RTAUDIO_FORMAT format, +00408 <font class="keywordtype">int</font> *bufferSize, <font class="keywordtype">int</font> numberOfBuffers); +00409 +00416 <font class="keywordtype">void</font> *verifyStream(<font class="keywordtype">int</font> streamId); +00417 +00422 <font class="keywordtype">void</font> convertStreamBuffer(RTAUDIO_STREAM *stream, STREAM_MODE mode); +00423 +00425 <font class="keywordtype">void</font> byteSwapBuffer(<font class="keywordtype">char</font> *buffer, <font class="keywordtype">int</font> samples, RTAUDIO_FORMAT format); 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> +00428 <font class="keywordtype">int</font> formatBytes(RTAUDIO_FORMAT format); +00429 }; +00430 +00431 <font class="comment">// Uncomment the following definition to have extra information spewed to stderr.</font> +00432 <font class="comment">//#define RTAUDIO_DEBUG</font> +00433 +00434 <font class="preprocessor">#endif</font> </font></pre></div><HR>
-<table><tr><td><img src="../ccrma.gif">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
diff --git a/doc/html/RtAudio_8h.html b/doc/html/RtAudio_8h.html index b38da61..ff64d2e 100644 --- a/doc/html/RtAudio_8h.html +++ b/doc/html/RtAudio_8h.html @@ -13,22 +13,22 @@ <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 </td><td valign=bottom><a class="el" href="classRtAudioError.html">RtAudioError</a></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classRtError.html">RtError</a></td></tr> <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classRtAudio.html">RtAudio</a></td></tr> <tr><td nowrap align=right valign=top>struct </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 </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 </td><td valign=bottom><a class="el" href="RtAudio_8h.html#a0">__RtAudio_h</a></td></tr> +<tr><td nowrap align=right valign=top>#define </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> +<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 +#define __RTAUDIO_H </table> </td> </tr> @@ -47,7 +47,7 @@ </table> <HR>
-<table><tr><td><img src="../ccrma.gif">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
diff --git a/doc/html/annotated.html b/doc/html/annotated.html index 4a41b69..ba3eeb5 100644 --- a/doc/html/annotated.html +++ b/doc/html/annotated.html @@ -11,11 +11,11 @@ <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> +<li><a class="el" href="classRtError.html">RtError</a> </ul> <HR>
-<table><tr><td><img src="../ccrma.gif">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
diff --git a/doc/html/classRtAudio-members.html b/doc/html/classRtAudio-members.html index 9eaea52..203bc38 100644 --- a/doc/html/classRtAudio-members.html +++ b/doc/html/classRtAudio-members.html @@ -9,16 +9,16 @@ <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#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#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#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> @@ -27,16 +27,16 @@ <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) +<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">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
diff --git a/doc/html/classRtAudio.html b/doc/html/classRtAudio.html index 9986e3a..cb4eff4 100644 --- a/doc/html/classRtAudio.html +++ b/doc/html/classRtAudio.html @@ -19,33 +19,33 @@ <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classRtAudio.html#a0">RtAudio</a> ()</td></tr> <tr><td> </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> </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 nowrap align=right valign=top> </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> </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> </td><td valign=bottom><a class="el" href="classRtAudio.html#a2">~RtAudio</a> ()</td></tr> <tr><td> </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 </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> </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 </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 nowrap align=right valign=top>void </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> </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 </td><td valign=bottom><a class="el" href="classRtAudio.html#a5">cancelStreamCallback</a> (int streamID)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtAudio.html#a5">cancelStreamCallback</a> (int streamId)</td></tr> <tr><td> </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 </td><td valign=bottom><a class="el" href="classRtAudio.html#a6">getDeviceCount</a> (void)</td></tr> <tr><td> </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 </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> </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 </td><td valign=bottom><a class="el" href="classRtAudio.html#a8">getStreamBuffer</a> (int streamID)</td></tr> +<tr><td nowrap align=right valign=top>char* const </td><td valign=bottom><a class="el" href="classRtAudio.html#a8">getStreamBuffer</a> (int streamId)</td></tr> <tr><td> </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 </td><td valign=bottom><a class="el" href="classRtAudio.html#a9">tickStream</a> (int streamID)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtAudio.html#a9">tickStream</a> (int streamId)</td></tr> <tr><td> </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 </td><td valign=bottom><a class="el" href="classRtAudio.html#a10">closeStream</a> (int streamID)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtAudio.html#a10">closeStream</a> (int streamId)</td></tr> <tr><td> </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 </td><td valign=bottom><a class="el" href="classRtAudio.html#a11">startStream</a> (int streamID)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtAudio.html#a11">startStream</a> (int streamId)</td></tr> <tr><td> </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 </td><td valign=bottom><a class="el" href="classRtAudio.html#a12">stopStream</a> (int streamID)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtAudio.html#a12">stopStream</a> (int streamId)</td></tr> <tr><td> </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 </td><td valign=bottom><a class="el" href="classRtAudio.html#a13">abortStream</a> (int streamID)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtAudio.html#a13">abortStream</a> (int streamId)</td></tr> <tr><td> </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 </td><td valign=bottom><a class="el" href="classRtAudio.html#a14">streamWillBlock</a> (int streamID)</td></tr> +<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classRtAudio.html#a14">streamWillBlock</a> (int streamId)</td></tr> <tr><td> </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> </td><td valign=bottom><a class="el" href="classRtAudio.html#p0">RTAUDIO_SINT8</a></td></tr> @@ -172,7 +172,7 @@ RtAudio::RtAudio ( <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> +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="classRtError.html">RtError</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> @@ -185,7 +185,7 @@ Probes the system to make sure at least one audio input/output device is availab RtAudio::RtAudio ( </b></td> <td valign="bottom"><b> -int * <em>streamID</em>, +int * <em>streamId</em>, </b></td> </tr> <tr> @@ -251,7 +251,7 @@ int <em>numberOfBuffers</em> ) <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> +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="classRtError.html">RtError</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> @@ -358,7 +358,7 @@ int <em>numberOfBuffers</em> ) <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> +If successful, the opened stream ID is returned. Otherwise, an <a class="el" href="classRtError.html">RtError</a> is thrown.<dl compact><dt> <b>Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>outputDevice:</em> @@ -399,7 +399,7 @@ A value which can be used to help control device latency. More buffers typically void RtAudio::setStreamCallback ( </b></td> <td valign="bottom"><b> -int <em>streamID</em>, +int <em>streamId</em>, </b></td> </tr> <tr> @@ -429,7 +429,7 @@ void * <em>userData</em> ) <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> +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="classRtError.html">RtError</a> will be thrown for an invalid device argument. </td> </tr> </table> <a name="a5" doxytag="RtAudio::cancelStreamCallback"></a><p> @@ -442,7 +442,7 @@ This method assigns a callback function to a specific, previously opened stream void RtAudio::cancelStreamCallback ( </b></td> <td valign="bottom"><b> -int <em>streamID</em> ) +int <em>streamId</em> ) </b></td> </tr> @@ -460,7 +460,7 @@ int <em>streamID</em> ) <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> +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="classRtError.html">RtError</a> will be thrown for an invalid device argument. </td> </tr> </table> <a name="a6" doxytag="RtAudio::getDeviceCount"></a><p> @@ -528,7 +528,7 @@ int <em>device</em>, <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 > 0). An <a class="el" href="classRtAudioError.html">RtAudioError</a> will be thrown for an invalid device argument. </td> +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 > 0). An <a class="el" href="classRtError.html">RtError</a> will be thrown for an invalid device argument. </td> </tr> </table> <a name="a8" doxytag="RtAudio::getStreamBuffer"></a><p> @@ -541,7 +541,7 @@ Any device between 0 and <a class="el" href="classRtAudio.html#a6">getDeviceCoun char *const RtAudio::getStreamBuffer ( </b></td> <td valign="bottom"><b> -int <em>streamID</em> ) +int <em>streamId</em> ) </b></td> </tr> @@ -559,7 +559,7 @@ int <em>streamID</em> ) <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> +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="classRtError.html">RtError</a> will be thrown for an invalid stream identifier. </td> </tr> </table> <a name="a9" doxytag="RtAudio::tickStream"></a><p> @@ -572,7 +572,7 @@ The user should fill and/or read the buffer data in interleaved format and then void RtAudio::tickStream ( </b></td> <td valign="bottom"><b> -int <em>streamID</em> ) +int <em>streamId</em> ) </b></td> </tr> @@ -590,7 +590,7 @@ int <em>streamID</em> ) <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> +This method blocks until all buffer data is read/written. An <a class="el" href="classRtError.html">RtError</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> @@ -603,7 +603,7 @@ This method blocks until all buffer data is read/written. An <a class="el" href= void RtAudio::closeStream ( </b></td> <td valign="bottom"><b> -int <em>streamID</em> ) +int <em>streamId</em> ) </b></td> </tr> @@ -621,7 +621,7 @@ int <em>streamID</em> ) <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> +If an invalid stream identifier is specified, this method issues a warning and returns (an <a class="el" href="classRtError.html">RtError</a> is not thrown). </td> </tr> </table> <a name="a11" doxytag="RtAudio::startStream"></a><p> @@ -634,7 +634,7 @@ If an invalid stream identifier is specified, this method issues a warning and r void RtAudio::startStream ( </b></td> <td valign="bottom"><b> -int <em>streamID</em> ) +int <em>streamId</em> ) </b></td> </tr> @@ -652,7 +652,7 @@ int <em>streamID</em> ) <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> +An <a class="el" href="classRtError.html">RtError</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> @@ -665,7 +665,7 @@ An <a class="el" href="classRtAudioError.html">RtAudioError</a> will be thrown f void RtAudio::stopStream ( </b></td> <td valign="bottom"><b> -int <em>streamID</em> ) +int <em>streamId</em> ) </b></td> </tr> @@ -683,7 +683,7 @@ int <em>streamID</em> ) <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> +An <a class="el" href="classRtError.html">RtError</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> @@ -696,7 +696,7 @@ An <a class="el" href="classRtAudioError.html">RtAudioError</a> will be thrown f void RtAudio::abortStream ( </b></td> <td valign="bottom"><b> -int <em>streamID</em> ) +int <em>streamId</em> ) </b></td> </tr> @@ -714,7 +714,7 @@ int <em>streamID</em> ) <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> +An <a class="el" href="classRtError.html">RtError</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> @@ -727,7 +727,7 @@ An <a class="el" href="classRtAudioError.html">RtAudioError</a> will be thrown f int RtAudio::streamWillBlock ( </b></td> <td valign="bottom"><b> -int <em>streamID</em> ) +int <em>streamId</em> ) </b></td> </tr> @@ -909,7 +909,7 @@ Normalized between plus/minus 1.0. </td> <li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul> <HR>
-<table><tr><td><img src="../ccrma.gif">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
diff --git a/doc/html/classRtAudioError-members.html b/doc/html/classRtAudioError-members.html deleted file mode 100644 index 4fdf02b..0000000 --- a/doc/html/classRtAudioError-members.html +++ /dev/null @@ -1,40 +0,0 @@ -<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> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </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>©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> diff --git a/doc/html/classRtError-members.html b/doc/html/classRtError-members.html new file mode 100644 index 0000000..6e789ff --- /dev/null +++ b/doc/html/classRtError-members.html @@ -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> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER>
+<HR> +<!-- Generated by Doxygen 1.2.8.1 --> +<h1>RtError Member List</h1>This is the complete list of members for <a class="el" href="classRtError.html">RtError</a>, including all inherited members.<ul> +<li><a class="el" href="classRtError.html#s11s1">DEBUG_WARNING</a> enum value +<li><a class="el" href="classRtError.html#s11s8">DRIVER_ERROR</a> enum value +<li><a class="el" href="classRtError.html#n0">error_message</a> +<code> [protected]</code><li><a class="el" href="classRtError.html#a4">getMessage</a>(void) +<code> [inline, virtual]</code><li><a class="el" href="classRtError.html#a3">getType</a>(void) +<code> [inline, virtual]</code><li><a class="el" href="classRtError.html#s11s4">INVALID_DEVICE</a> enum value +<li><a class="el" href="classRtError.html#s11s7">INVALID_PARAMETER</a> enum value +<li><a class="el" href="classRtError.html#s11s5">INVALID_STREAM</a> enum value +<li><a class="el" href="classRtError.html#s11s6">MEMORY_ERROR</a> enum value +<li><a class="el" href="classRtError.html#s11s3">NO_DEVICES_FOUND</a> enum value +<li><a class="el" href="classRtError.html#a2">printMessage</a>(void) +<code> [virtual]</code><li><a class="el" href="classRtError.html#a0">RtError</a>(const char *p, TYPE tipe=RtError::UNSPECIFIED) +<li><a class="el" href="classRtError.html#s11s9">SYSTEM_ERROR</a> enum value +<li><a class="el" href="classRtError.html#s11s10">THREAD_ERROR</a> enum value +<li><a class="el" href="classRtError.html#s11">TYPE</a> enum name +<li><a class="el" href="classRtError.html#n1">type</a> +<code> [protected]</code><li><a class="el" href="classRtError.html#s11s2">UNSPECIFIED</a> enum value +<li><a class="el" href="classRtError.html#s11s0">WARNING</a> enum value +<li><a class="el" href="classRtError.html#a1">~RtError</a>(void) +<code> [virtual]</code></ul> +<HR>
+
+<table><tr><td><img src="../images/ccrma.gif">
+ <td>©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> diff --git a/doc/html/classRtAudioError.html b/doc/html/classRtError.html index 4fa4c33..1f59ff7 100644 --- a/doc/html/classRtAudioError.html +++ b/doc/html/classRtError.html @@ -8,50 +8,50 @@ <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER>
<HR> <!-- Generated by Doxygen 1.2.8.1 --> -<h1>RtAudioError Class Reference</h1><code>#include <<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>></code> +<h1>RtError Class Reference</h1><code>#include <<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>></code> <p> -<a href="classRtAudioError-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<a href="classRtError-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 </td><td valign=bottom><a class="el" href="classRtAudioError.html#s11">TYPE</a> { <br> - <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>, +<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classRtError.html#s11">TYPE</a> { <br> + <a class="el" href="classRtError.html#s11s0">WARNING</a>, +<a class="el" href="classRtError.html#s11s1">DEBUG_WARNING</a>, +<a class="el" href="classRtError.html#s11s2">UNSPECIFIED</a>, +<a class="el" href="classRtError.html#s11s3">NO_DEVICES_FOUND</a>, <br> - <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>, + <a class="el" href="classRtError.html#s11s4">INVALID_DEVICE</a>, +<a class="el" href="classRtError.html#s11s5">INVALID_STREAM</a>, +<a class="el" href="classRtError.html#s11s6">MEMORY_ERROR</a>, +<a class="el" href="classRtError.html#s11s7">INVALID_PARAMETER</a>, <br> - <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> + <a class="el" href="classRtError.html#s11s8">DRIVER_ERROR</a>, +<a class="el" href="classRtError.html#s11s9">SYSTEM_ERROR</a>, +<a class="el" href="classRtError.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> </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 nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classRtError.html#a0">RtError</a> (const char *p, <a class="el" href="classRtError.html#s11">TYPE</a> tipe=RtError::UNSPECIFIED)</td></tr> <tr><td> </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 </td><td valign=bottom><a class="el" href="classRtAudioError.html#a1">~RtAudioError</a> (void)</td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr> <tr><td> </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 </td><td valign=bottom><a class="el" href="classRtAudioError.html#a2">printMessage</a> (void)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr> <tr><td> </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>& </td><td valign=bottom><a class="el" href="classRtAudioError.html#a3">getType</a> (void)</td></tr> +<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classRtError.html#s11">TYPE</a>& </td><td valign=bottom><a class="el" href="classRtError.html#a3">getType</a> (void)</td></tr> <tr><td> </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* </td><td valign=bottom><a class="el" href="classRtAudioError.html#a4">getMessage</a> (void)</td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr> <tr><td> </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 </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> </td><td valign=bottom><a class="el" href="classRtAudioError.html#n1">type</a></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classRtError.html#n0">error_message</a> [256]</td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classRtError.html#s11">TYPE</a> </td><td valign=bottom><a class="el" href="classRtError.html#n1">type</a></td></tr> </table> <hr><h2>Member Enumeration Documentation</h2> -<a name="s11" doxytag="RtAudioError::TYPE"></a><p> +<a name="s11" doxytag="RtError::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 +enum RtError::TYPE </b></td> </tr> @@ -109,14 +109,14 @@ enum RtAudioError::TYPE </tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> -<a name="a0" doxytag="RtAudioError::RtAudioError"></a><p> +<a name="a0" doxytag="RtError::RtError"></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 ( +RtError::RtError ( </b></td> <td valign="bottom"><b> const char * <em>p</em>, @@ -125,7 +125,7 @@ const char * <em>p</em>, <tr> <td></td> <td><b> -<a class="el" href="classRtAudioError.html#s11">TYPE</a> <em>tipe</em> = RtAudioError::UNSPECIFIED ) +<a class="el" href="classRtError.html#s11">TYPE</a> <em>tipe</em> = RtError::UNSPECIFIED ) </b></td> </tr> @@ -146,14 +146,14 @@ The constructor. </td> </tr> </table> -<a name="a1" doxytag="RtAudioError::~RtAudioError"></a><p> +<a name="a1" doxytag="RtError::~RtError"></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 ( +RtError::~RtError ( </b></td> <td valign="bottom"><b> void )<code> [virtual]</code> @@ -178,14 +178,14 @@ The destructor. </tr> </table> <hr><h2>Member Function Documentation</h2> -<a name="a2" doxytag="RtAudioError::printMessage"></a><p> +<a name="a2" doxytag="RtError::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 ( +void RtError::printMessage ( </b></td> <td valign="bottom"><b> void )<code> [virtual]</code> @@ -209,14 +209,14 @@ Prints "thrown" error message to stdout. </td> </tr> </table> -<a name="a3" doxytag="RtAudioError::getType"></a><p> +<a name="a3" doxytag="RtError::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> & RtAudioError::getType ( +const <a class="el" href="classRtError.html#s11">TYPE</a> & RtError::getType ( </b></td> <td valign="bottom"><b> void )<code> [inline, virtual]</code> @@ -240,14 +240,14 @@ Returns the "thrown" error message TYPE. </td> </tr> </table> -<a name="a4" doxytag="RtAudioError::getMessage"></a><p> +<a name="a4" doxytag="RtError::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 ( +const char * RtError::getMessage ( </b></td> <td valign="bottom"><b> void )<code> [inline, virtual]</code> @@ -272,14 +272,14 @@ Returns the "thrown" error message string. </tr> </table> <hr><h2>Member Data Documentation</h2> -<a name="n0" doxytag="RtAudioError::error_message"></a><p> +<a name="n0" doxytag="RtError::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> +char RtError::error_message<code> [protected]</code> </b></td> </tr> @@ -298,14 +298,14 @@ char RtAudioError::error_message<code> [protected]</code> </td> </tr> </table> -<a name="n1" doxytag="RtAudioError::type"></a><p> +<a name="n1" doxytag="RtError::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> +<a class="el" href="classRtError.html#s11">TYPE</a> RtError::type<code> [protected]</code> </b></td> </tr> @@ -328,7 +328,7 @@ char RtAudioError::error_message<code> [protected]</code> <li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul> <HR>
-<table><tr><td><img src="../ccrma.gif">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
diff --git a/doc/html/files.html b/doc/html/files.html index a2102b2..c07fb12 100644 --- a/doc/html/files.html +++ b/doc/html/files.html @@ -12,7 +12,7 @@ <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">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
diff --git a/doc/html/functions.html b/doc/html/functions.html index 861b1c0..a3342d3 100644 --- a/doc/html/functions.html +++ b/doc/html/functions.html @@ -24,20 +24,20 @@ Here is a list of all class members with links to the class documentation for ea <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 class="el" href="classRtError.html#s11s1">RtError</a><li>DRIVER_ERROR +: <a class="el" href="classRtError.html#s11s8">RtError</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 class="el" href="classRtError.html#n0">RtError</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="classRtError.html#a4">RtError</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 class="el" href="classRtError.html#a3">RtError</a></ul> <a name="index_h"><h3>- h -</h3></a> <ul> <li>hasDuplexSupport @@ -46,9 +46,9 @@ Here is a list of all class members with links to the class documentation for ea <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 class="el" href="classRtError.html#s11s4">RtError</a><li>INVALID_PARAMETER +: <a class="el" href="classRtError.html#s11s7">RtError</a><li>INVALID_STREAM +: <a class="el" href="classRtError.html#s11s5">RtError</a></ul> <a name="index_m"><h3>- m -</h3></a> <ul> <li>MAX_SAMPLE_RATES @@ -56,7 +56,7 @@ Here is a list of all class members with links to the class documentation for ea : <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="classRtError.html#s11s6">RtError</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> @@ -65,7 +65,7 @@ Here is a list of all class members with links to the class documentation for ea <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="classRtError.html#s11s3">RtError</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> @@ -74,7 +74,7 @@ Here is a list of all class members with links to the class documentation for ea <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="classRtError.html#a2">RtError</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> @@ -87,8 +87,8 @@ Here is a list of all class members with links to the class documentation for ea : <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 class="el" href="classRtAudio.html#p0">RtAudio</a><li>RtError() +: <a class="el" href="classRtError.html#a0">RtError</a></ul> <a name="index_s"><h3>- s -</h3></a> <ul> <li>sampleRates @@ -97,30 +97,30 @@ Here is a list of all class members with links to the class documentation for ea : <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 class="el" href="classRtError.html#s11s9">RtError</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="classRtError.html#s11s10">RtError</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 class="el" href="classRtError.html#s11">RtError</a><li>type +: <a class="el" href="classRtError.html#n1">RtError</a></ul> <a name="index_u"><h3>- u -</h3></a> <ul> <li>UNSPECIFIED -: <a class="el" href="classRtAudioError.html#s11s2">RtAudioError</a></ul> +: <a class="el" href="classRtError.html#s11s2">RtError</a></ul> <a name="index_w"><h3>- w -</h3></a> <ul> <li>WARNING -: <a class="el" href="classRtAudioError.html#s11s0">RtAudioError</a></ul> +: <a class="el" href="classRtError.html#s11s0">RtError</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> +: <a class="el" href="classRtAudio.html#a2">RtAudio</a><li>~RtError() +: <a class="el" href="classRtError.html#a1">RtError</a></ul> <HR>
-<table><tr><td><img src="../ccrma.gif">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
diff --git a/doc/html/globals.html b/doc/html/globals.html index 0137fb4..f7ded5a 100644 --- a/doc/html/globals.html +++ b/doc/html/globals.html @@ -14,11 +14,11 @@ <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 +<li>__RTAUDIO_H : <a class="el" href="RtAudio_8h.html#a0">RtAudio.h</a></ul> <HR>
-<table><tr><td><img src="../ccrma.gif">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
diff --git a/doc/html/index.html b/doc/html/index.html index fcf1166..e14fab0 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -12,10 +12,8 @@ <p> <p> -<center> - <a href="index.html#intro">Introduction</a> <a href="index.html#download">Download</a> <a href="index.html#start">Getting Started</a> <a href="index.html#error">Error Handling</a> <a href="index.html#probing">Probing Device Capabilities</a> <a href="index.html#settings">Device Settings</a> <a href="index.html#playbackb">Playback (blocking functionality)</a> <a href="index.html#playbackc">Playback (callback functionality)</a> <a href="index.html#recording">Recording</a> <a href="index.html#duplex">Duplex Mode</a> <a href="index.html#methods">Summary of Methods</a> <a href="index.html#compiling">Compiling</a> <a href="index.html#osnotes">OS Notes</a> <a href="index.html#acknowledge">Acknowledgments</a> </center> - -<p> +<ul> +<li><a href="index.html#intro">Introduction</a><li><a href="index.html#start">Getting Started</a><li><a href="index.html#error">Error Handling</a><li><a href="index.html#probing">Probing Device Capabilities</a><li><a href="index.html#settings">Device Settings</a><li><a href="index.html#playbackb">Playback (blocking functionality)</a><li><a href="index.html#playbackc">Playback (callback functionality)</a><li><a href="index.html#recording">Recording</a><li><a href="index.html#duplex">Duplex Mode</a><li><a href="index.html#methods">Summary of Methods</a><li><a href="index.html#compiling">Compiling</a><li><a href="index.html#osnotes">OS Notes</a><li><a href="index.html#acknowledge">Acknowledgements</a></ul> <a name="intro"><h2>Introduction</h2></a> <p> @@ -27,12 +25,7 @@ <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> +The <a class="el" href="classRtAudio.html">RtAudio</a> API provides both blocking (synchronous) and callback (asyncronous) 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="start"><h2>Getting Started</h2></a> @@ -49,7 +42,7 @@ The first thing that must be done when using <a class="el" href="classRtAudio.ht <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> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { <font class="comment">// Handle the exception here</font> } @@ -62,7 +55,7 @@ Obviously, this example doesn't demonstrate any of the real functionality of <a <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. +<a class="el" href="classRtAudio.html">RtAudio</a> uses a C++ exception handler called <a class="el" href="classRtError.html">RtError</a>, which is declared and defined within the <a class="el" href="classRtAudio.html">RtAudio</a> class files. The <a class="el" href="classRtError.html">RtError</a> class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#s11">RtError::TYPE</a>. Almost all <a class="el" href="classRtAudio.html">RtAudio</a> methods can "throw" an <a class="el" href="classRtError.html">RtError</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> @@ -71,7 +64,7 @@ A programmer may wish to query the available audio device capabilities before de <p> <div class="fragment"><pre><font class="comment">// probe.cpp</font> -<font class="preprocessor">#include <iostream.h></font> +<font class="preprocessor">#include <iostream></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> @@ -82,7 +75,7 @@ A programmer may wish to query the available audio device capabilities before de <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> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); exit(EXIT_FAILURE); } @@ -97,14 +90,14 @@ A programmer may wish to query the available audio device capabilities before de <font class="keywordflow">try</font> { audio-><a class="code" href="classRtAudio.html#a7">getDeviceInfo</a>(i, &info); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &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 << <font class="stringliteral">"device = "</font> << i; - cout << <font class="stringliteral">": maximum output channels = "</font> << info.maxOutputChannels << endl; + cout << <font class="stringliteral">": maximum output channels = "</font> << info.maxOutputChannels << <font class="stringliteral">"\n"</font>; } <font class="comment">// Clean up</font> @@ -141,7 +134,7 @@ The following data formats are defined and fully supported by <a class="el" href <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. +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 unuseable. <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 > 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> @@ -170,7 +163,7 @@ The next step in using <a class="el" href="classRtAudio.html">RtAudio</a> is to stream = audio-><a class="code" href="classRtAudio.html#a3">openStream</a>(device, channels, 0, 0, RtAudio::RTAUDIO_FLOAT32, sample_rate, &buffer_size, n_buffers); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); exit(EXIT_FAILURE); } @@ -181,12 +174,10 @@ The next step in using <a class="el" href="classRtAudio.html">RtAudio</a> is to <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. +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="classRtError.html">RtError</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. @@ -217,7 +208,7 @@ Once the device is open for playback, there are only a few final steps necessary audio = <font class="keyword">new</font> RtAudio(&stream, device, channels, 0, 0, RtAudio::RTAUDIO_FLOAT32, sample_rate, &buffer_size, n_buffers); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); exit(EXIT_FAILURE); } @@ -229,7 +220,7 @@ Once the device is open for playback, there are only a few final steps necessary <font class="comment">// Start the stream</font> audio-><a class="code" href="classRtAudio.html#a11">startStream</a>(stream); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); <font class="keywordflow">goto</font> cleanup; } @@ -244,7 +235,7 @@ Once the device is open for playback, there are only a few final steps necessary <font class="keywordflow">try</font> { audio-><a class="code" href="classRtAudio.html#a9">tickStream</a>(stream); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); <font class="keywordflow">goto</font> cleanup; } @@ -257,7 +248,7 @@ Once the device is open for playback, there are only a few final steps necessary audio-><a class="code" href="classRtAudio.html#a12">stopStream</a>(stream); audio-><a class="code" href="classRtAudio.html#a10">closeStream</a>(stream); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); } @@ -278,7 +269,7 @@ In general, one should call the <a class="el" href="classRtAudio.html#a12">RtAud <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 <iostream.h></font> +<div class="fragment"><pre><font class="preprocessor">#include <iostream></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> @@ -318,7 +309,7 @@ The primary difference in using <a class="el" href="classRtAudio.html">RtAudio</ audio = <font class="keyword">new</font> RtAudio(&stream, device, channels, 0, 0, RtAudio::RTAUDIO_FLOAT64, sample_rate, &buffer_size, n_buffers); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); exit(EXIT_FAILURE); } @@ -330,7 +321,7 @@ The primary difference in using <a class="el" href="classRtAudio.html">RtAudio</ <font class="comment">// Start the stream</font> audio-><a class="code" href="classRtAudio.html#a11">startStream</a>(stream); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); <font class="keywordflow">goto</font> cleanup; } @@ -343,7 +334,7 @@ The primary difference in using <a class="el" href="classRtAudio.html">RtAudio</ audio-><a class="code" href="classRtAudio.html#a12">stopStream</a>(stream); audio-><a class="code" href="classRtAudio.html#a10">closeStream</a>(stream); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); } @@ -385,7 +376,7 @@ Using <a class="el" href="classRtAudio.html">RtAudio</a> for audio input is almo audio = <font class="keyword">new</font> RtAudio(&stream, 0, 0, device, channels, RtAudio::RTAUDIO_FLOAT32, sample_rate, &buffer_size, n_buffers); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); exit(EXIT_FAILURE); } @@ -397,7 +388,7 @@ Using <a class="el" href="classRtAudio.html">RtAudio</a> for audio input is almo <font class="comment">// Start the stream</font> audio-><a class="code" href="classRtAudio.html#a11">startStream</a>(stream); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); <font class="keywordflow">goto</font> cleanup; } @@ -410,7 +401,7 @@ Using <a class="el" href="classRtAudio.html">RtAudio</a> for audio input is almo <font class="keywordflow">try</font> { audio-><a class="code" href="classRtAudio.html#a9">tickStream</a>(stream); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); <font class="keywordflow">goto</font> cleanup; } @@ -425,7 +416,7 @@ Using <a class="el" href="classRtAudio.html">RtAudio</a> for audio input is almo <font class="comment">// Stop the stream</font> audio-><a class="code" href="classRtAudio.html#a12">stopStream</a>(stream); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); } @@ -444,7 +435,7 @@ Finally, it is easy to use <a class="el" href="classRtAudio.html">RtAudio</a> fo <p> <div class="fragment"><pre><font class="comment">// duplex.cpp</font> -<font class="preprocessor">#include <iostream.h></font> +<font class="preprocessor">#include <iostream></font> <font class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</font> <font class="comment">// Pass-through function.</font> @@ -471,7 +462,7 @@ Finally, it is easy to use <a class="el" href="classRtAudio.html">RtAudio</a> fo audio = <font class="keyword">new</font> RtAudio(&stream, device, channels, device, channels, RtAudio::RTAUDIO_FLOAT64, sample_rate, &buffer_size, n_buffers); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); exit(EXIT_FAILURE); } @@ -483,7 +474,7 @@ Finally, it is easy to use <a class="el" href="classRtAudio.html">RtAudio</a> fo <font class="comment">// Start the stream</font> audio-><a class="code" href="classRtAudio.html#a11">startStream</a>(stream); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); <font class="keywordflow">goto</font> cleanup; } @@ -496,7 +487,7 @@ Finally, it is easy to use <a class="el" href="classRtAudio.html">RtAudio</a> fo audio-><a class="code" href="classRtAudio.html#a12">stopStream</a>(stream); audio-><a class="code" href="classRtAudio.html#a10">closeStream</a>(stream); } - <font class="keywordflow">catch</font> (<a class="code" href="classRtAudioError.html">RtAudioError</a> &error) { + <font class="keywordflow">catch</font> (<a class="code" href="classRtError.html">RtError</a> &error) { error.printMessage(); } @@ -529,10 +520,10 @@ In order to compile <a class="el" href="classRtAudio.html">RtAudio</a> for a spe <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> +<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> @@ -547,7 +538,7 @@ The example compiler statements above could be used to compile the <code>probe.c <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. +<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, although relatively new, is now part of the Linux development kernel and 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 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> @@ -556,25 +547,23 @@ The ALSA implementation of <a class="el" href="classRtAudio.html">RtAudio</a> ma <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. +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.4 and the newer "al" audio library. <a class="el" href="classRtAudio.html">RtAudio</a> does not compile under Irix version 6.3, mainly 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. +<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 5.0 or higher. As far as I know, there is no DirectSoundCapture support for Windows NT (in which case, you cannot use <a class="el" href="classRtAudio.html">RtAudio</a>). 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> +<a name="acknowledge"><h2>Acknowledgements</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">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
diff --git a/doc/html/structRtAudio_1_1RTAUDIO__DEVICE-members.html b/doc/html/structRtAudio_1_1RTAUDIO__DEVICE-members.html index 916fbf3..5182b05 100644 --- a/doc/html/structRtAudio_1_1RTAUDIO__DEVICE-members.html +++ b/doc/html/structRtAudio_1_1RTAUDIO__DEVICE-members.html @@ -25,7 +25,7 @@ </ul> <HR>
-<table><tr><td><img src="../ccrma.gif">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
diff --git a/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html b/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html index dd69668..63a4ef3 100644 --- a/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html +++ b/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html @@ -369,7 +369,7 @@ Bit mask of supported data formats. </td> <li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul> <HR>
-<table><tr><td><img src="../ccrma.gif">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
diff --git a/doc/html/tutorial_8txt.html b/doc/html/tutorial_8txt.html index 87ca0fe..9e896a4 100644 --- a/doc/html/tutorial_8txt.html +++ b/doc/html/tutorial_8txt.html @@ -12,7 +12,7 @@ </table> <HR>
-<table><tr><td><img src="../ccrma.gif">
+<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
|