Gary Scavone
Stephen Sinclair
10 years ago
40 changed files with 4810 additions and 4707 deletions
Split View
Diff Options
-
+1913 -2628configure
-
+86 -50doc/html/RtAudio_8h.html
-
+706 -662doc/html/RtAudio_8h_source.html
-
+54 -50doc/html/RtError_8h_source.html
-
+9 -8doc/html/acknowledge.html
-
+16 -11doc/html/annotated.html
-
+21 -20doc/html/apinotes.html
-
+41 -35doc/html/classRtAudio-members.html
-
+326 -213doc/html/classRtAudio.html
-
+29 -24doc/html/classRtError-members.html
-
+67 -52doc/html/classRtError.html
-
+20 -11doc/html/classes.html
-
+16 -15doc/html/compiling.html
-
+780 -140doc/html/doxygen.css
-
BINdoc/html/doxygen.png
-
+74 -73doc/html/duplex.html
-
+9 -8doc/html/errors.html
-
+13 -8doc/html/files.html
-
+26 -54doc/html/functions.html
-
+5 -15doc/html/functions_enum.html
-
+5 -15doc/html/functions_eval.html
-
+9 -16doc/html/functions_func.html
-
+5 -15doc/html/functions_vars.html
-
+8 -12doc/html/globals.html
-
+8 -12doc/html/globals_type.html
-
+25 -24doc/html/index.html
-
+9 -8doc/html/license.html
-
+9 -8doc/html/multi.html
-
+23 -29doc/html/pages.html
-
+80 -79doc/html/playback.html
-
+57 -56doc/html/probe.html
-
+67 -66doc/html/recording.html
-
+37 -36doc/html/settings.html
-
+24 -15doc/html/structRtAudio_1_1DeviceInfo-members.html
-
+68 -61doc/html/structRtAudio_1_1DeviceInfo.html
-
+19 -10doc/html/structRtAudio_1_1StreamOptions-members.html
-
+46 -39doc/html/structRtAudio_1_1StreamOptions.html
-
+18 -9doc/html/structRtAudio_1_1StreamParameters-members.html
-
+38 -31doc/html/structRtAudio_1_1StreamParameters.html
-
+44 -89doc/html/tabs.css
+ 1913
- 2628
configure
File diff suppressed because it is too large
View File
+ 86
- 50
doc/html/RtAudio_8h.html
View File
| @@ -8,37 +8,58 @@ | |||
| <CENTER> | |||
| <a class="qindex" href="index.html">Home</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.6.2 --> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="summary"> | |||
| <a href="#nested-classes">Classes</a> | | |||
| <a href="#typedef-members">Typedefs</a> </div> | |||
| <div class="headertitle"> | |||
| <div class="title">RtAudio.h File Reference</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>RtAudio.h File Reference</h1><code>#include <string></code><br/> | |||
| <div class="textblock"><code>#include <string></code><br/> | |||
| <code>#include <vector></code><br/> | |||
| <code>#include "RtError.h"</code><br/> | |||
| <code>#include <sstream></code><br/> | |||
| </div> | |||
| <p><a href="RtAudio_8h_source.html">Go to the source code of this file.</a></p> | |||
| <table border="0" cellpadding="0" cellspacing="0"> | |||
| <tr><td colspan="2"><h2>Classes</h2></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html">RtAudio</a></td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Realtime audio i/o C++ classes. <a href="classRtAudio.html#_details">More...</a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The public device information structure for returning queried values. <a href="structRtAudio_1_1DeviceInfo.html#_details">More...</a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a></td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The structure for specifying input or ouput stream parameters. <a href="structRtAudio_1_1StreamParameters.html#_details">More...</a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a></td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The structure for specifying stream options. <a href="structRtAudio_1_1StreamOptions.html#_details">More...</a><br/></td></tr> | |||
| <tr><td colspan="2"><h2>Typedefs</h2></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">typedef unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a></td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> data format type. <a href="#aafca92882d25915560018873221e44b8"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">typedef unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41">RtAudioStreamFlags</a></td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> stream option flags. <a href="#a2c0f59b200dcec4d4e760f9166b29c41"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">typedef unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806">RtAudioStreamStatus</a></td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> stream status (over- or underflow) flags. <a href="#a80e306d363583da3b0a1b65d9b57c806"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f">RtAudioCallback</a> )(void *outputBuffer, void *inputBuffer, unsigned int nFrames, double streamTime, <a class="el" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806">RtAudioStreamStatus</a> status, void *userData)</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> callback function prototype. <a href="#a112c7b7e25a974977f6fc094cef1a31f"></a><br/></td></tr> | |||
| <table class="memberdecls"> | |||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> | |||
| Classes</h2></td></tr> | |||
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html">RtAudio</a></td></tr> | |||
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Realtime audio i/o C++ classes. <a href="classRtAudio.html#details">More...</a><br/></td></tr> | |||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td></tr> | |||
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The public device information structure for returning queried values. <a href="structRtAudio_1_1DeviceInfo.html#details">More...</a><br/></td></tr> | |||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a></td></tr> | |||
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The structure for specifying input or ouput stream parameters. <a href="structRtAudio_1_1StreamParameters.html#details">More...</a><br/></td></tr> | |||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a></td></tr> | |||
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The structure for specifying stream options. <a href="structRtAudio_1_1StreamOptions.html#details">More...</a><br/></td></tr> | |||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | |||
| </table><table class="memberdecls"> | |||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> | |||
| Typedefs</h2></td></tr> | |||
| <tr class="memitem:aafca92882d25915560018873221e44b8"><td class="memItemLeft" align="right" valign="top">typedef unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a></td></tr> | |||
| <tr class="memdesc:aafca92882d25915560018873221e44b8"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> data format type. <a href="#aafca92882d25915560018873221e44b8"></a><br/></td></tr> | |||
| <tr class="separator:aafca92882d25915560018873221e44b8"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a2c0f59b200dcec4d4e760f9166b29c41"><td class="memItemLeft" align="right" valign="top">typedef unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41">RtAudioStreamFlags</a></td></tr> | |||
| <tr class="memdesc:a2c0f59b200dcec4d4e760f9166b29c41"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> stream option flags. <a href="#a2c0f59b200dcec4d4e760f9166b29c41"></a><br/></td></tr> | |||
| <tr class="separator:a2c0f59b200dcec4d4e760f9166b29c41"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a80e306d363583da3b0a1b65d9b57c806"><td class="memItemLeft" align="right" valign="top">typedef unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806">RtAudioStreamStatus</a></td></tr> | |||
| <tr class="memdesc:a80e306d363583da3b0a1b65d9b57c806"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> stream status (over- or underflow) flags. <a href="#a80e306d363583da3b0a1b65d9b57c806"></a><br/></td></tr> | |||
| <tr class="separator:a80e306d363583da3b0a1b65d9b57c806"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a112c7b7e25a974977f6fc094cef1a31f"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f">RtAudioCallback</a> )(void *outputBuffer, void *inputBuffer, unsigned int nFrames, double streamTime, <a class="el" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806">RtAudioStreamStatus</a> status, void *userData)</td></tr> | |||
| <tr class="memdesc:a112c7b7e25a974977f6fc094cef1a31f"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> callback function prototype. <a href="#a112c7b7e25a974977f6fc094cef1a31f"></a><br/></td></tr> | |||
| <tr class="separator:a112c7b7e25a974977f6fc094cef1a31f"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a2c8c34d284ae138dd29b53375ec9f062"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="RtAudio_8h.html#a2c8c34d284ae138dd29b53375ec9f062">RtAudioErrorCallback</a> )(<a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">RtError::Type</a> type, const std::string &errorText)</td></tr> | |||
| <tr class="memdesc:a2c8c34d284ae138dd29b53375ec9f062"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> error callback function prototype. <a href="#a2c8c34d284ae138dd29b53375ec9f062"></a><br/></td></tr> | |||
| <tr class="separator:a2c8c34d284ae138dd29b53375ec9f062"><td class="memSeparator" colspan="2"> </td></tr> | |||
| </table> | |||
| <hr/><a name="_details"></a><h2>Detailed Description</h2> | |||
| <hr/><h2>Typedef Documentation</h2> | |||
| <a class="anchor" id="aafca92882d25915560018873221e44b8"></a><!-- doxytag: member="RtAudio.h::RtAudioFormat" ref="aafca92882d25915560018873221e44b8" args="" --> | |||
| <h2 class="groupheader">Typedef Documentation</h2> | |||
| <a class="anchor" id="aafca92882d25915560018873221e44b8"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| @@ -46,15 +67,14 @@ | |||
| <td class="memname">typedef unsigned long <a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> data format type. </p> | |||
| <p>Support for signed integers and floats. Audio data fed to/from an <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> stream is assumed to ALWAYS be in host byte order. The internal routines will automatically take care of any necessary byte-swapping between the host format and the soundcard. Thus, endian-ness is not a concern in the following format definitions. Note that 24-bit data is expected to be encapsulated in a 32-bit format.</p> | |||
| <p>Support for signed integers and floats. Audio data fed to/from an <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> stream is assumed to ALWAYS be in host byte order. The internal routines will automatically take care of any necessary byte-swapping between the host format and the soundcard. Thus, endian-ness is not a concern in the following format definitions.</p> | |||
| <ul> | |||
| <li><em>RTAUDIO_SINT8:</em> 8-bit signed integer.</li> | |||
| <li><em>RTAUDIO_SINT16:</em> 16-bit signed integer.</li> | |||
| <li><em>RTAUDIO_SINT24:</em> Lower 3 bytes of 32-bit signed integer.</li> | |||
| <li><em>RTAUDIO_SINT24:</em> 24-bit signed integer.</li> | |||
| <li><em>RTAUDIO_SINT32:</em> 32-bit signed integer.</li> | |||
| <li><em>RTAUDIO_FLOAT32:</em> Normalized between plus/minus 1.0.</li> | |||
| <li><em>RTAUDIO_FLOAT64:</em> Normalized between plus/minus 1.0. </li> | |||
| @@ -62,7 +82,7 @@ | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a2c0f59b200dcec4d4e760f9166b29c41"></a><!-- doxytag: member="RtAudio.h::RtAudioStreamFlags" ref="a2c0f59b200dcec4d4e760f9166b29c41" args="" --> | |||
| <a class="anchor" id="a2c0f59b200dcec4d4e760f9166b29c41"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| @@ -70,8 +90,7 @@ | |||
| <td class="memname">typedef unsigned long <a class="el" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41">RtAudioStreamFlags</a></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> stream option flags. </p> | |||
| <p>The following flags can be OR'ed together to allow a client to make changes to the default stream behavior:</p> | |||
| @@ -89,7 +108,7 @@ | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a80e306d363583da3b0a1b65d9b57c806"></a><!-- doxytag: member="RtAudio.h::RtAudioStreamStatus" ref="a80e306d363583da3b0a1b65d9b57c806" args="" --> | |||
| <a class="anchor" id="a80e306d363583da3b0a1b65d9b57c806"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| @@ -97,8 +116,7 @@ | |||
| <td class="memname">typedef unsigned long <a class="el" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806">RtAudioStreamStatus</a></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> stream status (over- or underflow) flags. </p> | |||
| <p>Notification of a stream over- or underflow is indicated by a non-zero stream <code>status</code> argument in the RtAudioCallback function. The stream status can be one of the following two options, depending on whether the stream is open for output and/or input:</p> | |||
| @@ -109,40 +127,58 @@ | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a112c7b7e25a974977f6fc094cef1a31f"></a><!-- doxytag: member="RtAudio.h::RtAudioCallback" ref="a112c7b7e25a974977f6fc094cef1a31f" args=")(void *outputBuffer, void *inputBuffer, unsigned int nFrames, double streamTime, RtAudioStreamStatus status, void *userData)" --> | |||
| <a class="anchor" id="a112c7b7e25a974977f6fc094cef1a31f"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">typedef int(* <a class="el" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f">RtAudioCallback</a>)(void *outputBuffer, void *inputBuffer, unsigned int nFrames, double streamTime, <a class="el" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806">RtAudioStreamStatus</a> status, void *userData)</td> | |||
| <td class="memname">typedef int(* RtAudioCallback)(void *outputBuffer, void *inputBuffer, unsigned int nFrames, double streamTime, <a class="el" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806">RtAudioStreamStatus</a> status, void *userData)</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> callback function prototype. </p> | |||
| <p>All <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> clients must create a function of type RtAudioCallback to read and/or write data from/to the audio stream. When the underlying audio system is ready for new input or output data, this function will be invoked.</p> | |||
| <dl><dt><b>Parameters:</b></dt><dd> | |||
| <table border="0" cellspacing="2" cellpadding="0"> | |||
| <tr><td valign="top"></td><td valign="top"><em>outputBuffer</em> </td><td>For output (or duplex) streams, the client should write <code>nFrames</code> of audio sample frames into this buffer. This argument should be recast to the datatype specified when the stream was opened. For input-only streams, this argument will be NULL.</td></tr> | |||
| <tr><td valign="top"></td><td valign="top"><em>inputBuffer</em> </td><td>For input (or duplex) streams, this buffer will hold <code>nFrames</code> of input audio sample frames. This argument should be recast to the datatype specified when the stream was opened. For output-only streams, this argument will be NULL.</td></tr> | |||
| <tr><td valign="top"></td><td valign="top"><em>nFrames</em> </td><td>The number of sample frames of input or output data in the buffers. The actual buffer size in bytes is dependent on the data type and number of channels in use.</td></tr> | |||
| <tr><td valign="top"></td><td valign="top"><em>streamTime</em> </td><td>The number of seconds that have elapsed since the stream was started.</td></tr> | |||
| <tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>If non-zero, this argument indicates a data overflow or underflow condition for the stream. The particular condition can be determined by comparison with the RtAudioStreamStatus flags.</td></tr> | |||
| <tr><td valign="top"></td><td valign="top"><em>userData</em> </td><td>A pointer to optional data provided by the client when opening the stream (default = NULL).</td></tr> | |||
| <dl class="params"><dt>Parameters</dt><dd> | |||
| <table class="params"> | |||
| <tr><td class="paramname">outputBuffer</td><td>For output (or duplex) streams, the client should write <code>nFrames</code> of audio sample frames into this buffer. This argument should be recast to the datatype specified when the stream was opened. For input-only streams, this argument will be NULL.</td></tr> | |||
| <tr><td class="paramname">inputBuffer</td><td>For input (or duplex) streams, this buffer will hold <code>nFrames</code> of input audio sample frames. This argument should be recast to the datatype specified when the stream was opened. For output-only streams, this argument will be NULL.</td></tr> | |||
| <tr><td class="paramname">nFrames</td><td>The number of sample frames of input or output data in the buffers. The actual buffer size in bytes is dependent on the data type and number of channels in use.</td></tr> | |||
| <tr><td class="paramname">streamTime</td><td>The number of seconds that have elapsed since the stream was started.</td></tr> | |||
| <tr><td class="paramname">status</td><td>If non-zero, this argument indicates a data overflow or underflow condition for the stream. The particular condition can be determined by comparison with the RtAudioStreamStatus flags.</td></tr> | |||
| <tr><td class="paramname">userData</td><td>A pointer to optional data provided by the client when opening the stream (default = NULL).</td></tr> | |||
| </table> | |||
| </dd> | |||
| </dl> | |||
| <p>To continue normal stream operation, the RtAudioCallback function should return a value of zero. To stop the stream and drain the output buffer, the function should return a value of one. To abort the stream immediately, the client should return a value of two. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a2c8c34d284ae138dd29b53375ec9f062"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">typedef void(* RtAudioErrorCallback)(<a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">RtError::Type</a> type, const std::string &errorText)</td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> error callback function prototype. </p> | |||
| <dl class="params"><dt>Parameters</dt><dd> | |||
| <table class="params"> | |||
| <tr><td class="paramname">type</td><td>Type of error. </td></tr> | |||
| <tr><td class="paramname">errorText</td><td>Error description. </td></tr> | |||
| </table> | |||
| </dd> | |||
| </dl> | |||
| </div> | |||
| </div> | |||
| </div><!-- contents --> | |||
| <HR> | |||
| <table><tr><td><img src="../images/mcgill.gif" width=165></td> | |||
| <td>©2001-2012 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| <td>©2001-2013 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| </table> | |||
| </BODY> | |||
| </HTML> | |||
+ 706
- 662
doc/html/RtAudio_8h_source.html
File diff suppressed because it is too large
View File
+ 54
- 50
doc/html/RtError_8h_source.html
View File
| @@ -8,58 +8,62 @@ | |||
| <CENTER> | |||
| <a class="qindex" href="index.html">Home</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.6.2 --> | |||
| <h1>RtError.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/************************************************************************/</span> | |||
| <a name="l00010"></a>00010 <span class="comment">/************************************************************************/</span> | |||
| <a name="l00011"></a>00011 | |||
| <a name="l00012"></a>00012 <span class="preprocessor">#ifndef RTERROR_H</span> | |||
| <a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define RTERROR_H</span> | |||
| <a name="l00014"></a>00014 <span class="preprocessor"></span> | |||
| <a name="l00015"></a>00015 <span class="preprocessor">#include <exception></span> | |||
| <a name="l00016"></a>00016 <span class="preprocessor">#include <iostream></span> | |||
| <a name="l00017"></a>00017 <span class="preprocessor">#include <string></span> | |||
| <a name="l00018"></a>00018 | |||
| <a name="l00019"></a><a class="code" href="classRtError.html">00019</a> <span class="keyword">class </span><a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a> : <span class="keyword">public</span> std::exception | |||
| <a name="l00020"></a>00020 { | |||
| <a name="l00021"></a>00021 <span class="keyword">public</span>: | |||
| <a name="l00023"></a><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">00023</a> <span class="keyword">enum</span> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">Type</a> { | |||
| <a name="l00024"></a><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398">00024</a> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398">WARNING</a>, | |||
| <a name="l00025"></a><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba">00025</a> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba">DEBUG_WARNING</a>, | |||
| <a name="l00026"></a><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6">00026</a> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6">UNSPECIFIED</a>, | |||
| <a name="l00027"></a><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82">00027</a> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82">NO_DEVICES_FOUND</a>, | |||
| <a name="l00028"></a><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1">00028</a> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1">INVALID_DEVICE</a>, | |||
| <a name="l00029"></a><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e">00029</a> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e">MEMORY_ERROR</a>, | |||
| <a name="l00030"></a><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6">00030</a> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6">INVALID_PARAMETER</a>, | |||
| <a name="l00031"></a><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc">00031</a> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc">INVALID_USE</a>, | |||
| <a name="l00032"></a><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b">00032</a> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b">DRIVER_ERROR</a>, | |||
| <a name="l00033"></a><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b">00033</a> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b">SYSTEM_ERROR</a>, | |||
| <a name="l00034"></a><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6">00034</a> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6">THREAD_ERROR</a> | |||
| <a name="l00035"></a>00035 }; | |||
| <a name="l00036"></a>00036 | |||
| <a name="l00038"></a><a class="code" href="classRtError.html#aa479a305ccbe56be0fd9137b9b405a37">00038</a> <a class="code" href="classRtError.html#aa479a305ccbe56be0fd9137b9b405a37" title="The constructor.">RtError</a>( <span class="keyword">const</span> std::string& message, <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">Type</a> type = <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6">RtError::UNSPECIFIED</a> ) throw() : message_(message), type_(type) {} | |||
| <a name="l00039"></a>00039 | |||
| <a name="l00041"></a><a class="code" href="classRtError.html#a6793e03386e7e69ffafb65a296dfa48c">00041</a> <span class="keyword">virtual</span> <a class="code" href="classRtError.html#a6793e03386e7e69ffafb65a296dfa48c" title="The destructor.">~RtError</a>( <span class="keywordtype">void</span> ) throw() {} | |||
| <a name="l00042"></a>00042 | |||
| <a name="l00044"></a><a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc">00044</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>( <span class="keywordtype">void</span> ) <span class="keyword">const</span> throw() { std::cerr << <span class="charliteral">'\n'</span> << message_ << <span class="stringliteral">"\n\n"</span>; } | |||
| <a name="l00045"></a>00045 | |||
| <a name="l00047"></a><a class="code" href="classRtError.html#a3e316dc9b9b41fe2f64cabf34beb4fe7">00047</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">Type</a>& <a class="code" href="classRtError.html#a3e316dc9b9b41fe2f64cabf34beb4fe7" title="Returns the thrown error message type.">getType</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span> throw() { <span class="keywordflow">return</span> type_; } | |||
| <a name="l00048"></a>00048 | |||
| <a name="l00050"></a><a class="code" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50">00050</a> <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& <a class="code" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50" title="Returns the thrown error message string.">getMessage</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span> throw() { <span class="keywordflow">return</span> message_; } | |||
| <a name="l00051"></a>00051 | |||
| <a name="l00053"></a><a class="code" href="classRtError.html#aeb843b7a7785d66061c61ebfc29e7e9d">00053</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classRtError.html#aeb843b7a7785d66061c61ebfc29e7e9d" title="Returns the thrown error message as a c-style string.">what</a>( <span class="keywordtype">void</span> ) <span class="keyword">const</span> throw() { <span class="keywordflow">return</span> message_.c_str(); } | |||
| <a name="l00054"></a>00054 | |||
| <a name="l00055"></a>00055 <span class="keyword">protected</span>: | |||
| <a name="l00056"></a>00056 std::string message_; | |||
| <a name="l00057"></a>00057 <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">Type</a> type_; | |||
| <a name="l00058"></a>00058 }; | |||
| <a name="l00059"></a>00059 | |||
| <a name="l00060"></a>00060 <span class="preprocessor">#endif</span> | |||
| </pre></div></div> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="headertitle"> | |||
| <div class="title">RtError.h</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/************************************************************************/</span></div> | |||
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/************************************************************************/</span></div> | |||
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div> | |||
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifndef RTERROR_H</span></div> | |||
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"></span><span class="preprocessor">#define RTERROR_H</span></div> | |||
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span></div> | |||
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <exception></span></div> | |||
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <iostream></span></div> | |||
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <string></span></div> | |||
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> | |||
| <div class="line"><a name="l00019"></a><span class="lineno"><a class="code" href="classRtError.html"> 19</a></span> <span class="keyword">class </span><a class="code" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> : <span class="keyword">public</span> std::exception</div> | |||
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> {</div> | |||
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keyword">public</span>:</div> | |||
| <div class="line"><a name="l00023"></a><span class="lineno"><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac"> 23</a></span>  <span class="keyword">enum</span> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">Type</a> {</div> | |||
| <div class="line"><a name="l00024"></a><span class="lineno"><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398"> 24</a></span>  <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398">WARNING</a>, </div> | |||
| <div class="line"><a name="l00025"></a><span class="lineno"><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba"> 25</a></span>  <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba">DEBUG_WARNING</a>, </div> | |||
| <div class="line"><a name="l00026"></a><span class="lineno"><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6"> 26</a></span>  <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6">UNSPECIFIED</a>, </div> | |||
| <div class="line"><a name="l00027"></a><span class="lineno"><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82"> 27</a></span>  <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82">NO_DEVICES_FOUND</a>, </div> | |||
| <div class="line"><a name="l00028"></a><span class="lineno"><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1"> 28</a></span>  <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1">INVALID_DEVICE</a>, </div> | |||
| <div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e"> 29</a></span>  <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e">MEMORY_ERROR</a>, </div> | |||
| <div class="line"><a name="l00030"></a><span class="lineno"><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6"> 30</a></span>  <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6">INVALID_PARAMETER</a>, </div> | |||
| <div class="line"><a name="l00031"></a><span class="lineno"><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc"> 31</a></span>  <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc">INVALID_USE</a>, </div> | |||
| <div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b"> 32</a></span>  <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b">DRIVER_ERROR</a>, </div> | |||
| <div class="line"><a name="l00033"></a><span class="lineno"><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b"> 33</a></span>  <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b">SYSTEM_ERROR</a>, </div> | |||
| <div class="line"><a name="l00034"></a><span class="lineno"><a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6"> 34</a></span>  <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6">THREAD_ERROR</a> </div> | |||
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  };</div> | |||
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> | |||
| <div class="line"><a name="l00038"></a><span class="lineno"><a class="code" href="classRtError.html#aa479a305ccbe56be0fd9137b9b405a37"> 38</a></span>  <a class="code" href="classRtError.html#aa479a305ccbe56be0fd9137b9b405a37" title="The constructor.">RtError</a>( <span class="keyword">const</span> std::string& message, <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">Type</a> type = <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6">RtError::UNSPECIFIED</a> ) throw() : message_(message), type_(type) {}</div> | |||
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div> | |||
| <div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="classRtError.html#a6793e03386e7e69ffafb65a296dfa48c"> 41</a></span>  <span class="keyword">virtual</span> <a class="code" href="classRtError.html#a6793e03386e7e69ffafb65a296dfa48c" title="The destructor.">~RtError</a>( <span class="keywordtype">void</span> ) throw() {}</div> | |||
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div> | |||
| <div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc"> 44</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>( <span class="keywordtype">void</span> ) <span class="keyword">const</span> throw() { std::cerr << <span class="charliteral">'\n'</span> << message_ << <span class="stringliteral">"\n\n"</span>; }</div> | |||
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> | |||
| <div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="classRtError.html#a3e316dc9b9b41fe2f64cabf34beb4fe7"> 47</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">Type</a>& <a class="code" href="classRtError.html#a3e316dc9b9b41fe2f64cabf34beb4fe7" title="Returns the thrown error message type.">getType</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span> throw() { <span class="keywordflow">return</span> type_; }</div> | |||
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> | |||
| <div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50"> 50</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& <a class="code" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50" title="Returns the thrown error message string.">getMessage</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span> throw() { <span class="keywordflow">return</span> message_; }</div> | |||
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> | |||
| <div class="line"><a name="l00053"></a><span class="lineno"><a class="code" href="classRtError.html#aeb843b7a7785d66061c61ebfc29e7e9d"> 53</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classRtError.html#aeb843b7a7785d66061c61ebfc29e7e9d" title="Returns the thrown error message as a c-style string.">what</a>( <span class="keywordtype">void</span> ) <span class="keyword">const</span> throw() { <span class="keywordflow">return</span> message_.c_str(); }</div> | |||
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> | |||
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">protected</span>:</div> | |||
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::string message_;</div> | |||
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">Type</a> type_;</div> | |||
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> };</div> | |||
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div> | |||
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#endif</span></div> | |||
| </div><!-- fragment --></div><!-- contents --> | |||
| <HR> | |||
| <table><tr><td><img src="../images/mcgill.gif" width=165></td> | |||
| <td>©2001-2012 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| <td>©2001-2013 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| </table> | |||
| </BODY> | |||
| </HTML> | |||
+ 9
- 8
doc/html/acknowledge.html
View File
| @@ -8,11 +8,14 @@ | |||
| <CENTER> | |||
| <a class="qindex" href="index.html">Home</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.6.2 --> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="headertitle"> | |||
| <div class="title">Acknowledgements </div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1><a class="anchor" id="acknowledge">Acknowledgements </a></h1><p>Many thanks to the following people for providing bug fixes and improvements: </p> | |||
| <div class="textblock"><p>Many thanks to the following people for providing bug fixes and improvements: </p> | |||
| <ul> | |||
| <li> | |||
| Stefan Arisona </li> | |||
| @@ -51,12 +54,10 @@ Ryan Williams (Windows non-MS compiler ASIO support) </li> | |||
| </ul> | |||
| <p>The <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">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> | |||
| <p>The early 2.0 version of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">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 and the <a href="http://www.acoustics.hut.fi/">Laboratory of Acoustics and Audio Signal Processing</a> at the Helsinki University of Technology, Finland. Much subsequent development happened while working at 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>. All recent versions of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> have been completed while working as an assistant / associate professor of <a href="http://www.music.mcgill.ca/musictech/">Music Technology</a> at <a href="http://www.mcgill.ca/">McGill University</a>. This work was supported in part by the United States Air Force Office of Scientific Research (grant #F49620-99-1-0293). </p> | |||
| </div> | |||
| </div></div><!-- contents --> | |||
| <HR> | |||
| <table><tr><td><img src="../images/mcgill.gif" width=165></td> | |||
| <td>©2001-2012 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| <td>©2001-2013 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| </table> | |||
| </BODY> | |||
| </HTML> | |||
+ 16
- 11
doc/html/annotated.html
View File
| @@ -8,21 +8,26 @@ | |||
| <CENTER> | |||
| <a class="qindex" href="index.html">Home</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.6.2 --> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="headertitle"> | |||
| <div class="title">Class List</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table> | |||
| <tr><td class="indexkey"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td class="indexvalue">The public device information structure for returning queried values </td></tr> | |||
| <tr><td class="indexkey"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="indexvalue">Realtime audio i/o C++ classes </td></tr> | |||
| <tr><td class="indexkey"><a class="el" href="classRtError.html">RtError</a></td><td class="indexvalue">Exception handling class for <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> & RtMidi </td></tr> | |||
| <tr><td class="indexkey"><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a></td><td class="indexvalue">The structure for specifying stream options </td></tr> | |||
| <tr><td class="indexkey"><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a></td><td class="indexvalue">The structure for specifying input or ouput stream parameters </td></tr> | |||
| <div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory"> | |||
| <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory"> | |||
| <tr id="row_0_" class="even"><td class="entry"><img id="arr_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('0_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classRtAudio.html" target="_self">RtAudio</a></td><td class="desc">Realtime audio i/o C++ classes</td></tr> | |||
| <tr id="row_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structRtAudio_1_1DeviceInfo.html" target="_self">DeviceInfo</a></td><td class="desc">The public device information structure for returning queried values</td></tr> | |||
| <tr id="row_0_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structRtAudio_1_1StreamOptions.html" target="_self">StreamOptions</a></td><td class="desc">The structure for specifying stream options</td></tr> | |||
| <tr id="row_0_2_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structRtAudio_1_1StreamParameters.html" target="_self">StreamParameters</a></td><td class="desc">The structure for specifying input or ouput stream parameters</td></tr> | |||
| <tr id="row_1_" class="even"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classRtError.html" target="_self">RtError</a></td><td class="desc">Exception handling class for <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> & RtMidi</td></tr> | |||
| </table> | |||
| </div> | |||
| </div><!-- directory --> | |||
| </div><!-- contents --> | |||
| <HR> | |||
| <table><tr><td><img src="../images/mcgill.gif" width=165></td> | |||
| <td>©2001-2012 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| <td>©2001-2013 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| </table> | |||
| </BODY> | |||
| </HTML> | |||
+ 21
- 20
doc/html/apinotes.html
View File
| @@ -8,38 +8,39 @@ | |||
| <CENTER> | |||
| <a class="qindex" href="index.html">Home</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.6.2 --> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="headertitle"> | |||
| <div class="title">API Notes </div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1><a class="anchor" id="apinotes">API Notes </a></h1><p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> is designed to provide a common API across the various supported operating systems and audio libraries. Despite that, some issues should be mentioned with regard to each.</p> | |||
| <h2><a class="anchor" id="linux"> | |||
| Linux:</a></h2> | |||
| <div class="textblock"><p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> is designed to provide a common API across the various supported operating systems and audio libraries. Despite that, some issues should be mentioned with regard to each.</p> | |||
| <h1><a class="anchor" id="linux"></a> | |||
| Linux:</h1> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> for Linux was developed under Redhat distributions 7.0 - Fedora. Four different audio APIs are supported on Linux platforms: <a href="http://www.opensound.com/oss.html">OSS</a> (versions >= 4.0), <a href="http://www.alsa-project.org/">ALSA</a>, <a href="http://jackit.sourceforge.net/">Jack</a>, and <a href="http://www.freedesktop.org/wiki/Software/PulseAudio">PulseAudio</a>. Note that <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> now only supports the newer version 4.0 OSS API. The ALSA API is now part of the Linux kernel and offers significantly better functionality than the OSS API. <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> provides support for the 1.0 and higher versions of ALSA. Jack is a low-latency audio server written primarily for the GNU/Linux operating system. It can connect a number of different applications to an audio device, as well as allow them to share audio between themselves. Input/output latency on the order of 15 milliseconds can typically be achieved using any of the Linux APIs by fine-tuning the <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">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> | |||
| <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" title="Realtime audio i/o C++ classes.">RtAudio</a> tests, it is recommended that the native ALSA implementation of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> be used on systems which have ALSA drivers installed.</p> | |||
| <p>The ALSA implementation of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> makes no use of the ALSA "plug" interface. All necessary data format conversions, channel compensation, de-interleaving, and byte-swapping is handled by internal <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> routines.</p> | |||
| <h2><a class="anchor" id="macosx"> | |||
| Macintosh OS-X (CoreAudio and Jack):</a></h2> | |||
| <p>The Apple CoreAudio API is designed to use a separate callback procedure for each of its audio devices. A single <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> duplex stream using two different devices is supported, though it cannot be guaranteed to always behave correctly because we cannot synchronize these two callbacks. The <em>numberOfBuffers</em> parameter to the <a class="el" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">RtAudio::openStream()</a> function has no affect in this implementation.</p> | |||
| <h1><a class="anchor" id="macosx"></a> | |||
| Macintosh OS-X (CoreAudio and Jack):</h1> | |||
| <p>The Apple CoreAudio API is designed to use a separate callback procedure for each of its audio devices. A single <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> duplex stream using two different devices is supported, though it cannot be guaranteed to always behave correctly because we cannot synchronize these two callbacks. The <em>numberOfBuffers</em> parameter to the <a class="el" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b" title="A public function for opening a stream with the specified parameters.">RtAudio::openStream()</a> function has no affect in this implementation.</p> | |||
| <p>It is not possible to have multiple instances of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> accessing the same CoreAudio device.</p> | |||
| <p>The <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> Jack support can be compiled on Macintosh OS-X systems, as well as in Linux.</p> | |||
| <h2><a class="anchor" id="windowsds"> | |||
| Windows (DirectSound):</a></h2> | |||
| <p>The <code>configure</code> script provides support for the MinGW compiler. DirectSound support is specified with the "--with-ds" flag.</p> | |||
| <h1><a class="anchor" id="windowsds"></a> | |||
| Windows (DirectSound):</h1> | |||
| <p>The <code>configure</code> script provides support for the MinGW compiler. DirectSound support is specified with the "&ndash;with-ds" flag.</p> | |||
| <p>In order to compile <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> under Windows for the DirectSound API, 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. Audio output latency with DirectSound can be reasonably good, especially since <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> version 3.0.2. Input audio latency still tends to be bad but better since version 3.0.2. <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> was originally developed with Visual C++ version 6.0 but has been tested with .NET.</p> | |||
| <p>The DirectSound version of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> can be compiled with or without the UNICODE preprocessor definition.</p> | |||
| <h2><a class="anchor" id="windowsasio"> | |||
| Windows (ASIO):</a></h2> | |||
| <p>ASIO support using MinGW and the <code>configure</code> script is specified with the "--with-asio" flag.</p> | |||
| <p>The Steinberg ASIO audio API allows only a single device driver to be loaded and accessed at a time. ASIO device drivers must be supplied by audio hardware manufacturers, though ASIO emulation is possible on top of systems with DirectSound drivers. The <em>numberOfBuffers</em> parameter to the <a class="el" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">RtAudio::openStream()</a> function has no affect in this implementation.</p> | |||
| <h1><a class="anchor" id="windowsasio"></a> | |||
| Windows (ASIO):</h1> | |||
| <p>ASIO support using MinGW and the <code>configure</code> script is specified with the "&ndash;with-asio" flag.</p> | |||
| <p>The Steinberg ASIO audio API allows only a single device driver to be loaded and accessed at a time. ASIO device drivers must be supplied by audio hardware manufacturers, though ASIO emulation is possible on top of systems with DirectSound drivers. The <em>numberOfBuffers</em> parameter to the <a class="el" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b" title="A public function for opening a stream with the specified parameters.">RtAudio::openStream()</a> function has no affect in this implementation.</p> | |||
| <p>A number of ASIO source and header files are required for use with <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>. Specifically, an <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> project must include the following files: <code>asio.h,cpp; asiodrivers.h,cpp; asiolist.h,cpp; asiodrvr.h; asiosys.h; ginclude.h; iasiodrv.h; iasiothiscallresolver.h,cpp</code>. The Visual C++ projects found in <code>/tests/Windows/</code> compile both ASIO and DirectSound support.</p> | |||
| <p>The Steinberg provided <code>asiolist</code> class does not compile when the preprocessor definition UNICODE is defined. Note that this could be an issue when using <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> with Qt, though Qt programs appear to compile without the UNICODE definition (try <code>DEFINES -= UNICODE</code> in your .pro file). <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> with ASIO support has been tested using the MinGW compiler under Windows XP, as well as in the Visual Studio environment. </p> | |||
| </div> | |||
| </div></div><!-- contents --> | |||
| <HR> | |||
| <table><tr><td><img src="../images/mcgill.gif" width=165></td> | |||
| <td>©2001-2012 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| <td>©2001-2013 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| </table> | |||
| </BODY> | |||
| </HTML> | |||
+ 41
- 35
doc/html/classRtAudio-members.html
View File
| @@ -8,44 +8,50 @@ | |||
| <CENTER> | |||
| <a class="qindex" href="index.html">Home</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.6.2 --> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="headertitle"> | |||
| <div class="title">RtAudio Member List</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <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.<table> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#ad0586b47cd6bb9591a80b4052815991f">abortStream</a>(void)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">Api</a> enum name</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a">closeStream</a>(void)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#ae266ffad2ef428d0b2c6c262d391ce26">getCompiledApi</a>(std::vector< RtAudio::Api > &apis)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [static]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#a83687634795792b2c47e4ae1cf8a5246">getCurrentApi</a>(void)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#aad8b94edd3cd379ee300b125750ac6ce">getDefaultInputDevice</a>(void)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc">getDefaultOutputDevice</a>(void)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a">getDeviceCount</a>(void)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#a02d7ff44ad1d7eae22283a052f3dfda8">getDeviceInfo</a>(unsigned int device)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#a843c989d9f501c71bc2f2c5ca18df9f3">getStreamLatency</a>(void)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#a28214b8b05d60b45c24ee6fae7b2a0b5">getStreamSampleRate</a>(void)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#a344e59a62353c5791db4621b985cb2ca">getStreamTime</a>(void)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f">isStreamOpen</a>(void) const </td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#a84cc8d9b7ab9bc5f37bcf48430ec5aea">isStreamRunning</a>(void) const </td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa7a2ba095c2806caa893b6fb8fc3a1a8">LINUX_ALSA</a> enum value</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a39c84615e61de75e6a4e865596d62c82">LINUX_OSS</a> enum value</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849adc17dff310e85d303fb326c837c08d77">LINUX_PULSE</a> enum value</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a9fec92b8272244a87a6a11a717bd662d">MACOSX_CORE</a> enum value</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8">openStream</a>(RtAudio::StreamParameters *outputParameters, RtAudio::StreamParameters *inputParameters, RtAudioFormat format, unsigned int sampleRate, unsigned int *bufferFrames, RtAudioCallback callback, void *userData=NULL, RtAudio::StreamOptions *options=NULL)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#afd0bfa26deae9804e18faff59d0273d9">RtAudio</a>(RtAudio::Api api=UNSPECIFIED)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849ab06b8fd88bf18c9a2b8271f6961ae2d1">RTAUDIO_DUMMY</a> enum value</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77">showWarnings</a>(bool value=true)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80">startStream</a>(void)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd">stopStream</a>(void)</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a4767e17c6edfbd827f91763915df4105">UNIX_JACK</a> enum value</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae">UNSPECIFIED</a> enum value</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a219517d1df90f94d07758481155bd469">WINDOWS_ASIO</a> enum value</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931">WINDOWS_DS</a> enum value</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtAudio.html#aa8a9716fd64680657ef69c9465442a2f">~RtAudio</a>()</td><td><a class="el" href="classRtAudio.html">RtAudio</a></td><td></td></tr> | |||
| </table></div> | |||
| <HR> | |||
| <p>This is the complete list of members for <a class="el" href="classRtAudio.html">RtAudio</a>, including all inherited members.</p> | |||
| <table class="directory"> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#ad0586b47cd6bb9591a80b4052815991f">abortStream</a>(void)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">Api</a> enum name</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a">closeStream</a>(void)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#ae266ffad2ef428d0b2c6c262d391ce26">getCompiledApi</a>(std::vector< RtAudio::Api > &apis)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">static</span></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#a83687634795792b2c47e4ae1cf8a5246">getCurrentApi</a>(void)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#aad8b94edd3cd379ee300b125750ac6ce">getDefaultInputDevice</a>(void)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc">getDefaultOutputDevice</a>(void)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a">getDeviceCount</a>(void)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#a02d7ff44ad1d7eae22283a052f3dfda8">getDeviceInfo</a>(unsigned int device)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#a843c989d9f501c71bc2f2c5ca18df9f3">getStreamLatency</a>(void)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#a28214b8b05d60b45c24ee6fae7b2a0b5">getStreamSampleRate</a>(void)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#a344e59a62353c5791db4621b985cb2ca">getStreamTime</a>(void)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#afee36f6d32f4744ffa7471a0ce7a3856">getVersion</a>(void)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f">isStreamOpen</a>(void) const </td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#a84cc8d9b7ab9bc5f37bcf48430ec5aea">isStreamRunning</a>(void) const </td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa7a2ba095c2806caa893b6fb8fc3a1a8">LINUX_ALSA</a> enum value</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a39c84615e61de75e6a4e865596d62c82">LINUX_OSS</a> enum value</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849adc17dff310e85d303fb326c837c08d77">LINUX_PULSE</a> enum value</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a9fec92b8272244a87a6a11a717bd662d">MACOSX_CORE</a> enum value</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b">openStream</a>(RtAudio::StreamParameters *outputParameters, RtAudio::StreamParameters *inputParameters, RtAudioFormat format, unsigned int sampleRate, unsigned int *bufferFrames, RtAudioCallback callback, void *userData=NULL, RtAudio::StreamOptions *options=NULL, RtAudioErrorCallback errorCallback=NULL)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#afd0bfa26deae9804e18faff59d0273d9">RtAudio</a>(RtAudio::Api api=UNSPECIFIED)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849ab06b8fd88bf18c9a2b8271f6961ae2d1">RTAUDIO_DUMMY</a> enum value</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77">showWarnings</a>(bool value=true)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80">startStream</a>(void)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd">stopStream</a>(void)</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a4767e17c6edfbd827f91763915df4105">UNIX_JACK</a> enum value</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae">UNSPECIFIED</a> enum value</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a219517d1df90f94d07758481155bd469">WINDOWS_ASIO</a> enum value</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931">WINDOWS_DS</a> enum value</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtAudio.html#aa8a9716fd64680657ef69c9465442a2f">~RtAudio</a>()</td><td class="entry"><a class="el" href="classRtAudio.html">RtAudio</a></td><td class="entry"></td></tr> | |||
| </table></div><!-- contents --> | |||
| <HR> | |||
| <table><tr><td><img src="../images/mcgill.gif" width=165></td> | |||
| <td>©2001-2012 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| <td>©2001-2013 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| </table> | |||
| </BODY> | |||
| </HTML> | |||
+ 326
- 213
doc/html/classRtAudio.html
View File
| @@ -8,96 +8,138 @@ | |||
| <CENTER> | |||
| <a class="qindex" href="index.html">Home</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.6.2 --> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="summary"> | |||
| <a href="#nested-classes">Classes</a> | | |||
| <a href="#pub-types">Public Types</a> | | |||
| <a href="#pub-methods">Public Member Functions</a> | | |||
| <a href="#pub-static-methods">Static Public Member Functions</a> | | |||
| <a href="classRtAudio-members.html">List of all members</a> </div> | |||
| <div class="headertitle"> | |||
| <div class="title">RtAudio Class Reference</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>RtAudio Class Reference</h1><!-- doxytag: class="RtAudio" --> | |||
| <p>Realtime audio i/o C++ classes. | |||
| <a href="#_details">More...</a></p> | |||
| <a href="classRtAudio.html#details">More...</a></p> | |||
| <p><code>#include <<a class="el" href="RtAudio_8h_source.html">RtAudio.h</a>></code></p> | |||
| <p><a href="classRtAudio-members.html">List of all members.</a></p> | |||
| <table border="0" cellpadding="0" cellspacing="0"> | |||
| <tr><td colspan="2"><h2>Classes</h2></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html">DeviceInfo</a></td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The public device information structure for returning queried values. <a href="structRtAudio_1_1DeviceInfo.html#_details">More...</a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamOptions.html">StreamOptions</a></td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The structure for specifying stream options. <a href="structRtAudio_1_1StreamOptions.html#_details">More...</a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html">StreamParameters</a></td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The structure for specifying input or ouput stream parameters. <a href="structRtAudio_1_1StreamParameters.html#_details">More...</a><br/></td></tr> | |||
| <tr><td colspan="2"><h2>Public Types</h2></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">Api</a> { <br/> | |||
| <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae">UNSPECIFIED</a>, | |||
| <table class="memberdecls"> | |||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> | |||
| Classes</h2></td></tr> | |||
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html">DeviceInfo</a></td></tr> | |||
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The public device information structure for returning queried values. <a href="structRtAudio_1_1DeviceInfo.html#details">More...</a><br/></td></tr> | |||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamOptions.html">StreamOptions</a></td></tr> | |||
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The structure for specifying stream options. <a href="structRtAudio_1_1StreamOptions.html#details">More...</a><br/></td></tr> | |||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html">StreamParameters</a></td></tr> | |||
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The structure for specifying input or ouput stream parameters. <a href="structRtAudio_1_1StreamParameters.html#details">More...</a><br/></td></tr> | |||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | |||
| </table><table class="memberdecls"> | |||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> | |||
| Public Types</h2></td></tr> | |||
| <tr class="memitem:ac9b6f625da88249d08a8409a9db0d849"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">Api</a> { <br/> | |||
|   <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae">UNSPECIFIED</a>, | |||
| <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa7a2ba095c2806caa893b6fb8fc3a1a8">LINUX_ALSA</a>, | |||
| <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849adc17dff310e85d303fb326c837c08d77">LINUX_PULSE</a>, | |||
| <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a39c84615e61de75e6a4e865596d62c82">LINUX_OSS</a>, | |||
| <br/> | |||
| <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a4767e17c6edfbd827f91763915df4105">UNIX_JACK</a>, | |||
|   <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a4767e17c6edfbd827f91763915df4105">UNIX_JACK</a>, | |||
| <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a9fec92b8272244a87a6a11a717bd662d">MACOSX_CORE</a>, | |||
| <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a219517d1df90f94d07758481155bd469">WINDOWS_ASIO</a>, | |||
| <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931">WINDOWS_DS</a>, | |||
| <br/> | |||
| <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849ab06b8fd88bf18c9a2b8271f6961ae2d1">RTAUDIO_DUMMY</a> | |||
|   <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849ab06b8fd88bf18c9a2b8271f6961ae2d1">RTAUDIO_DUMMY</a> | |||
| <br/> | |||
| }</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Audio API specifier arguments. </p> | |||
| <a href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">More...</a><br/></td></tr> | |||
| <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#afd0bfa26deae9804e18faff59d0273d9">RtAudio</a> (<a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio::Api</a> api=UNSPECIFIED) throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The class constructor. <a href="#afd0bfa26deae9804e18faff59d0273d9"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#aa8a9716fd64680657ef69c9465442a2f">~RtAudio</a> () throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <a href="#aa8a9716fd64680657ef69c9465442a2f"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83687634795792b2c47e4ae1cf8a5246"></a><!-- doxytag: member="RtAudio::getCurrentApi" ref="a83687634795792b2c47e4ae1cf8a5246" args="(void)" --> | |||
| <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio::Api</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a83687634795792b2c47e4ae1cf8a5246">getCurrentApi</a> (void) throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the audio API specifier for the current instance of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>. <br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a">getDeviceCount</a> (void) throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">A public function that queries for the number of audio devices available. <a href="#a747ce2d73803641bbb66d6e78092aa1a"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a02d7ff44ad1d7eae22283a052f3dfda8">getDeviceInfo</a> (unsigned int device)</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Return an <a class="el" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> structure for a specified device number. <a href="#a02d7ff44ad1d7eae22283a052f3dfda8"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc">getDefaultOutputDevice</a> (void) throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">A function that returns the index of the default output device. <a href="#a3a3f3dbe13ea696b521e49cdaaa357bc"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#aad8b94edd3cd379ee300b125750ac6ce">getDefaultInputDevice</a> (void) throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">A function that returns the index of the default input device. <a href="#aad8b94edd3cd379ee300b125750ac6ce"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8">openStream</a> (<a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a> *outputParameters, <a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a> *inputParameters, <a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a> format, unsigned int sampleRate, unsigned int *bufferFrames, <a class="el" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f">RtAudioCallback</a> callback, void *userData=NULL, <a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a> *options=NULL)</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">A public function for opening a stream with the specified parameters. <a href="#afacc99740fa4c5606fb35467cdea6da8"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a">closeStream</a> (void) throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">A function that closes a stream and frees any associated stream memory. <a href="#a90d599002ad32cf250a4cb866f2cc93a"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80">startStream</a> (void)</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">A function that starts a stream. <a href="#aec017a89629ccef66a90b60be22a2f80"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd">stopStream</a> (void)</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a stream, allowing any samples remaining in the output queue to be played. <a href="#af4c241ff86936ecc8108f0d9dfe3efdd"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#ad0586b47cd6bb9591a80b4052815991f">abortStream</a> (void)</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a stream, discarding any samples remaining in the input/output queue. <a href="#ad0586b47cd6bb9591a80b4052815991f"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3863e45ff81dbe97176de0ee7545917f"></a><!-- doxytag: member="RtAudio::isStreamOpen" ref="a3863e45ff81dbe97176de0ee7545917f" args="(void) const " --> | |||
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f">isStreamOpen</a> (void) const throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a stream is open and false if not. <br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84cc8d9b7ab9bc5f37bcf48430ec5aea"></a><!-- doxytag: member="RtAudio::isStreamRunning" ref="a84cc8d9b7ab9bc5f37bcf48430ec5aea" args="(void) const " --> | |||
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a84cc8d9b7ab9bc5f37bcf48430ec5aea">isStreamRunning</a> (void) const throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the stream is running and false if it is stopped or not open. <br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a344e59a62353c5791db4621b985cb2ca">getStreamTime</a> (void)</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of elapsed seconds since the stream was started. <a href="#a344e59a62353c5791db4621b985cb2ca"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a843c989d9f501c71bc2f2c5ca18df9f3">getStreamLatency</a> (void)</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the internal stream latency in sample frames. <a href="#a843c989d9f501c71bc2f2c5ca18df9f3"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a28214b8b05d60b45c24ee6fae7b2a0b5">getStreamSampleRate</a> (void)</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns actual sample rate in use by the stream. <a href="#a28214b8b05d60b45c24ee6fae7b2a0b5"></a><br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0752ee51cce3dd90a3bd009f9fdbe77"></a><!-- doxytag: member="RtAudio::showWarnings" ref="af0752ee51cce3dd90a3bd009f9fdbe77" args="(bool value=true)" --> | |||
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77">showWarnings</a> (bool value=true) throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Specify whether warning messages should be printed to stderr. <br/></td></tr> | |||
| <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#ae266ffad2ef428d0b2c6c262d391ce26">getCompiledApi</a> (std::vector< <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio::Api</a> > &apis) throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">A static function to determine the available compiled audio APIs. <a href="#ae266ffad2ef428d0b2c6c262d391ce26"></a><br/></td></tr> | |||
| <tr class="memdesc:ac9b6f625da88249d08a8409a9db0d849"><td class="mdescLeft"> </td><td class="mdescRight">Audio API specifier arguments. <a href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">More...</a><br/></td></tr> | |||
| <tr class="separator:ac9b6f625da88249d08a8409a9db0d849"><td class="memSeparator" colspan="2"> </td></tr> | |||
| </table><table class="memberdecls"> | |||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> | |||
| Public Member Functions</h2></td></tr> | |||
| <tr class="memitem:afd0bfa26deae9804e18faff59d0273d9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#afd0bfa26deae9804e18faff59d0273d9">RtAudio</a> (<a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio::Api</a> api=<a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae">UNSPECIFIED</a>) throw ()</td></tr> | |||
| <tr class="memdesc:afd0bfa26deae9804e18faff59d0273d9"><td class="mdescLeft"> </td><td class="mdescRight">The class constructor. <a href="#afd0bfa26deae9804e18faff59d0273d9"></a><br/></td></tr> | |||
| <tr class="separator:afd0bfa26deae9804e18faff59d0273d9"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:aa8a9716fd64680657ef69c9465442a2f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#aa8a9716fd64680657ef69c9465442a2f">~RtAudio</a> () throw ()</td></tr> | |||
| <tr class="memdesc:aa8a9716fd64680657ef69c9465442a2f"><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <a href="#aa8a9716fd64680657ef69c9465442a2f"></a><br/></td></tr> | |||
| <tr class="separator:aa8a9716fd64680657ef69c9465442a2f"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a83687634795792b2c47e4ae1cf8a5246"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83687634795792b2c47e4ae1cf8a5246"></a> | |||
| <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio::Api</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a83687634795792b2c47e4ae1cf8a5246">getCurrentApi</a> (void) throw ()</td></tr> | |||
| <tr class="memdesc:a83687634795792b2c47e4ae1cf8a5246"><td class="mdescLeft"> </td><td class="mdescRight">Returns the audio API specifier for the current instance of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>. <br/></td></tr> | |||
| <tr class="separator:a83687634795792b2c47e4ae1cf8a5246"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a747ce2d73803641bbb66d6e78092aa1a"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a">getDeviceCount</a> (void) throw ()</td></tr> | |||
| <tr class="memdesc:a747ce2d73803641bbb66d6e78092aa1a"><td class="mdescLeft"> </td><td class="mdescRight">A public function that queries for the number of audio devices available. <a href="#a747ce2d73803641bbb66d6e78092aa1a"></a><br/></td></tr> | |||
| <tr class="separator:a747ce2d73803641bbb66d6e78092aa1a"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a02d7ff44ad1d7eae22283a052f3dfda8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a02d7ff44ad1d7eae22283a052f3dfda8">getDeviceInfo</a> (unsigned int device)</td></tr> | |||
| <tr class="memdesc:a02d7ff44ad1d7eae22283a052f3dfda8"><td class="mdescLeft"> </td><td class="mdescRight">Return an <a class="el" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> structure for a specified device number. <a href="#a02d7ff44ad1d7eae22283a052f3dfda8"></a><br/></td></tr> | |||
| <tr class="separator:a02d7ff44ad1d7eae22283a052f3dfda8"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a3a3f3dbe13ea696b521e49cdaaa357bc"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc">getDefaultOutputDevice</a> (void) throw ()</td></tr> | |||
| <tr class="memdesc:a3a3f3dbe13ea696b521e49cdaaa357bc"><td class="mdescLeft"> </td><td class="mdescRight">A function that returns the index of the default output device. <a href="#a3a3f3dbe13ea696b521e49cdaaa357bc"></a><br/></td></tr> | |||
| <tr class="separator:a3a3f3dbe13ea696b521e49cdaaa357bc"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:aad8b94edd3cd379ee300b125750ac6ce"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#aad8b94edd3cd379ee300b125750ac6ce">getDefaultInputDevice</a> (void) throw ()</td></tr> | |||
| <tr class="memdesc:aad8b94edd3cd379ee300b125750ac6ce"><td class="mdescLeft"> </td><td class="mdescRight">A function that returns the index of the default input device. <a href="#aad8b94edd3cd379ee300b125750ac6ce"></a><br/></td></tr> | |||
| <tr class="separator:aad8b94edd3cd379ee300b125750ac6ce"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a6907539d2527775df778ebce32ef1e3b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b">openStream</a> (<a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a> *outputParameters, <a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a> *inputParameters, <a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a> format, unsigned int sampleRate, unsigned int *bufferFrames, <a class="el" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f">RtAudioCallback</a> callback, void *userData=NULL, <a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a> *options=NULL, <a class="el" href="RtAudio_8h.html#a2c8c34d284ae138dd29b53375ec9f062">RtAudioErrorCallback</a> errorCallback=NULL)</td></tr> | |||
| <tr class="memdesc:a6907539d2527775df778ebce32ef1e3b"><td class="mdescLeft"> </td><td class="mdescRight">A public function for opening a stream with the specified parameters. <a href="#a6907539d2527775df778ebce32ef1e3b"></a><br/></td></tr> | |||
| <tr class="separator:a6907539d2527775df778ebce32ef1e3b"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a90d599002ad32cf250a4cb866f2cc93a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a">closeStream</a> (void) throw ()</td></tr> | |||
| <tr class="memdesc:a90d599002ad32cf250a4cb866f2cc93a"><td class="mdescLeft"> </td><td class="mdescRight">A function that closes a stream and frees any associated stream memory. <a href="#a90d599002ad32cf250a4cb866f2cc93a"></a><br/></td></tr> | |||
| <tr class="separator:a90d599002ad32cf250a4cb866f2cc93a"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:aec017a89629ccef66a90b60be22a2f80"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80">startStream</a> (void)</td></tr> | |||
| <tr class="memdesc:aec017a89629ccef66a90b60be22a2f80"><td class="mdescLeft"> </td><td class="mdescRight">A function that starts a stream. <a href="#aec017a89629ccef66a90b60be22a2f80"></a><br/></td></tr> | |||
| <tr class="separator:aec017a89629ccef66a90b60be22a2f80"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:af4c241ff86936ecc8108f0d9dfe3efdd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd">stopStream</a> (void)</td></tr> | |||
| <tr class="memdesc:af4c241ff86936ecc8108f0d9dfe3efdd"><td class="mdescLeft"> </td><td class="mdescRight">Stop a stream, allowing any samples remaining in the output queue to be played. <a href="#af4c241ff86936ecc8108f0d9dfe3efdd"></a><br/></td></tr> | |||
| <tr class="separator:af4c241ff86936ecc8108f0d9dfe3efdd"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:ad0586b47cd6bb9591a80b4052815991f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#ad0586b47cd6bb9591a80b4052815991f">abortStream</a> (void)</td></tr> | |||
| <tr class="memdesc:ad0586b47cd6bb9591a80b4052815991f"><td class="mdescLeft"> </td><td class="mdescRight">Stop a stream, discarding any samples remaining in the input/output queue. <a href="#ad0586b47cd6bb9591a80b4052815991f"></a><br/></td></tr> | |||
| <tr class="separator:ad0586b47cd6bb9591a80b4052815991f"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a3863e45ff81dbe97176de0ee7545917f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3863e45ff81dbe97176de0ee7545917f"></a> | |||
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f">isStreamOpen</a> (void) const throw ()</td></tr> | |||
| <tr class="memdesc:a3863e45ff81dbe97176de0ee7545917f"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a stream is open and false if not. <br/></td></tr> | |||
| <tr class="separator:a3863e45ff81dbe97176de0ee7545917f"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a84cc8d9b7ab9bc5f37bcf48430ec5aea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84cc8d9b7ab9bc5f37bcf48430ec5aea"></a> | |||
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a84cc8d9b7ab9bc5f37bcf48430ec5aea">isStreamRunning</a> (void) const throw ()</td></tr> | |||
| <tr class="memdesc:a84cc8d9b7ab9bc5f37bcf48430ec5aea"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the stream is running and false if it is stopped or not open. <br/></td></tr> | |||
| <tr class="separator:a84cc8d9b7ab9bc5f37bcf48430ec5aea"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a344e59a62353c5791db4621b985cb2ca"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a344e59a62353c5791db4621b985cb2ca">getStreamTime</a> (void)</td></tr> | |||
| <tr class="memdesc:a344e59a62353c5791db4621b985cb2ca"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of elapsed seconds since the stream was started. <a href="#a344e59a62353c5791db4621b985cb2ca"></a><br/></td></tr> | |||
| <tr class="separator:a344e59a62353c5791db4621b985cb2ca"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a843c989d9f501c71bc2f2c5ca18df9f3"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a843c989d9f501c71bc2f2c5ca18df9f3">getStreamLatency</a> (void)</td></tr> | |||
| <tr class="memdesc:a843c989d9f501c71bc2f2c5ca18df9f3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the internal stream latency in sample frames. <a href="#a843c989d9f501c71bc2f2c5ca18df9f3"></a><br/></td></tr> | |||
| <tr class="separator:a843c989d9f501c71bc2f2c5ca18df9f3"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a28214b8b05d60b45c24ee6fae7b2a0b5"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#a28214b8b05d60b45c24ee6fae7b2a0b5">getStreamSampleRate</a> (void)</td></tr> | |||
| <tr class="memdesc:a28214b8b05d60b45c24ee6fae7b2a0b5"><td class="mdescLeft"> </td><td class="mdescRight">Returns actual sample rate in use by the stream. <a href="#a28214b8b05d60b45c24ee6fae7b2a0b5"></a><br/></td></tr> | |||
| <tr class="separator:a28214b8b05d60b45c24ee6fae7b2a0b5"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:af0752ee51cce3dd90a3bd009f9fdbe77"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0752ee51cce3dd90a3bd009f9fdbe77"></a> | |||
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77">showWarnings</a> (bool value=true) throw ()</td></tr> | |||
| <tr class="memdesc:af0752ee51cce3dd90a3bd009f9fdbe77"><td class="mdescLeft"> </td><td class="mdescRight">Specify whether warning messages should be printed to stderr. <br/></td></tr> | |||
| <tr class="separator:af0752ee51cce3dd90a3bd009f9fdbe77"><td class="memSeparator" colspan="2"> </td></tr> | |||
| </table><table class="memberdecls"> | |||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> | |||
| Static Public Member Functions</h2></td></tr> | |||
| <tr class="memitem:afee36f6d32f4744ffa7471a0ce7a3856"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afee36f6d32f4744ffa7471a0ce7a3856"></a> | |||
| static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#afee36f6d32f4744ffa7471a0ce7a3856">getVersion</a> (void)</td></tr> | |||
| <tr class="memdesc:afee36f6d32f4744ffa7471a0ce7a3856"><td class="mdescLeft"> </td><td class="mdescRight">A static function to determine the current <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> version. <br/></td></tr> | |||
| <tr class="separator:afee36f6d32f4744ffa7471a0ce7a3856"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:ae266ffad2ef428d0b2c6c262d391ce26"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtAudio.html#ae266ffad2ef428d0b2c6c262d391ce26">getCompiledApi</a> (std::vector< <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio::Api</a> > &apis) throw ()</td></tr> | |||
| <tr class="memdesc:ae266ffad2ef428d0b2c6c262d391ce26"><td class="mdescLeft"> </td><td class="mdescRight">A static function to determine the available compiled audio APIs. <a href="#ae266ffad2ef428d0b2c6c262d391ce26"></a><br/></td></tr> | |||
| <tr class="separator:ae266ffad2ef428d0b2c6c262d391ce26"><td class="memSeparator" colspan="2"> </td></tr> | |||
| </table> | |||
| <hr/><a name="_details"></a><h2>Detailed Description</h2> | |||
| <p>Realtime audio i/o C++ classes. </p> | |||
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> | |||
| <div class="textblock"><p>Realtime audio i/o C++ classes. </p> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> provides a common API (Application Programming Interface) for realtime audio input/output across Linux (native ALSA, Jack, and OSS), Macintosh OS X (CoreAudio and Jack), and Windows (DirectSound and ASIO) operating systems.</p> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> WWW site: <a href="http://www.music.mcgill.ca/~gary/rtaudio/">http://www.music.mcgill.ca/~gary/rtaudio/</a></p> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>: realtime audio i/o C++ classes Copyright (c) 2001-2012 Gary P. Scavone</p> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>: realtime audio i/o C++ classes Copyright (c) 2001-2013 Gary P. Scavone</p> | |||
| <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p> | |||
| <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p> | |||
| <p>Any person wishing to distribute modifications to the Software is asked to send the modifications to the original developer so that they can be incorporated into the canonical version. This is, however, not a binding provision of this license.</p> | |||
| <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p> | |||
| <hr/><h2>Member Enumeration Documentation</h2> | |||
| <a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849"></a><!-- doxytag: member="RtAudio::Api" ref="ac9b6f625da88249d08a8409a9db0d849" args="" --> | |||
| </div><h2 class="groupheader">Member Enumeration Documentation</h2> | |||
| <a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| @@ -105,36 +147,35 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="clas | |||
| <td class="memname">enum <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio::Api</a></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>Audio API specifier arguments. </p> | |||
| <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae"></a><!-- doxytag: member="UNSPECIFIED" ref="ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae" args="" -->UNSPECIFIED</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae"></a>UNSPECIFIED</em> </td><td> | |||
| <p>Search for a working compiled API. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849aa7a2ba095c2806caa893b6fb8fc3a1a8"></a><!-- doxytag: member="LINUX_ALSA" ref="ac9b6f625da88249d08a8409a9db0d849aa7a2ba095c2806caa893b6fb8fc3a1a8" args="" -->LINUX_ALSA</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849aa7a2ba095c2806caa893b6fb8fc3a1a8"></a>LINUX_ALSA</em> </td><td> | |||
| <p>The Advanced Linux Sound Architecture API. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849adc17dff310e85d303fb326c837c08d77"></a><!-- doxytag: member="LINUX_PULSE" ref="ac9b6f625da88249d08a8409a9db0d849adc17dff310e85d303fb326c837c08d77" args="" -->LINUX_PULSE</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849adc17dff310e85d303fb326c837c08d77"></a>LINUX_PULSE</em> </td><td> | |||
| <p>The Linux PulseAudio API. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849a39c84615e61de75e6a4e865596d62c82"></a><!-- doxytag: member="LINUX_OSS" ref="ac9b6f625da88249d08a8409a9db0d849a39c84615e61de75e6a4e865596d62c82" args="" -->LINUX_OSS</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849a39c84615e61de75e6a4e865596d62c82"></a>LINUX_OSS</em> </td><td> | |||
| <p>The Linux Open Sound System API. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849a4767e17c6edfbd827f91763915df4105"></a><!-- doxytag: member="UNIX_JACK" ref="ac9b6f625da88249d08a8409a9db0d849a4767e17c6edfbd827f91763915df4105" args="" -->UNIX_JACK</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849a4767e17c6edfbd827f91763915df4105"></a>UNIX_JACK</em> </td><td> | |||
| <p>The Jack Low-Latency Audio Server API. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849a9fec92b8272244a87a6a11a717bd662d"></a><!-- doxytag: member="MACOSX_CORE" ref="ac9b6f625da88249d08a8409a9db0d849a9fec92b8272244a87a6a11a717bd662d" args="" -->MACOSX_CORE</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849a9fec92b8272244a87a6a11a717bd662d"></a>MACOSX_CORE</em> </td><td> | |||
| <p>Macintosh OS-X Core Audio API. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849a219517d1df90f94d07758481155bd469"></a><!-- doxytag: member="WINDOWS_ASIO" ref="ac9b6f625da88249d08a8409a9db0d849a219517d1df90f94d07758481155bd469" args="" -->WINDOWS_ASIO</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849a219517d1df90f94d07758481155bd469"></a>WINDOWS_ASIO</em> </td><td> | |||
| <p>The Steinberg Audio Stream I/O API. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931"></a><!-- doxytag: member="WINDOWS_DS" ref="ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931" args="" -->WINDOWS_DS</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931"></a>WINDOWS_DS</em> </td><td> | |||
| <p>The Microsoft Direct Sound API. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849ab06b8fd88bf18c9a2b8271f6961ae2d1"></a><!-- doxytag: member="RTAUDIO_DUMMY" ref="ac9b6f625da88249d08a8409a9db0d849ab06b8fd88bf18c9a2b8271f6961ae2d1" args="" -->RTAUDIO_DUMMY</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ac9b6f625da88249d08a8409a9db0d849ab06b8fd88bf18c9a2b8271f6961ae2d1"></a>RTAUDIO_DUMMY</em> </td><td> | |||
| <p>A compilable but non-functional API. </p> | |||
| </td></tr> | |||
| </table> | |||
| @@ -143,22 +184,20 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="clas | |||
| </div> | |||
| </div> | |||
| <hr/><h2>Constructor & Destructor Documentation</h2> | |||
| <a class="anchor" id="afd0bfa26deae9804e18faff59d0273d9"></a><!-- doxytag: member="RtAudio::RtAudio" ref="afd0bfa26deae9804e18faff59d0273d9" args="(RtAudio::Api api=UNSPECIFIED)" --> | |||
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> | |||
| <a class="anchor" id="afd0bfa26deae9804e18faff59d0273d9"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">RtAudio::RtAudio </td> | |||
| <td>(</td> | |||
| <td class="paramtype"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio::Api</a> </td> | |||
| <td class="paramname"> <em>api</em> = <code>UNSPECIFIED</code></td> | |||
| <td> ) </td> | |||
| <td class="paramtype"><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio::Api</a> </td> | |||
| <td class="paramname"><em>api</em> = <code><a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa49af3ac767106158bc6cad74fb214ae">UNSPECIFIED</a></code></td><td>)</td> | |||
| <td> throw ()</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>The class constructor. </p> | |||
| <p>The constructor performs minor initialization tasks. No exceptions can be thrown.</p> | |||
| @@ -166,354 +205,430 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="clas | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="aa8a9716fd64680657ef69c9465442a2f"></a><!-- doxytag: member="RtAudio::~RtAudio" ref="aa8a9716fd64680657ef69c9465442a2f" args="()" --> | |||
| <a class="anchor" id="aa8a9716fd64680657ef69c9465442a2f"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">RtAudio::~RtAudio </td> | |||
| <td>(</td> | |||
| <td class="paramname"></td> | |||
| <td> ) </td> | |||
| <td class="paramname"></td><td>)</td> | |||
| <td> throw ()</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>The destructor. </p> | |||
| <p>If a stream is running or open, it will be stopped and closed automatically. </p> | |||
| </div> | |||
| </div> | |||
| <hr/><h2>Member Function Documentation</h2> | |||
| <a class="anchor" id="ae266ffad2ef428d0b2c6c262d391ce26"></a><!-- doxytag: member="RtAudio::getCompiledApi" ref="ae266ffad2ef428d0b2c6c262d391ce26" args="(std::vector< RtAudio::Api > &apis)" --> | |||
| <h2 class="groupheader">Member Function Documentation</h2> | |||
| <a class="anchor" id="ae266ffad2ef428d0b2c6c262d391ce26"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="mlabels"> | |||
| <tr> | |||
| <td class="mlabels-left"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">static void RtAudio::getCompiledApi </td> | |||
| <td>(</td> | |||
| <td class="paramtype">std::vector< <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio::Api</a> > & </td> | |||
| <td class="paramname"> <em>apis</em></td> | |||
| <td> ) </td> | |||
| <td> throw ()<code> [static]</code></td> | |||
| <td class="paramtype">std::vector< <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio::Api</a> > & </td> | |||
| <td class="paramname"><em>apis</em></td><td>)</td> | |||
| <td> throw ()</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </td> | |||
| <td class="mlabels-right"> | |||
| <span class="mlabels"><span class="mlabel">static</span></span> </td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p>A static function to determine the available compiled audio APIs. </p> | |||
| <p>The values returned in the std::vector can be compared against the enumerated list values. Note that there can be more than one API compiled for certain operating systems. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a747ce2d73803641bbb66d6e78092aa1a"></a><!-- doxytag: member="RtAudio::getDeviceCount" ref="a747ce2d73803641bbb66d6e78092aa1a" args="(void)" --> | |||
| <a class="anchor" id="a747ce2d73803641bbb66d6e78092aa1a"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="mlabels"> | |||
| <tr> | |||
| <td class="mlabels-left"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">unsigned int RtAudio::getDeviceCount </td> | |||
| <td>(</td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td> | |||
| <td> ) </td> | |||
| <td> throw ()<code> [inline]</code></td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td><td>)</td> | |||
| <td> throw ()</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </td> | |||
| <td class="mlabels-right"> | |||
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p>A public function that queries for the number of audio devices available. </p> | |||
| <p>This function performs a system query of available devices each time it is called, thus supporting devices connected <em>after</em> instantiation. If a system error occurs during processing, a warning will be issued. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a02d7ff44ad1d7eae22283a052f3dfda8"></a><!-- doxytag: member="RtAudio::getDeviceInfo" ref="a02d7ff44ad1d7eae22283a052f3dfda8" args="(unsigned int device)" --> | |||
| <a class="anchor" id="a02d7ff44ad1d7eae22283a052f3dfda8"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="mlabels"> | |||
| <tr> | |||
| <td class="mlabels-left"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a> RtAudio::getDeviceInfo </td> | |||
| <td>(</td> | |||
| <td class="paramtype">unsigned int </td> | |||
| <td class="paramname"> <em>device</em></td> | |||
| <td> ) </td> | |||
| <td><code> [inline]</code></td> | |||
| <td class="paramtype">unsigned int </td> | |||
| <td class="paramname"><em>device</em></td><td>)</td> | |||
| <td></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </td> | |||
| <td class="mlabels-right"> | |||
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p>Return an <a class="el" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> structure for a specified device number. </p> | |||
| <p>Any device integer between 0 and <a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount()</a> - 1 is valid. If an invalid argument is provided, an <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> (type = INVALID_USE) will be thrown. If a device is busy or otherwise unavailable, the structure member "probed" will have a value of "false" and all other members are undefined. If the specified device is the current default input or output device, the corresponding "isDefault" member will have a value of "true". </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a3a3f3dbe13ea696b521e49cdaaa357bc"></a><!-- doxytag: member="RtAudio::getDefaultOutputDevice" ref="a3a3f3dbe13ea696b521e49cdaaa357bc" args="(void)" --> | |||
| <a class="anchor" id="a3a3f3dbe13ea696b521e49cdaaa357bc"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="mlabels"> | |||
| <tr> | |||
| <td class="mlabels-left"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">unsigned int RtAudio::getDefaultOutputDevice </td> | |||
| <td>(</td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td> | |||
| <td> ) </td> | |||
| <td> throw ()<code> [inline]</code></td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td><td>)</td> | |||
| <td> throw ()</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </td> | |||
| <td class="mlabels-right"> | |||
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p>A function that returns the index of the default output device. </p> | |||
| <p>If the underlying audio API does not provide a "default | |||
| device", or if no devices are available, the return value will be 0. Note that this is a valid device identifier and it is the client's responsibility to verify that a device is available before attempting to open a stream. </p> | |||
| device", or if no devices are available, the return value will be 0. Note that this is a valid device identifier and it is the client's responsibility to verify that a device is available before attempting to open a stream. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="aad8b94edd3cd379ee300b125750ac6ce"></a><!-- doxytag: member="RtAudio::getDefaultInputDevice" ref="aad8b94edd3cd379ee300b125750ac6ce" args="(void)" --> | |||
| <a class="anchor" id="aad8b94edd3cd379ee300b125750ac6ce"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="mlabels"> | |||
| <tr> | |||
| <td class="mlabels-left"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">unsigned int RtAudio::getDefaultInputDevice </td> | |||
| <td>(</td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td> | |||
| <td> ) </td> | |||
| <td> throw ()<code> [inline]</code></td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td><td>)</td> | |||
| <td> throw ()</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </td> | |||
| <td class="mlabels-right"> | |||
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p>A function that returns the index of the default input device. </p> | |||
| <p>If the underlying audio API does not provide a "default | |||
| device", or if no devices are available, the return value will be 0. Note that this is a valid device identifier and it is the client's responsibility to verify that a device is available before attempting to open a stream. </p> | |||
| device", or if no devices are available, the return value will be 0. Note that this is a valid device identifier and it is the client's responsibility to verify that a device is available before attempting to open a stream. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="afacc99740fa4c5606fb35467cdea6da8"></a><!-- doxytag: member="RtAudio::openStream" ref="afacc99740fa4c5606fb35467cdea6da8" args="(RtAudio::StreamParameters *outputParameters, RtAudio::StreamParameters *inputParameters, RtAudioFormat format, unsigned int sampleRate, unsigned int *bufferFrames, RtAudioCallback callback, void *userData=NULL, RtAudio::StreamOptions *options=NULL)" --> | |||
| <a class="anchor" id="a6907539d2527775df778ebce32ef1e3b"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">void RtAudio::openStream </td> | |||
| <td>(</td> | |||
| <td class="paramtype"><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a> * </td> | |||
| <td class="paramname"> <em>outputParameters</em>, </td> | |||
| <td class="paramtype"><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a> * </td> | |||
| <td class="paramname"><em>outputParameters</em>, </td> | |||
| </tr> | |||
| <tr> | |||
| <td class="paramkey"></td> | |||
| <td></td> | |||
| <td class="paramtype"><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a> * </td> | |||
| <td class="paramname"><em>inputParameters</em>, </td> | |||
| </tr> | |||
| <tr> | |||
| <td class="paramkey"></td> | |||
| <td></td> | |||
| <td class="paramtype"><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a> * </td> | |||
| <td class="paramname"> <em>inputParameters</em>, </td> | |||
| <td class="paramtype"><a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a> </td> | |||
| <td class="paramname"><em>format</em>, </td> | |||
| </tr> | |||
| <tr> | |||
| <td class="paramkey"></td> | |||
| <td></td> | |||
| <td class="paramtype"><a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a> </td> | |||
| <td class="paramname"> <em>format</em>, </td> | |||
| <td class="paramtype">unsigned int </td> | |||
| <td class="paramname"><em>sampleRate</em>, </td> | |||
| </tr> | |||
| <tr> | |||
| <td class="paramkey"></td> | |||
| <td></td> | |||
| <td class="paramtype">unsigned int </td> | |||
| <td class="paramname"> <em>sampleRate</em>, </td> | |||
| <td class="paramtype">unsigned int * </td> | |||
| <td class="paramname"><em>bufferFrames</em>, </td> | |||
| </tr> | |||
| <tr> | |||
| <td class="paramkey"></td> | |||
| <td></td> | |||
| <td class="paramtype">unsigned int * </td> | |||
| <td class="paramname"> <em>bufferFrames</em>, </td> | |||
| <td class="paramtype"><a class="el" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f">RtAudioCallback</a> </td> | |||
| <td class="paramname"><em>callback</em>, </td> | |||
| </tr> | |||
| <tr> | |||
| <td class="paramkey"></td> | |||
| <td></td> | |||
| <td class="paramtype"><a class="el" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f">RtAudioCallback</a> </td> | |||
| <td class="paramname"> <em>callback</em>, </td> | |||
| <td class="paramtype">void * </td> | |||
| <td class="paramname"><em>userData</em> = <code>NULL</code>, </td> | |||
| </tr> | |||
| <tr> | |||
| <td class="paramkey"></td> | |||
| <td></td> | |||
| <td class="paramtype">void * </td> | |||
| <td class="paramname"> <em>userData</em> = <code>NULL</code>, </td> | |||
| <td class="paramtype"><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a> * </td> | |||
| <td class="paramname"><em>options</em> = <code>NULL</code>, </td> | |||
| </tr> | |||
| <tr> | |||
| <td class="paramkey"></td> | |||
| <td></td> | |||
| <td class="paramtype"><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a> * </td> | |||
| <td class="paramname"> <em>options</em> = <code>NULL</code></td><td> </td> | |||
| <td class="paramtype"><a class="el" href="RtAudio_8h.html#a2c8c34d284ae138dd29b53375ec9f062">RtAudioErrorCallback</a> </td> | |||
| <td class="paramname"><em>errorCallback</em> = <code>NULL</code> </td> | |||
| </tr> | |||
| <tr> | |||
| <td></td> | |||
| <td>)</td> | |||
| <td></td><td></td><td></td> | |||
| <td></td><td></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>A public function for opening a stream with the specified parameters. </p> | |||
| <p>An <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> (type = SYSTEM_ERROR) is thrown if a stream cannot be opened with the specified parameters or an error occurs during processing. An <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> (type = INVALID_USE) is thrown if any invalid device ID or channel number parameters are specified.</p> | |||
| <dl><dt><b>Parameters:</b></dt><dd> | |||
| <table border="0" cellspacing="2" cellpadding="0"> | |||
| <tr><td valign="top"></td><td valign="top"><em>outputParameters</em> </td><td>Specifies output stream parameters to use when opening a stream, including a device ID, number of channels, and starting channel number. For input-only streams, this argument should be NULL. The device ID is an index value between 0 and <a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount()</a> - 1. </td></tr> | |||
| <tr><td valign="top"></td><td valign="top"><em>inputParameters</em> </td><td>Specifies input stream parameters to use when opening a stream, including a device ID, number of channels, and starting channel number. For output-only streams, this argument should be NULL. The device ID is an index value between 0 and <a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount()</a> - 1. </td></tr> | |||
| <tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>An RtAudioFormat specifying the desired sample data format. </td></tr> | |||
| <tr><td valign="top"></td><td valign="top"><em>sampleRate</em> </td><td>The desired sample rate (sample frames per second). </td></tr> | |||
| <tr><td valign="top"></td><td valign="top"><em>*bufferFrames</em> </td><td>A pointer to a value indicating the desired internal buffer size in sample frames. The actual value used by the device is returned via the same pointer. A value of zero can be specified, in which case the lowest allowable value is determined. </td></tr> | |||
| <tr><td valign="top"></td><td valign="top"><em>callback</em> </td><td>A client-defined function that will be invoked when input data is available and/or output data is needed. </td></tr> | |||
| <tr><td valign="top"></td><td valign="top"><em>userData</em> </td><td>An optional pointer to data that can be accessed from within the callback function. </td></tr> | |||
| <tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>An optional pointer to a structure containing various global stream options, including a list of OR'ed RtAudioStreamFlags and a suggested number of stream buffers that can be used to control stream latency. More buffers typically result in more robust performance, though at a cost of greater latency. If a value of zero is specified, a system-specific median value is chosen. If the RTAUDIO_MINIMIZE_LATENCY flag bit is set, the lowest allowable value is used. The actual value used is returned via the structure argument. The parameter is API dependent. </td></tr> | |||
| <dl class="params"><dt>Parameters</dt><dd> | |||
| <table class="params"> | |||
| <tr><td class="paramname">outputParameters</td><td>Specifies output stream parameters to use when opening a stream, including a device ID, number of channels, and starting channel number. For input-only streams, this argument should be NULL. The device ID is an index value between 0 and <a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount()</a> - 1. </td></tr> | |||
| <tr><td class="paramname">inputParameters</td><td>Specifies input stream parameters to use when opening a stream, including a device ID, number of channels, and starting channel number. For output-only streams, this argument should be NULL. The device ID is an index value between 0 and <a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount()</a> - 1. </td></tr> | |||
| <tr><td class="paramname">format</td><td>An RtAudioFormat specifying the desired sample data format. </td></tr> | |||
| <tr><td class="paramname">sampleRate</td><td>The desired sample rate (sample frames per second). </td></tr> | |||
| <tr><td class="paramname">*bufferFrames</td><td>A pointer to a value indicating the desired internal buffer size in sample frames. The actual value used by the device is returned via the same pointer. A value of zero can be specified, in which case the lowest allowable value is determined. </td></tr> | |||
| <tr><td class="paramname">callback</td><td>A client-defined function that will be invoked when input data is available and/or output data is needed. </td></tr> | |||
| <tr><td class="paramname">userData</td><td>An optional pointer to data that can be accessed from within the callback function. </td></tr> | |||
| <tr><td class="paramname">options</td><td>An optional pointer to a structure containing various global stream options, including a list of OR'ed RtAudioStreamFlags and a suggested number of stream buffers that can be used to control stream latency. More buffers typically result in more robust performance, though at a cost of greater latency. If a value of zero is specified, a system-specific median value is chosen. If the RTAUDIO_MINIMIZE_LATENCY flag bit is set, the lowest allowable value is used. The actual value used is returned via the structure argument. The parameter is API dependent. </td></tr> | |||
| <tr><td class="paramname">errorCallback</td><td>A client-defined function that will be invoked when an error has occured. </td></tr> | |||
| </table> | |||
| </dd> | |||
| </dl> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a90d599002ad32cf250a4cb866f2cc93a"></a><!-- doxytag: member="RtAudio::closeStream" ref="a90d599002ad32cf250a4cb866f2cc93a" args="(void)" --> | |||
| <a class="anchor" id="a90d599002ad32cf250a4cb866f2cc93a"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="mlabels"> | |||
| <tr> | |||
| <td class="mlabels-left"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">void RtAudio::closeStream </td> | |||
| <td>(</td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td> | |||
| <td> ) </td> | |||
| <td> throw ()<code> [inline]</code></td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td><td>)</td> | |||
| <td> throw ()</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </td> | |||
| <td class="mlabels-right"> | |||
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p>A function that closes a stream and frees any associated stream memory. </p> | |||
| <p>If a stream is not open, this function issues a warning and returns (no exception is thrown). </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="aec017a89629ccef66a90b60be22a2f80"></a><!-- doxytag: member="RtAudio::startStream" ref="aec017a89629ccef66a90b60be22a2f80" args="(void)" --> | |||
| <a class="anchor" id="aec017a89629ccef66a90b60be22a2f80"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="mlabels"> | |||
| <tr> | |||
| <td class="mlabels-left"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">void RtAudio::startStream </td> | |||
| <td>(</td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td> | |||
| <td> ) </td> | |||
| <td><code> [inline]</code></td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td><td>)</td> | |||
| <td></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </td> | |||
| <td class="mlabels-right"> | |||
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p>A function that starts a stream. </p> | |||
| <p>An <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> (type = SYSTEM_ERROR) is thrown if an error occurs during processing. An <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> (type = INVALID_USE) is thrown if a stream is not open. A warning is issued if the stream is already running. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="af4c241ff86936ecc8108f0d9dfe3efdd"></a><!-- doxytag: member="RtAudio::stopStream" ref="af4c241ff86936ecc8108f0d9dfe3efdd" args="(void)" --> | |||
| <a class="anchor" id="af4c241ff86936ecc8108f0d9dfe3efdd"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="mlabels"> | |||
| <tr> | |||
| <td class="mlabels-left"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">void RtAudio::stopStream </td> | |||
| <td>(</td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td> | |||
| <td> ) </td> | |||
| <td><code> [inline]</code></td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td><td>)</td> | |||
| <td></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </td> | |||
| <td class="mlabels-right"> | |||
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p>Stop a stream, allowing any samples remaining in the output queue to be played. </p> | |||
| <p>An <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> (type = SYSTEM_ERROR) is thrown if an error occurs during processing. An <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> (type = INVALID_USE) is thrown if a stream is not open. A warning is issued if the stream is already stopped. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="ad0586b47cd6bb9591a80b4052815991f"></a><!-- doxytag: member="RtAudio::abortStream" ref="ad0586b47cd6bb9591a80b4052815991f" args="(void)" --> | |||
| <a class="anchor" id="ad0586b47cd6bb9591a80b4052815991f"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="mlabels"> | |||
| <tr> | |||
| <td class="mlabels-left"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">void RtAudio::abortStream </td> | |||
| <td>(</td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td> | |||
| <td> ) </td> | |||
| <td><code> [inline]</code></td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td><td>)</td> | |||
| <td></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </td> | |||
| <td class="mlabels-right"> | |||
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p>Stop a stream, discarding any samples remaining in the input/output queue. </p> | |||
| <p>An <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> (type = SYSTEM_ERROR) is thrown if an error occurs during processing. An <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> (type = INVALID_USE) is thrown if a stream is not open. A warning is issued if the stream is already stopped. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a344e59a62353c5791db4621b985cb2ca"></a><!-- doxytag: member="RtAudio::getStreamTime" ref="a344e59a62353c5791db4621b985cb2ca" args="(void)" --> | |||
| <a class="anchor" id="a344e59a62353c5791db4621b985cb2ca"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="mlabels"> | |||
| <tr> | |||
| <td class="mlabels-left"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">double RtAudio::getStreamTime </td> | |||
| <td>(</td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td> | |||
| <td> ) </td> | |||
| <td><code> [inline]</code></td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td><td>)</td> | |||
| <td></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </td> | |||
| <td class="mlabels-right"> | |||
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p>Returns the number of elapsed seconds since the stream was started. </p> | |||
| <p>If a stream is not open, an <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> (type = INVALID_USE) will be thrown. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a843c989d9f501c71bc2f2c5ca18df9f3"></a><!-- doxytag: member="RtAudio::getStreamLatency" ref="a843c989d9f501c71bc2f2c5ca18df9f3" args="(void)" --> | |||
| <a class="anchor" id="a843c989d9f501c71bc2f2c5ca18df9f3"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="mlabels"> | |||
| <tr> | |||
| <td class="mlabels-left"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">long RtAudio::getStreamLatency </td> | |||
| <td>(</td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td> | |||
| <td> ) </td> | |||
| <td><code> [inline]</code></td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td><td>)</td> | |||
| <td></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </td> | |||
| <td class="mlabels-right"> | |||
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p>Returns the internal stream latency in sample frames. </p> | |||
| <p>The stream latency refers to delay in audio input and/or output caused by internal buffering by the audio system and/or hardware. For duplex streams, the returned value will represent the sum of the input and output latencies. If a stream is not open, an <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> (type = INVALID_USE) will be thrown. If the API does not report latency, the return value will be zero. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a28214b8b05d60b45c24ee6fae7b2a0b5"></a><!-- doxytag: member="RtAudio::getStreamSampleRate" ref="a28214b8b05d60b45c24ee6fae7b2a0b5" args="(void)" --> | |||
| <a class="anchor" id="a28214b8b05d60b45c24ee6fae7b2a0b5"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="mlabels"> | |||
| <tr> | |||
| <td class="mlabels-left"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">unsigned int RtAudio::getStreamSampleRate </td> | |||
| <td>(</td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td> | |||
| <td> ) </td> | |||
| <td><code> [inline]</code></td> | |||
| <td class="paramtype">void </td> | |||
| <td class="paramname"></td><td>)</td> | |||
| <td></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </td> | |||
| <td class="mlabels-right"> | |||
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> | |||
| </tr> | |||
| </table> | |||
| </div><div class="memdoc"> | |||
| <p>Returns actual sample rate in use by the stream. </p> | |||
| <p>On some systems, the sample rate used may be slightly different than that specified in the stream parameters. If a stream is not open, an <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> (type = INVALID_USE) will be thrown. </p> | |||
| @@ -523,12 +638,10 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="clas | |||
| <hr/>The documentation for this class was generated from the following file:<ul> | |||
| <li><a class="el" href="RtAudio_8h_source.html">RtAudio.h</a></li> | |||
| </ul> | |||
| </div> | |||
| </div><!-- contents --> | |||
| <HR> | |||
| <table><tr><td><img src="../images/mcgill.gif" width=165></td> | |||
| <td>©2001-2012 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| <td>©2001-2013 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| </table> | |||
| </BODY> | |||
| </HTML> | |||
+ 29
- 24
doc/html/classRtError-members.html
View File
| @@ -8,33 +8,38 @@ | |||
| <CENTER> | |||
| <a class="qindex" href="index.html">Home</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.6.2 --> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="headertitle"> | |||
| <div class="title">RtError Member List</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <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.<table> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba">DEBUG_WARNING</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b">DRIVER_ERROR</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50">getMessage</a>(void) const </td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#a3e316dc9b9b41fe2f64cabf34beb4fe7">getType</a>(void) const </td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1">INVALID_DEVICE</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6">INVALID_PARAMETER</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc">INVALID_USE</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e">MEMORY_ERROR</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82">NO_DEVICES_FOUND</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc">printMessage</a>(void) const </td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#aa479a305ccbe56be0fd9137b9b405a37">RtError</a>(const std::string &message, Type type=RtError::UNSPECIFIED)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b">SYSTEM_ERROR</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6">THREAD_ERROR</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">Type</a> enum name</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6">UNSPECIFIED</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398">WARNING</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#aeb843b7a7785d66061c61ebfc29e7e9d">what</a>(void) const </td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="classRtError.html#a6793e03386e7e69ffafb65a296dfa48c">~RtError</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> | |||
| </table></div> | |||
| <HR> | |||
| <p>This is the complete list of members for <a class="el" href="classRtError.html">RtError</a>, including all inherited members.</p> | |||
| <table class="directory"> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba">DEBUG_WARNING</a> enum value</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b">DRIVER_ERROR</a> enum value</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50">getMessage</a>(void) const </td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtError.html#a3e316dc9b9b41fe2f64cabf34beb4fe7">getType</a>(void) const </td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1">INVALID_DEVICE</a> enum value</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6">INVALID_PARAMETER</a> enum value</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc">INVALID_USE</a> enum value</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e">MEMORY_ERROR</a> enum value</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82">NO_DEVICES_FOUND</a> enum value</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc">printMessage</a>(void) const </td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtError.html#aa479a305ccbe56be0fd9137b9b405a37">RtError</a>(const std::string &message, Type type=RtError::UNSPECIFIED)</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b">SYSTEM_ERROR</a> enum value</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6">THREAD_ERROR</a> enum value</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">Type</a> enum name</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6">UNSPECIFIED</a> enum value</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398">WARNING</a> enum value</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="classRtError.html#aeb843b7a7785d66061c61ebfc29e7e9d">what</a>(void) const </td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> | |||
| <tr><td class="entry"><a class="el" href="classRtError.html#a6793e03386e7e69ffafb65a296dfa48c">~RtError</a>(void)</td><td class="entry"><a class="el" href="classRtError.html">RtError</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> | |||
| </table></div><!-- contents --> | |||
| <HR> | |||
| <table><tr><td><img src="../images/mcgill.gif" width=165></td> | |||
| <td>©2001-2012 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| <td>©2001-2013 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> | |||
| </table> | |||
| </BODY> | |||
| </HTML> | |||
+ 67
- 52
doc/html/classRtError.html
View File
| @@ -8,60 +8,78 @@ | |||
| <CENTER> | |||
| <a class="qindex" href="index.html">Home</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.6.2 --> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="summary"> | |||
| <a href="#pub-types">Public Types</a> | | |||
| <a href="#pub-methods">Public Member Functions</a> | | |||
| <a href="classRtError-members.html">List of all members</a> </div> | |||
| <div class="headertitle"> | |||
| <div class="title">RtError Class Reference</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>RtError Class Reference</h1><!-- doxytag: class="RtError" --> | |||
| <p>Exception handling class for <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> & RtMidi. | |||
| <a href="#_details">More...</a></p> | |||
| <a href="classRtError.html#details">More...</a></p> | |||
| <p><code>#include <<a class="el" href="RtError_8h_source.html">RtError.h</a>></code></p> | |||
| <p><a href="classRtError-members.html">List of all members.</a></p> | |||
| <table border="0" cellpadding="0" cellspacing="0"> | |||
| <tr><td colspan="2"><h2>Public Types</h2></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">Type</a> { <br/> | |||
| <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398">WARNING</a>, | |||
| <p>Inherits exception.</p> | |||
| <table class="memberdecls"> | |||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> | |||
| Public Types</h2></td></tr> | |||
| <tr class="memitem:ab04667aae01bffc354a9ac6bda6903ac"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">Type</a> { <br/> | |||
|   <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398">WARNING</a>, | |||
| <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba">DEBUG_WARNING</a>, | |||
| <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6">UNSPECIFIED</a>, | |||
| <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82">NO_DEVICES_FOUND</a>, | |||
| <br/> | |||
| <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1">INVALID_DEVICE</a>, | |||
|   <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1">INVALID_DEVICE</a>, | |||
| <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e">MEMORY_ERROR</a>, | |||
| <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6">INVALID_PARAMETER</a>, | |||
| <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc">INVALID_USE</a>, | |||
| <br/> | |||
| <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b">DRIVER_ERROR</a>, | |||
|   <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b">DRIVER_ERROR</a>, | |||
| <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b">SYSTEM_ERROR</a>, | |||
| <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6">THREAD_ERROR</a> | |||
| <br/> | |||
| }</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Defined <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> types. </p> | |||
| <a href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">More...</a><br/></td></tr> | |||
| <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa479a305ccbe56be0fd9137b9b405a37"></a><!-- doxytag: member="RtError::RtError" ref="aa479a305ccbe56be0fd9137b9b405a37" args="(const std::string &message, Type type=RtError::UNSPECIFIED)" --> | |||
| </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#aa479a305ccbe56be0fd9137b9b405a37">RtError</a> (const std::string &message, <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">Type</a> type=RtError::UNSPECIFIED) throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor. <br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6793e03386e7e69ffafb65a296dfa48c"></a><!-- doxytag: member="RtError::~RtError" ref="a6793e03386e7e69ffafb65a296dfa48c" args="(void)" --> | |||
| virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a6793e03386e7e69ffafb65a296dfa48c">~RtError</a> (void) throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a251dcdac396c998c91706dd2dd3b8bfc"></a><!-- doxytag: member="RtError::printMessage" ref="a251dcdac396c998c91706dd2dd3b8bfc" args="(void) const " --> | |||
| virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc">printMessage</a> (void) const throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Prints thrown error message to stderr. <br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e316dc9b9b41fe2f64cabf34beb4fe7"></a><!-- doxytag: member="RtError::getType" ref="a3e316dc9b9b41fe2f64cabf34beb4fe7" args="(void) const " --> | |||
| virtual const <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">Type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a3e316dc9b9b41fe2f64cabf34beb4fe7">getType</a> (void) const throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message type. <br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd067ba6b46edd37f989cad02cd70b50"></a><!-- doxytag: member="RtError::getMessage" ref="afd067ba6b46edd37f989cad02cd70b50" args="(void) const " --> | |||
| virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50">getMessage</a> (void) const throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message string. <br/></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb843b7a7785d66061c61ebfc29e7e9d"></a><!-- doxytag: member="RtError::what" ref="aeb843b7a7785d66061c61ebfc29e7e9d" args="(void) const " --> | |||
| virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#aeb843b7a7785d66061c61ebfc29e7e9d">what</a> (void) const throw ()</td></tr> | |||
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message as a c-style string. <br/></td></tr> | |||
| <tr class="memdesc:ab04667aae01bffc354a9ac6bda6903ac"><td class="mdescLeft"> </td><td class="mdescRight">Defined <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> types. <a href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">More...</a><br/></td></tr> | |||
| <tr class="separator:ab04667aae01bffc354a9ac6bda6903ac"><td class="memSeparator" colspan="2"> </td></tr> | |||
| </table><table class="memberdecls"> | |||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> | |||
| Public Member Functions</h2></td></tr> | |||
| <tr class="memitem:aa479a305ccbe56be0fd9137b9b405a37"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa479a305ccbe56be0fd9137b9b405a37"></a> | |||
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#aa479a305ccbe56be0fd9137b9b405a37">RtError</a> (const std::string &message, <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">Type</a> type=<a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6">RtError::UNSPECIFIED</a>) throw ()</td></tr> | |||
| <tr class="memdesc:aa479a305ccbe56be0fd9137b9b405a37"><td class="mdescLeft"> </td><td class="mdescRight">The constructor. <br/></td></tr> | |||
| <tr class="separator:aa479a305ccbe56be0fd9137b9b405a37"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a6793e03386e7e69ffafb65a296dfa48c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6793e03386e7e69ffafb65a296dfa48c"></a> | |||
| virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a6793e03386e7e69ffafb65a296dfa48c">~RtError</a> (void) throw ()</td></tr> | |||
| <tr class="memdesc:a6793e03386e7e69ffafb65a296dfa48c"><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <br/></td></tr> | |||
| <tr class="separator:a6793e03386e7e69ffafb65a296dfa48c"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a251dcdac396c998c91706dd2dd3b8bfc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a251dcdac396c998c91706dd2dd3b8bfc"></a> | |||
| virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc">printMessage</a> (void) const throw ()</td></tr> | |||
| <tr class="memdesc:a251dcdac396c998c91706dd2dd3b8bfc"><td class="mdescLeft"> </td><td class="mdescRight">Prints thrown error message to stderr. <br/></td></tr> | |||
| <tr class="separator:a251dcdac396c998c91706dd2dd3b8bfc"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a3e316dc9b9b41fe2f64cabf34beb4fe7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e316dc9b9b41fe2f64cabf34beb4fe7"></a> | |||
| virtual const <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">Type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a3e316dc9b9b41fe2f64cabf34beb4fe7">getType</a> (void) const throw ()</td></tr> | |||
| <tr class="memdesc:a3e316dc9b9b41fe2f64cabf34beb4fe7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message type. <br/></td></tr> | |||
| <tr class="separator:a3e316dc9b9b41fe2f64cabf34beb4fe7"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:afd067ba6b46edd37f989cad02cd70b50"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd067ba6b46edd37f989cad02cd70b50"></a> | |||
| virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50">getMessage</a> (void) const throw ()</td></tr> | |||
| <tr class="memdesc:afd067ba6b46edd37f989cad02cd70b50"><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message string. <br/></td></tr> | |||
| <tr class="separator:afd067ba6b46edd37f989cad02cd70b50"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:aeb843b7a7785d66061c61ebfc29e7e9d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb843b7a7785d66061c61ebfc29e7e9d"></a> | |||
| virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#aeb843b7a7785d66061c61ebfc29e7e9d">what</a> (void) const throw ()</td></tr> | |||
| <tr class="memdesc:aeb843b7a7785d66061c61ebfc29e7e9d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message as a c-style string. <br/></td></tr> | |||
| <tr class="separator:aeb843b7a7785d66061c61ebfc29e7e9d"><td class="memSeparator" colspan="2"> </td></tr> | |||
| </table> | |||
| <hr/><a name="_details"></a><h2>Detailed Description</h2> | |||
| <p>Exception handling class for <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> & RtMidi. </p> | |||
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> | |||
| <div class="textblock"><p>Exception handling class for <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> & RtMidi. </p> | |||
| <p>The <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">RtError::Type</a>. See the <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> and RtMidi documentation to know which methods can throw an <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a>. </p> | |||
| <hr/><h2>Member Enumeration Documentation</h2> | |||
| <a class="anchor" id="ab04667aae01bffc354a9ac6bda6903ac"></a><!-- doxytag: member="RtError::Type" ref="ab04667aae01bffc354a9ac6bda6903ac" args="" --> | |||
| </div><h2 class="groupheader">Member Enumeration Documentation</h2> | |||
| <a class="anchor" id="ab04667aae01bffc354a9ac6bda6903ac"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| @@ -69,42 +87,41 @@ virtual const char * </td><td class="memItemRight" valign="bottom"><a class | |||
| <td class="memname">enum <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">RtError::Type</a></td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>Defined <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> types. </p> | |||
| <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398"></a><!-- doxytag: member="WARNING" ref="ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398" args="" -->WARNING</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398"></a>WARNING</em> </td><td> | |||
| <p>A non-critical error. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba"></a><!-- doxytag: member="DEBUG_WARNING" ref="ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba" args="" -->DEBUG_WARNING</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba"></a>DEBUG_WARNING</em> </td><td> | |||
| <p>A non-critical error which might be useful for debugging. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6"></a><!-- doxytag: member="UNSPECIFIED" ref="ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6" args="" -->UNSPECIFIED</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6"></a>UNSPECIFIED</em> </td><td> | |||
| <p>The default, unspecified error type. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82"></a><!-- doxytag: member="NO_DEVICES_FOUND" ref="ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82" args="" -->NO_DEVICES_FOUND</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82"></a>NO_DEVICES_FOUND</em> </td><td> | |||
| <p>No devices found on system. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1"></a><!-- doxytag: member="INVALID_DEVICE" ref="ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1" args="" -->INVALID_DEVICE</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1"></a>INVALID_DEVICE</em> </td><td> | |||
| <p>An invalid device ID was specified. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e"></a><!-- doxytag: member="MEMORY_ERROR" ref="ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e" args="" -->MEMORY_ERROR</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e"></a>MEMORY_ERROR</em> </td><td> | |||
| <p>An error occured during memory allocation. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6"></a><!-- doxytag: member="INVALID_PARAMETER" ref="ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6" args="" -->INVALID_PARAMETER</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6"></a>INVALID_PARAMETER</em> </td><td> | |||
| <p>An invalid parameter was specified to a function. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc"></a><!-- doxytag: member="INVALID_USE" ref="ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc" args="" -->INVALID_USE</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc"></a>INVALID_USE</em> </td><td> | |||
| <p>The function was called incorrectly. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b"></a><!-- doxytag: member="DRIVER_ERROR" ref="ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b" args="" -->DRIVER_ERROR</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b"></a>DRIVER_ERROR</em> </td><td> | |||
| <p>A system driver error occured. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b"></a><!-- doxytag: member="SYSTEM_ERROR" ref="ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b" args="" -->SYSTEM_ERROR</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b"></a>SYSTEM_ERROR</em> </td><td> | |||
| <p>A system error occured. </p> | |||
| </td></tr> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6"></a><!-- doxytag: member="THREAD_ERROR" ref="ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6" args="" -->THREAD_ERROR</em> </td><td> | |||
| <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6"></a>THREAD_ERROR</em> </td><td> | |||
| <p>A thread error occured. </p> | |||
| </td></tr> | |||
| </table> | |||
| @@ -116,12 +133,10 @@ virtual const char * </td><td class="memItemRight" valign="bottom"><a class | |||
| <hr/>The documentation for this class was generated from the following file:<ul> | |||
| <li><a class="el" href="RtError_8h_source.html">RtError.h</a></li> | |||
| </ul> | |||
| </div> | |||
| </div><!-- contents --> | |||
| <HR> | |||