Gary Scavone
Stephen Sinclair
11 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> | |||
| <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> | |||
+ 20
- 11
doc/html/classes.html
View File
| @@ -8,20 +8,29 @@ | |||
| <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 Index</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>Class Index</h1><div class="qindex"><a class="qindex" href="#letter_D">D</a> | <a class="qindex" href="#letter_R">R</a> | <a class="qindex" href="#letter_S">S</a></div> | |||
| <table align="center" width="95%" border="0" cellspacing="0" cellpadding="0"> | |||
| <tr><td><a name="letter_D"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> D </div></td></tr></table> | |||
| </td><td><a name="letter_R"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> R </div></td></tr></table> | |||
| </td><td><a class="el" href="classRtError.html">RtError</a> </td><td><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a> </td><td><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a> </td></tr><tr><td><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a> </td><td><a class="el" href="classRtAudio.html">RtAudio</a> </td><td><a name="letter_S"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> S </div></td></tr></table> | |||
| </td></tr></table><div class="qindex"><a class="qindex" href="#letter_D">D</a> | <a class="qindex" href="#letter_R">R</a> | <a class="qindex" href="#letter_S">S</a></div> | |||
| </div> | |||
| <div class="qindex"><a class="qindex" href="#letter_D">D</a> | <a class="qindex" href="#letter_R">R</a> | <a class="qindex" href="#letter_S">S</a></div> | |||
| <table style="margin: 10px; white-space: nowrap;" align="center" width="95%" border="0" cellspacing="0" cellpadding="0"> | |||
| <tr><td rowspan="2" valign="bottom"><a name="letter_D"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">  D  </div></td></tr></table> | |||
| </td><td rowspan="2" valign="bottom"><a name="letter_R"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">  R  </div></td></tr></table> | |||
| </td><td valign="top"><a class="el" href="classRtError.html">RtError</a>   </td><td valign="top"><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a>   </td></tr> | |||
| <tr><td rowspan="2" valign="bottom"><a name="letter_S"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">  S  </div></td></tr></table> | |||
| </td><td></td></tr> | |||
| <tr><td valign="top"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a>   </td><td valign="top"><a class="el" href="classRtAudio.html">RtAudio</a>   </td><td></td></tr> | |||
| <tr><td></td><td></td><td valign="top"><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a>   </td><td></td></tr> | |||
| <tr><td></td><td></td><td></td><td></td></tr> | |||
| </table> | |||
| <div class="qindex"><a class="qindex" href="#letter_D">D</a> | <a class="qindex" href="#letter_R">R</a> | <a class="qindex" href="#letter_S">S</a></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
- 15
doc/html/compiling.html
View File
| @@ -8,27 +8,30 @@ | |||
| <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">Debugging & Compiling </div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1><a class="anchor" id="compiling">Debugging & Compiling </a></h1><h2><a class="anchor" id="debug"> | |||
| Debugging</a></h2> | |||
| <p>If you are having problems getting <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> to run on your system, make sure to pass a value of <em>true</em> to the <a class="el" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77" title="Specify whether warning messages should be printed to stderr.">RtAudio::showWarnings()</a> function (this is the default setting). A variety of warning messages will be displayed which may help in determining the problem. Also, try using the programs included in the <code>tests</code> directory. The program <code>audioprobe</code> displays the queried capabilities of all hardware devices found for all APIs compiled. When using the ALSA and JACK APIs, further information can be displayed by defining the preprocessor definition __RTAUDIO_DEBUG__.</p> | |||
| <h2><a class="anchor" id="compile"> | |||
| Compiling</a></h2> | |||
| <div class="textblock"><h1><a class="anchor" id="debug"></a> | |||
| Debugging</h1> | |||
| <p>If you are having problems getting <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> to run on your system, make sure to pass a value of <em>true</em> to the <a class="el" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77" title="Specify whether warning messages should be printed to stderr.">RtAudio::showWarnings()</a> function (this is the default setting). A variety of warning messages will be displayed which may help in determining the problem. Also, try using the programs included in the <code>tests</code> directory. The program <code>audioprobe</code> displays the queried capabilities of all hardware devices found for all APIs compiled. When using the ALSA and JACK APIs, further information can be displayed by defining the preprocessor definition <b>RTAUDIO_DEBUG</b>.</p> | |||
| <h1><a class="anchor" id="compile"></a> | |||
| Compiling</h1> | |||
| <p>In order to compile <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> for a specific OS and audio API, it is necessary to supply the appropriate preprocessor definition and library within the compiler statement: </p> | |||
| <table class="doxtable" border="2" cols="5" width="100%"> | |||
| <table border="2" cols="5" width="100%"> | |||
| <tr bgcolor="beige"> | |||
| <td width="5%"><b>OS:</b> </td><td width="5%"><b>Audio API:</b> </td><td width="5%"><b>C++ Class:</b> </td><td width="5%"><b>Preprocessor Definition:</b> </td><td width="5%"><b>Library or Framework:</b> </td><td><b>Example Compiler Statement:</b> </td></tr> | |||
| <tr> | |||
| <td>Linux </td><td>ALSA </td><td>RtApiAlsa </td><td>__LINUX_ALSA__ </td><td><code>asound, pthread</code> </td><td><code>g++ -Wall -D__LINUX_ALSA__ -o audioprobe audioprobe.cpp RtAudio.cpp -lasound -lpthread</code> </td></tr> | |||
| <tr> | |||
| <td>Linux </td><td>PulseAudio </td><td>RtApiPulse </td><td>__LINUX_PULSE__ </td><td><code>pthread</code> </td><td><code>g++ -Wall -D__LINUX_PULSE__ -o audioprobe audioprobe.cpp RtAudio.cpp -lpthread</code> </td></tr> | |||
| <td>Linux </td><td>PulseAudio </td><td>RtApiPulse </td><td>__LINUX_PULSE__ </td><td><code>pthread</code> </td><td><code>g++ -Wall -D__LINUX_PULSE__ -o audioprobe audioprobe.cpp RtAudio.cpp -lpthread -lpulse-simple -lpulse</code> </td></tr> | |||
| <tr> | |||
| <td>Linux </td><td>OSS </td><td>RtApiOss </td><td>__LINUX_OSS__ </td><td><code>pthread</code> </td><td><code>g++ -Wall -D__LINUX_OSS__ -o audioprobe audioprobe.cpp RtAudio.cpp -lpthread</code> </td></tr> | |||
| <tr> | |||
| <td>Linux or Macintosh OS-X </td><td>Jack Audio Server </td><td>RtApiJack </td><td>__UNIX_JACK__ </td><td><code>jack, pthread</code> </td><td><p class="starttd"><code>g++ -Wall -D__UNIX_JACK__ -o audioprobe audioprobe.cpp RtAudio.cpp `pkg-config --cflags --libs jack` -lpthread</code> </p> | |||
| <td>Linux or Macintosh OS-X </td><td>Jack Audio Server </td><td>RtApiJack </td><td>__UNIX_JACK__ </td><td><code>jack, pthread</code> </td><td><p class="starttd"><code>g++ -Wall -D__UNIX_JACK__ -o audioprobe audioprobe.cpp RtAudio.cpp <code>pkg-config --cflags --libs jack</code> -lpthread</code> </p> | |||
| <p class="endtd"></p> | |||
| </td></tr> | |||
| <tr> | |||
| @@ -39,12 +42,10 @@ Compiling</a></h2> | |||
| <td>Windows </td><td>ASIO </td><td>RtApiAsio </td><td>__WINDOWS_ASIO__ </td><td><em>various ASIO header and source files</em> </td><td><em>compiler specific</em> </td></tr> | |||
| </table> | |||
| <p>The example compiler statements above could be used to compile the <code>audioprobe.cpp</code> example file, assuming that <code>audioprobe.cpp</code>, <code><a class="el" href="RtAudio_8h.html">RtAudio.h</a></code>, <code><a class="el" href="RtError_8h_source.html">RtError.h</a></code>, and <code>RtAudio.cpp</code> all exist in the same directory. </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> | |||
+ 780
- 140
doc/html/doxygen.css
File diff suppressed because it is too large
View File
BIN
doc/html/doxygen.png
View File
| Before | After |
|---|---|
|
|
| Width: 100 | Height: 45 | Size: 1.3KB | Width: 104 | Height: 31 | Size: 3.7KB |
+ 74
- 73
doc/html/duplex.html
View File
| @@ -8,83 +8,84 @@ | |||
| <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">Duplex Mode </div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1><a class="anchor" id="duplex">Duplex Mode </a></h1><p>Finally, it is easy to use <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> for simultaneous audio input/output, or duplex operation. In this example, we simply pass the input data back to the output.</p> | |||
| <div class="fragment"><pre class="fragment"><span class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</span> | |||
| <span class="preprocessor">#include <iostream></span> | |||
| <span class="preprocessor">#include <cstdlib></span> | |||
| <span class="preprocessor">#include <cstring></span> | |||
| <span class="comment">// Pass-through function.</span> | |||
| <span class="keywordtype">int</span> inout( <span class="keywordtype">void</span> *outputBuffer, <span class="keywordtype">void</span> *inputBuffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nBufferFrames, | |||
| <span class="keywordtype">double</span> streamTime, <a class="code" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806" title="RtAudio stream status (over- or underflow) flags.">RtAudioStreamStatus</a> status, <span class="keywordtype">void</span> *data ) | |||
| { | |||
| <span class="comment">// Since the number of input and output channels is equal, we can do</span> | |||
| <span class="comment">// a simple buffer copy operation here.</span> | |||
| <span class="keywordflow">if</span> ( status ) std::cout << <span class="stringliteral">"Stream over/underflow detected."</span> << std::endl; | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> *bytes = (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> *) data; | |||
| memcpy( outputBuffer, inputBuffer, *bytes ); | |||
| <span class="keywordflow">return</span> 0; | |||
| } | |||
| <span class="keywordtype">int</span> main() | |||
| { | |||
| <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> adac; | |||
| <span class="keywordflow">if</span> ( adac.<a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount</a>() < 1 ) { | |||
| std::cout << <span class="stringliteral">"\nNo audio devices found!\n"</span>; | |||
| exit( 0 ); | |||
| } | |||
| <span class="comment">// Set the same number of channels for both input and output.</span> | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bufferBytes, bufferFrames = 512; | |||
| <a class="code" href="structRtAudio_1_1StreamParameters.html" title="The structure for specifying input or ouput stream parameters.">RtAudio::StreamParameters</a> iParams, oParams; | |||
| iParams.<a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a> = 0; <span class="comment">// first available device</span> | |||
| iParams.<a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a> = 2; | |||
| oParams.<a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a> = 0; <span class="comment">// first available device</span> | |||
| oParams.<a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a> = 2; | |||
| <span class="keywordflow">try</span> { | |||
| adac.<a class="code" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">openStream</a>( &oParams, &iParams, RTAUDIO_SINT32, 44100, &bufferFrames, &inout, (<span class="keywordtype">void</span> *)&bufferBytes ); | |||
| } | |||
| <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a>& e ) { | |||
| e.<a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>(); | |||
| exit( 0 ); | |||
| } | |||
| bufferBytes = bufferFrames * 2 * 4; | |||
| <span class="keywordflow">try</span> { | |||
| adac.<a class="code" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80" title="A function that starts a stream.">startStream</a>(); | |||
| <span class="keywordtype">char</span> input; | |||
| std::cout << <span class="stringliteral">"\nRunning ... press <enter> to quit.\n"</span>; | |||
| std::cin.get(input); | |||
| <span class="comment">// Stop the stream.</span> | |||
| adac.<a class="code" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">stopStream</a>(); | |||
| } | |||
| <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a>& e ) { | |||
| e.<a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>(); | |||
| <span class="keywordflow">goto</span> cleanup; | |||
| } | |||
| cleanup: | |||
| <span class="keywordflow">if</span> ( adac.<a class="code" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f" title="Returns true if a stream is open and false if not.">isStreamOpen</a>() ) adac.<a class="code" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a" title="A function that closes a stream and frees any associated stream memory.">closeStream</a>(); | |||
| <span class="keywordflow">return</span> 0; | |||
| } | |||
| </pre></div><p>In this example, audio recorded by the stream input will be played out during the next round of audio processing.</p> | |||
| <div class="textblock"><p>Finally, it is easy to use <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> for simultaneous audio input/output, or duplex operation. In this example, we simply pass the input data back to the output.</p> | |||
| <div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</span></div> | |||
| <div class="line"><span class="preprocessor">#include <iostream></span></div> | |||
| <div class="line"><span class="preprocessor">#include <cstdlib></span></div> | |||
| <div class="line"><span class="preprocessor">#include <cstring></span></div> | |||
| <div class="line"></div> | |||
| <div class="line"><span class="comment">// Pass-through function.</span></div> | |||
| <div class="line"><span class="keywordtype">int</span> inout( <span class="keywordtype">void</span> *outputBuffer, <span class="keywordtype">void</span> *inputBuffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nBufferFrames,</div> | |||
| <div class="line"> <span class="keywordtype">double</span> streamTime, <a class="code" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806" title="RtAudio stream status (over- or underflow) flags.">RtAudioStreamStatus</a> status, <span class="keywordtype">void</span> *data )</div> | |||
| <div class="line">{</div> | |||
| <div class="line"> <span class="comment">// Since the number of input and output channels is equal, we can do</span></div> | |||
| <div class="line"> <span class="comment">// a simple buffer copy operation here.</span></div> | |||
| <div class="line"> <span class="keywordflow">if</span> ( status ) std::cout << <span class="stringliteral">"Stream over/underflow detected."</span> << std::endl;</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> *bytes = (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> *) data;</div> | |||
| <div class="line"> memcpy( outputBuffer, inputBuffer, *bytes );</div> | |||
| <div class="line"> <span class="keywordflow">return</span> 0;</div> | |||
| <div class="line">}</div> | |||
| <div class="line"></div> | |||
| <div class="line"><span class="keywordtype">int</span> main()</div> | |||
| <div class="line">{</div> | |||
| <div class="line"> <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> adac;</div> | |||
| <div class="line"> <span class="keywordflow">if</span> ( adac.<a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount</a>() < 1 ) {</div> | |||
| <div class="line"> std::cout << <span class="stringliteral">"\nNo audio devices found!\n"</span>;</div> | |||
| <div class="line"> exit( 0 );</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="comment">// Set the same number of channels for both input and output.</span></div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bufferBytes, bufferFrames = 512;</div> | |||
| <div class="line"> <a class="code" href="structRtAudio_1_1StreamParameters.html" title="The structure for specifying input or ouput stream parameters.">RtAudio::StreamParameters</a> iParams, oParams;</div> | |||
| <div class="line"> iParams.<a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a> = 0; <span class="comment">// first available device</span></div> | |||
| <div class="line"> iParams.<a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a> = 2;</div> | |||
| <div class="line"> oParams.<a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a> = 0; <span class="comment">// first available device</span></div> | |||
| <div class="line"> oParams.<a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a> = 2;</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">try</span> {</div> | |||
| <div class="line"> adac.<a class="code" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b" title="A public function for opening a stream with the specified parameters.">openStream</a>( &oParams, &iParams, RTAUDIO_SINT32, 44100, &bufferFrames, &inout, (<span class="keywordtype">void</span> *)&bufferBytes );</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"> <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a>& e ) {</div> | |||
| <div class="line"> e.<a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>();</div> | |||
| <div class="line"> exit( 0 );</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"></div> | |||
| <div class="line"> bufferBytes = bufferFrames * 2 * 4;</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">try</span> {</div> | |||
| <div class="line"> adac.<a class="code" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80" title="A function that starts a stream.">startStream</a>();</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordtype">char</span> input;</div> | |||
| <div class="line"> std::cout << <span class="stringliteral">"\nRunning ... press <enter> to quit.\n"</span>;</div> | |||
| <div class="line"> std::cin.get(input);</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="comment">// Stop the stream.</span></div> | |||
| <div class="line"> adac.<a class="code" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">stopStream</a>();</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"> <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a>& e ) {</div> | |||
| <div class="line"> e.<a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>();</div> | |||
| <div class="line"> <span class="keywordflow">goto</span> cleanup;</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"></div> | |||
| <div class="line"> cleanup:</div> | |||
| <div class="line"> <span class="keywordflow">if</span> ( adac.<a class="code" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f" title="Returns true if a stream is open and false if not.">isStreamOpen</a>() ) adac.<a class="code" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a" title="A function that closes a stream and frees any associated stream memory.">closeStream</a>();</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">return</span> 0;</div> | |||
| <div class="line">}</div> | |||
| </div><!-- fragment --><p>In this example, audio recorded by the stream input will be played out during the next round of audio processing.</p> | |||
| <p>Note that a duplex stream can make use of two different devices (except when using the Linux Jack and Windows ASIO APIs). However, this may cause timing problems due to possible device clock variations, unless a common external "sync" is provided. </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> | |||
+ 9
- 8
doc/html/errors.html
View File
| @@ -8,17 +8,18 @@ | |||
| <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">Error Handling </div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1><a class="anchor" id="errors">Error Handling </a></h1><p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> makes restrained use of C++ exceptions. That is, exceptions are thrown only when system errors occur that prevent further class operation or when the user makes invalid function calls. In other cases, a warning message may be displayed and an appropriate value is returned. For example, if a system error occurs when processing the <a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">RtAudio::getDeviceCount()</a> function, the return value is zero. In such a case, the user cannot expect to make use of most other <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> functions because no devices are available (and thus a stream cannot be opened). A client can call the function <a class="el" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77" title="Specify whether warning messages should be printed to stderr.">RtAudio::showWarnings()</a> with a boolean argument to enable or disable the printing of warning messages to <code>stderr</code>. By default, warning messages are displayed. There is a protected <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> method, error(), that can be modified to globally control how these messages are handled and reported. </p> | |||
| </div> | |||
| <div class="textblock"><p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> makes restrained use of C++ exceptions. That is, exceptions are thrown only when system errors occur that prevent further class operation or when the user makes invalid function calls. In other cases, a warning message may be displayed and an appropriate value is returned. For example, if a system error occurs when processing the <a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">RtAudio::getDeviceCount()</a> function, the return value is zero. In such a case, the user cannot expect to make use of most other <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> functions because no devices are available (and thus a stream cannot be opened). A client can call the function <a class="el" href="classRtAudio.html#af0752ee51cce3dd90a3bd009f9fdbe77" title="Specify whether warning messages should be printed to stderr.">RtAudio::showWarnings()</a> with a boolean argument to enable or disable the printing of warning messages to <code>stderr</code>. By default, warning messages are displayed. There is a protected <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> method, error(), that can be modified to globally control how these messages are handled and reported. </p> | |||
| </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> | |||
+ 13
- 8
doc/html/files.html
View File
| @@ -8,18 +8,23 @@ | |||
| <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">File List</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>File List</h1>Here is a list of all documented files with brief descriptions:<table> | |||
| <tr><td class="indexkey"><a class="el" href="RtAudio_8h.html">RtAudio.h</a> <a href="RtAudio_8h_source.html">[code]</a></td><td class="indexvalue"></td></tr> | |||
| <tr><td class="indexkey"><b>RtError.h</b> <a href="RtError_8h_source.html">[code]</a></td><td class="indexvalue"></td></tr> | |||
| <div class="textblock">Here is a list of all documented files with brief descriptions:</div><div class="directory"> | |||
| <table class="directory"> | |||
| <tr id="row_0_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a href="RtAudio_8h_source.html"><img src="ftv2doc.png" alt="*" width="24" height="22" /></a><a class="el" href="RtAudio_8h.html" target="_self">RtAudio.h</a></td><td class="desc"></td></tr> | |||
| <tr id="row_1_"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a href="RtError_8h_source.html"><img src="ftv2doc.png" alt="*" width="24" height="22" /></a><b>RtError.h</b></td><td class="desc"></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> | |||
+ 26
- 54
doc/html/functions.html
View File
| @@ -8,41 +8,12 @@ | |||
| <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 --> | |||
| <div class="tabs"> | |||
| <ul> | |||
| <li class="current"><a href="functions.html"><span>All</span></a></li> | |||
| <li><a href="functions_func.html"><span>Functions</span></a></li> | |||
| <li><a href="functions_vars.html"><span>Variables</span></a></li> | |||
| <li><a href="functions_enum.html"><span>Enumerations</span></a></li> | |||
| <li><a href="functions_eval.html"><span>Enumerator</span></a></li> | |||
| </ul> | |||
| </div> | |||
| <div class="tabs"> | |||
| <ul> | |||
| <li><a href="#index_a"><span>a</span></a></li> | |||
| <li><a href="#index_c"><span>c</span></a></li> | |||
| <li><a href="#index_d"><span>d</span></a></li> | |||
| <li><a href="#index_f"><span>f</span></a></li> | |||
| <li><a href="#index_g"><span>g</span></a></li> | |||
| <li><a href="#index_i"><span>i</span></a></li> | |||
| <li><a href="#index_l"><span>l</span></a></li> | |||
| <li><a href="#index_m"><span>m</span></a></li> | |||
| <li><a href="#index_n"><span>n</span></a></li> | |||
| <li><a href="#index_o"><span>o</span></a></li> | |||
| <li><a href="#index_p"><span>p</span></a></li> | |||
| <li><a href="#index_r"><span>r</span></a></li> | |||
| <li><a href="#index_s"><span>s</span></a></li> | |||
| <li><a href="#index_t"><span>t</span></a></li> | |||
| <li><a href="#index_u"><span>u</span></a></li> | |||
| <li><a href="#index_w"><span>w</span></a></li> | |||
| <li><a href="#index_~"><span>~</span></a></li> | |||
| </ul> | |||
| </div> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="contents"> | |||
| Here is a list of all documented class members with links to the class documentation for each member: | |||
| <div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div> | |||
| <h3><a class="anchor" id="index_a">- a -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_a"></a>- a -</h3><ul> | |||
| <li>abortStream() | |||
| : <a class="el" href="classRtAudio.html#ad0586b47cd6bb9591a80b4052815991f">RtAudio</a> | |||
| </li> | |||
| @@ -52,14 +23,14 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_c">- c -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_c"></a>- c -</h3><ul> | |||
| <li>closeStream() | |||
| : <a class="el" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a">RtAudio</a> | |||
| </li> | |||
| </ul> | |||
| <h3><a class="anchor" id="index_d">- d -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_d"></a>- d -</h3><ul> | |||
| <li>DEBUG_WARNING | |||
| : <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba">RtError</a> | |||
| </li> | |||
| @@ -75,7 +46,7 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_f">- f -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_f"></a>- f -</h3><ul> | |||
| <li>firstChannel | |||
| : <a class="el" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">RtAudio::StreamParameters</a> | |||
| </li> | |||
| @@ -85,7 +56,7 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_g">- g -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_g"></a>- g -</h3><ul> | |||
| <li>getCompiledApi() | |||
| : <a class="el" href="classRtAudio.html#ae266ffad2ef428d0b2c6c262d391ce26">RtAudio</a> | |||
| </li> | |||
| @@ -119,10 +90,13 @@ Here is a list of all documented class members with links to the class documenta | |||
| <li>getType() | |||
| : <a class="el" href="classRtError.html#a3e316dc9b9b41fe2f64cabf34beb4fe7">RtError</a> | |||
| </li> | |||
| <li>getVersion() | |||
| : <a class="el" href="classRtAudio.html#afee36f6d32f4744ffa7471a0ce7a3856">RtAudio</a> | |||
| </li> | |||
| </ul> | |||
| <h3><a class="anchor" id="index_i">- i -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_i"></a>- i -</h3><ul> | |||
| <li>inputChannels | |||
| : <a class="el" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">RtAudio::DeviceInfo</a> | |||
| </li> | |||
| @@ -150,7 +124,7 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_l">- l -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_l"></a>- l -</h3><ul> | |||
| <li>LINUX_ALSA | |||
| : <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849aa7a2ba095c2806caa893b6fb8fc3a1a8">RtAudio</a> | |||
| </li> | |||
| @@ -163,7 +137,7 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_m">- m -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_m"></a>- m -</h3><ul> | |||
| <li>MACOSX_CORE | |||
| : <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a9fec92b8272244a87a6a11a717bd662d">RtAudio</a> | |||
| </li> | |||
| @@ -173,7 +147,7 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_n">- n -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_n"></a>- n -</h3><ul> | |||
| <li>name | |||
| : <a class="el" href="structRtAudio_1_1DeviceInfo.html#a24df596ab8d54f2eb540c7cf16212b3b">RtAudio::DeviceInfo</a> | |||
| </li> | |||
| @@ -192,9 +166,9 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_o">- o -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_o"></a>- o -</h3><ul> | |||
| <li>openStream() | |||
| : <a class="el" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8">RtAudio</a> | |||
| : <a class="el" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b">RtAudio</a> | |||
| </li> | |||
| <li>outputChannels | |||
| : <a class="el" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">RtAudio::DeviceInfo</a> | |||
| @@ -202,7 +176,7 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_p">- p -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_p"></a>- p -</h3><ul> | |||
| <li>printMessage() | |||
| : <a class="el" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc">RtError</a> | |||
| </li> | |||
| @@ -215,7 +189,7 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_r">- r -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_r"></a>- r -</h3><ul> | |||
| <li>RtAudio() | |||
| : <a class="el" href="classRtAudio.html#afd0bfa26deae9804e18faff59d0273d9">RtAudio</a> | |||
| </li> | |||
| @@ -228,7 +202,7 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_s">- s -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_s"></a>- s -</h3><ul> | |||
| <li>sampleRates | |||
| : <a class="el" href="structRtAudio_1_1DeviceInfo.html#afa65f5f92f66ce7aacd3ff35e11b230f">RtAudio::DeviceInfo</a> | |||
| </li> | |||
| @@ -250,7 +224,7 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_t">- t -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_t"></a>- t -</h3><ul> | |||
| <li>THREAD_ERROR | |||
| : <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6">RtError</a> | |||
| </li> | |||
| @@ -260,7 +234,7 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_u">- u -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_u"></a>- u -</h3><ul> | |||
| <li>UNIX_JACK | |||
| : <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a4767e17c6edfbd827f91763915df4105">RtAudio</a> | |||
| </li> | |||
| @@ -271,7 +245,7 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_w">- w -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_w"></a>- w -</h3><ul> | |||
| <li>WARNING | |||
| : <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398">RtError</a> | |||
| </li> | |||
| @@ -287,7 +261,7 @@ Here is a list of all documented class members with links to the class documenta | |||
| </ul> | |||
| <h3><a class="anchor" id="index_0x7e">- ~ -</a></h3><ul> | |||
| <h3><a class="anchor" id="index_0x7e"></a>- ~ -</h3><ul> | |||
| <li>~RtAudio() | |||
| : <a class="el" href="classRtAudio.html#aa8a9716fd64680657ef69c9465442a2f">RtAudio</a> | |||
| </li> | |||
| @@ -295,12 +269,10 @@ Here is a list of all documented class members with links to the class documenta | |||
| : <a class="el" href="classRtError.html#a6793e03386e7e69ffafb65a296dfa48c">RtError</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> | |||
+ 5
- 15
doc/html/functions_enum.html
View File
| @@ -8,18 +8,10 @@ | |||
| <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 --> | |||
| <div class="tabs"> | |||
| <ul> | |||
| <li><a href="functions.html"><span>All</span></a></li> | |||
| <li><a href="functions_func.html"><span>Functions</span></a></li> | |||
| <li><a href="functions_vars.html"><span>Variables</span></a></li> | |||
| <li class="current"><a href="functions_enum.html"><span>Enumerations</span></a></li> | |||
| <li><a href="functions_eval.html"><span>Enumerator</span></a></li> | |||
| </ul> | |||
| </div> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="contents"> | |||
| <ul> | |||
|  <ul> | |||
| <li>Api | |||
| : <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849">RtAudio</a> | |||
| </li> | |||
| @@ -27,12 +19,10 @@ | |||
| : <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">RtError</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> | |||
+ 5
- 15
doc/html/functions_eval.html
View File
| @@ -8,18 +8,10 @@ | |||
| <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 --> | |||
| <div class="tabs"> | |||
| <ul> | |||
| <li><a href="functions.html"><span>All</span></a></li> | |||
| <li><a href="functions_func.html"><span>Functions</span></a></li> | |||
| <li><a href="functions_vars.html"><span>Variables</span></a></li> | |||
| <li><a href="functions_enum.html"><span>Enumerations</span></a></li> | |||
| <li class="current"><a href="functions_eval.html"><span>Enumerator</span></a></li> | |||
| </ul> | |||
| </div> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="contents"> | |||
| <ul> | |||
|  <ul> | |||
| <li>DEBUG_WARNING | |||
| : <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba">RtError</a> | |||
| </li> | |||
| @@ -79,12 +71,10 @@ | |||
| : <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931">RtAudio</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> | |||
+ 9
- 16
doc/html/functions_func.html
View File
| @@ -8,18 +8,10 @@ | |||
| <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 --> | |||
| <div class="tabs"> | |||
| <ul> | |||
| <li><a href="functions.html"><span>All</span></a></li> | |||
| <li class="current"><a href="functions_func.html"><span>Functions</span></a></li> | |||
| <li><a href="functions_vars.html"><span>Variables</span></a></li> | |||
| <li><a href="functions_enum.html"><span>Enumerations</span></a></li> | |||
| <li><a href="functions_eval.html"><span>Enumerator</span></a></li> | |||
| </ul> | |||
| </div> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="contents"> | |||
| <ul> | |||
|  <ul> | |||
| <li>abortStream() | |||
| : <a class="el" href="classRtAudio.html#ad0586b47cd6bb9591a80b4052815991f">RtAudio</a> | |||
| </li> | |||
| @@ -59,6 +51,9 @@ | |||
| <li>getType() | |||
| : <a class="el" href="classRtError.html#a3e316dc9b9b41fe2f64cabf34beb4fe7">RtError</a> | |||
| </li> | |||
| <li>getVersion() | |||
| : <a class="el" href="classRtAudio.html#afee36f6d32f4744ffa7471a0ce7a3856">RtAudio</a> | |||
| </li> | |||
| <li>isStreamOpen() | |||
| : <a class="el" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f">RtAudio</a> | |||
| </li> | |||
| @@ -66,7 +61,7 @@ | |||
| : <a class="el" href="classRtAudio.html#a84cc8d9b7ab9bc5f37bcf48430ec5aea">RtAudio</a> | |||
| </li> | |||
| <li>openStream() | |||
| : <a class="el" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8">RtAudio</a> | |||
| : <a class="el" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b">RtAudio</a> | |||
| </li> | |||
| <li>printMessage() | |||
| : <a class="el" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc">RtError</a> | |||
| @@ -96,12 +91,10 @@ | |||
| : <a class="el" href="classRtError.html#a6793e03386e7e69ffafb65a296dfa48c">RtError</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> | |||
+ 5
- 15
doc/html/functions_vars.html
View File
| @@ -8,18 +8,10 @@ | |||
| <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 --> | |||
| <div class="tabs"> | |||
| <ul> | |||
| <li><a href="functions.html"><span>All</span></a></li> | |||
| <li><a href="functions_func.html"><span>Functions</span></a></li> | |||
| <li class="current"><a href="functions_vars.html"><span>Variables</span></a></li> | |||
| <li><a href="functions_enum.html"><span>Enumerations</span></a></li> | |||
| <li><a href="functions_eval.html"><span>Enumerator</span></a></li> | |||
| </ul> | |||
| </div> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="contents"> | |||
| <ul> | |||
|  <ul> | |||
| <li>deviceId | |||
| : <a class="el" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">RtAudio::StreamParameters</a> | |||
| </li> | |||
| @@ -69,12 +61,10 @@ | |||
| : <a class="el" href="structRtAudio_1_1StreamOptions.html#a2a4b0b8d690c624d20f4e8f4be6ca9ba">RtAudio::StreamOptions</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> | |||
+ 8
- 12
doc/html/globals.html
View File
| @@ -8,18 +8,16 @@ | |||
| <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 --> | |||
| <div class="tabs"> | |||
| <ul> | |||
| <li class="current"><a href="globals.html"><span>All</span></a></li> | |||
| <li><a href="globals_type.html"><span>Typedefs</span></a></li> | |||
| </ul> | |||
| </div> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="contents"> | |||
| Here is a list of all documented file members with links to the documentation:<ul> | |||
| <div class="textblock">Here is a list of all documented file members with links to the documentation:</div><ul> | |||
| <li>RtAudioCallback | |||
| : <a class="el" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f">RtAudio.h</a> | |||
| </li> | |||
| <li>RtAudioErrorCallback | |||
| : <a class="el" href="RtAudio_8h.html#a2c8c34d284ae138dd29b53375ec9f062">RtAudio.h</a> | |||
| </li> | |||
| <li>RtAudioFormat | |||
| : <a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudio.h</a> | |||
| </li> | |||
| @@ -30,12 +28,10 @@ Here is a list of all documented file members with links to the documentation:<u | |||
| : <a class="el" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806">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> | |||
+ 8
- 12
doc/html/globals_type.html
View File
| @@ -8,18 +8,16 @@ | |||
| <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 --> | |||
| <div class="tabs"> | |||
| <ul> | |||
| <li><a href="globals.html"><span>All</span></a></li> | |||
| <li class="current"><a href="globals_type.html"><span>Typedefs</span></a></li> | |||
| </ul> | |||
| </div> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| </div><!-- top --> | |||
| <div class="contents"> | |||
| <ul> | |||
|  <ul> | |||
| <li>RtAudioCallback | |||
| : <a class="el" href="RtAudio_8h.html#a112c7b7e25a974977f6fc094cef1a31f">RtAudio.h</a> | |||
| </li> | |||
| <li>RtAudioErrorCallback | |||
| : <a class="el" href="RtAudio_8h.html#a2c8c34d284ae138dd29b53375ec9f062">RtAudio.h</a> | |||
| </li> | |||
| <li>RtAudioFormat | |||
| : <a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudio.h</a> | |||
| </li> | |||
| @@ -30,12 +28,10 @@ | |||
| : <a class="el" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806">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> | |||
+ 25
- 24
doc/html/index.html
View File
| @@ -8,9 +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">The <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> Home Page </div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>The <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> Home Page </h1><h3 class="version">4.0.11 </h3><p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> is a set of C++ classes that provide a common API (Application Programming Interface) for realtime audio input/output across Linux, Macintosh OS-X and Windows operating systems. <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> significantly simplifies the process of interacting with computer audio hardware. It was designed with the following objectives:</p> | |||
| <div class="textblock"><p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> is a set of C++ classes that provide a common API (Application Programming Interface) for realtime audio input/output across Linux, Macintosh OS-X and Windows operating systems. <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> significantly simplifies the process of interacting with computer audio hardware. It was designed with the following objectives:</p> | |||
| <ul> | |||
| <li> | |||
| object-oriented C++ design </li> | |||
| @@ -30,26 +35,24 @@ allow audio device capability probing </li> | |||
| automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping </li> | |||
| </ul> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> incorporates the concept of audio streams, which represent audio output (playback) and/or input (recording). Available audio devices and their capabilities can be enumerated and then specified when opening a stream. Where applicable, multiple API support can be compiled and a particular API specified when creating an <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> instance. See the <a class="el" href="apinotes.html">API Notes</a> section for information specific to each of the supported audio APIs.</p> | |||
| <h2><a class="anchor" id="whatsnew"> | |||
| What's New (Version 4.0)</a></h2> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> V4 represents a significant rewrite of the code and includes a number of API and functionality changes from previous versions. A partial list of the changes includes:</p> | |||
| <h1><a class="anchor" id="whatsnew"></a> | |||
| Latest Updates (Version 4.0.12)</h1> | |||
| <ul> | |||
| <li>new support for non-interleaved user data</li> | |||
| <li>additional input/output parameter specifications, including channel offset</li> | |||
| <li>new support for dynamic connection of devices</li> | |||
| <li>new support for stream time</li> | |||
| <li>revised callback arguments, including separate input and output buffer arguments</li> | |||
| <li>revised C++ exception handling</li> | |||
| <li>updated support for OSS version 4.0</li> | |||
| <li>discontinued support of blocking functionality</li> | |||
| <li>discontinued support of SGI</li> | |||
| <li>new functionality to allow error reporting via a client-supplied function (thanks to Pavel Mogilevskiy)</li> | |||
| <li>new function to return the version number</li> | |||
| <li>updated RtAudio.cpp and ASIO files for UNICODE support (thanks to Renaud Schoonbroodt)</li> | |||
| <li>updates to PulseAudio API support (thanks to Peter Meerwald and Tristan Matthews)</li> | |||
| <li>updates for pkg-config support in configure script</li> | |||
| <li>24-bit format changed to true 24-bit format, not sub-bytes of 32-bits (thanks to Marc Britton)</li> | |||
| <li>bug fixes to make sure stream status is closed if error during probeDeviceOpen</li> | |||
| <li>updates / fixes to SCHED_RR code in ALSA (thanks to Marc Lindahl)</li> | |||
| <li>various changes to avoid global variables (thanks to Martin Koegler)</li> | |||
| </ul> | |||
| <p>Devices are now re-enumerated every time the <a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">RtAudio::getDeviceCount()</a>, <a class="el" href="classRtAudio.html#a02d7ff44ad1d7eae22283a052f3dfda8" title="Return an RtAudio::DeviceInfo structure for a specified device number.">RtAudio::getDeviceInfo()</a>, and <a class="el" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">RtAudio::openStream()</a> functions are called. This allows for the proper identification of hot-pluggable (USB, Firewire, ...) devices that are connected after an <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> instance is created.</p> | |||
| <h2><a class="anchor" id="download"> | |||
| Download</a></h2> | |||
| <p>Latest Release (14 June 2012): <a href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.11.tar.gz">Version 4.0.11</a></p> | |||
| <h2><a class="anchor" id="documentation"> | |||
| Documentation Links</a></h2> | |||
| <h1><a class="anchor" id="download"></a> | |||
| Download</h1> | |||
| <p>Latest Release (16 April 2013): <a href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.12.tar.gz">Version 4.0.12</a></p> | |||
| <h1><a class="anchor" id="documentation"></a> | |||
| Documentation Links</h1> | |||
| <ol type="1"> | |||
| <li><a class="el" href="errors.html">Error Handling</a></li> | |||
| <li><a class="el" href="probe.html">Probing Device Capabilities</a></li> | |||
| @@ -66,12 +69,10 @@ Documentation Links</a></h2> | |||
| <li><a href="updates.html">Possible Updates</a></li> | |||
| <li><a href="http://sourceforge.net/projects/rtaudio">RtAudio at SourceForge</a> </li> | |||
| </ol> | |||
| </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> | |||
+ 9
- 8
doc/html/license.html
View File
| @@ -8,22 +8,23 @@ | |||
| <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">License </div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1><a class="anchor" id="license">License </a></h1><p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>: a set of realtime audio i/o C++ classes<br/> | |||
| <div class="textblock"><p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>: a set of realtime audio i/o C++ classes<br/> | |||
| Copyright (c) 2001-2012 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> | |||
| </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> | |||
+ 9
- 8
doc/html/multi.html
View File
| @@ -8,18 +8,19 @@ | |||
| <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">Using Simultaneous Multiple APIs </div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1><a class="anchor" id="multi">Using Simultaneous Multiple APIs </a></h1><p>Because support for each audio API is encapsulated in a specific RtApi subclass, it is possible to compile and instantiate multiple API-specific subclasses on a given operating system. For example, one can compile both the RtApiDs and RtApiAsio classes on Windows operating systems by providing the appropriate preprocessor definitions, include files, and libraries for each. In a run-time situation, one might first attempt to determine whether any ASIO device drivers exist. This can be done by specifying the api argument <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a219517d1df90f94d07758481155bd469">RtAudio::WINDOWS_ASIO</a> when attempting to create an instance of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>. If no available devices are found, then an instance of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> with the api argument <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931">RtAudio::WINDOWS_DS</a> can be created. Alternately, if no api argument is specified, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> will first look for an ASIO instance and then a DirectSound instance (on Linux systems, the default API search order is Jack, Alsa, and finally OSS). In theory, it should also be possible to have separate instances of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> open at the same time with different underlying audio API support, though this has not been tested. It is difficult to know how well different audio APIs can simultaneously coexist on a given operating system. In particular, it is unlikely that the same device could be simultaneously controlled with two different audio APIs.</p> | |||
| <div class="textblock"><p>Because support for each audio API is encapsulated in a specific RtApi subclass, it is possible to compile and instantiate multiple API-specific subclasses on a given operating system. For example, one can compile both the RtApiDs and RtApiAsio classes on Windows operating systems by providing the appropriate preprocessor definitions, include files, and libraries for each. In a run-time situation, one might first attempt to determine whether any ASIO device drivers exist. This can be done by specifying the api argument <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a219517d1df90f94d07758481155bd469">RtAudio::WINDOWS_ASIO</a> when attempting to create an instance of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>. If no available devices are found, then an instance of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> with the api argument <a class="el" href="classRtAudio.html#ac9b6f625da88249d08a8409a9db0d849a28478830f42c2fd61e6c7ad498901931">RtAudio::WINDOWS_DS</a> can be created. Alternately, if no api argument is specified, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> will first look for an ASIO instance and then a DirectSound instance (on Linux systems, the default API search order is Jack, Alsa, and finally OSS). In theory, it should also be possible to have separate instances of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> open at the same time with different underlying audio API support, though this has not been tested. It is difficult to know how well different audio APIs can simultaneously coexist on a given operating system. In particular, it is unlikely that the same device could be simultaneously controlled with two different audio APIs.</p> | |||
| <p>The static function <a class="el" href="classRtAudio.html#ae266ffad2ef428d0b2c6c262d391ce26" title="A static function to determine the available compiled audio APIs.">RtAudio::getCompiledApi()</a> is provided to determine the available compiled API support. The function <a class="el" href="classRtAudio.html#a83687634795792b2c47e4ae1cf8a5246" title="Returns the audio API specifier for the current instance of RtAudio.">RtAudio::getCurrentApi()</a> indicates the API selected for a given <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> instance. </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> | |||
+ 23
- 29
doc/html/pages.html
View File
| @@ -8,38 +8,32 @@ | |||
| <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">Related Pages</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>Related Pages</h1>Here is a list of all related documentation pages:<ul> | |||
| <li><a class="el" href="acknowledge.html">Acknowledgements</a> | |||
| </li> | |||
| <li><a class="el" href="apinotes.html">API Notes</a> | |||
| </li> | |||
| <li><a class="el" href="compiling.html">Debugging & Compiling</a> | |||
| </li> | |||
| <li><a class="el" href="duplex.html">Duplex Mode</a> | |||
| </li> | |||
| <li><a class="el" href="errors.html">Error Handling</a> | |||
| </li> | |||
| <li><a class="el" href="license.html">License</a> | |||
| </li> | |||
| <li><a class="el" href="multi.html">Using Simultaneous Multiple APIs</a> | |||
| </li> | |||
| <li><a class="el" href="playback.html">Playback</a> | |||
| </li> | |||
| <li><a class="el" href="probe.html">Probing Device Capabilities</a> | |||
| </li> | |||
| <li><a class="el" href="recording.html">Recording</a> | |||
| </li> | |||
| <li><a class="el" href="settings.html">Device Settings</a> | |||
| </li> | |||
| </ul> | |||
| </div> | |||
| <div class="textblock">Here is a list of all related documentation pages:</div><div class="directory"> | |||
| <table class="directory"> | |||
| <tr id="row_0_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="acknowledge.html" target="_self">Acknowledgements</a></td><td class="desc"></td></tr> | |||
| <tr id="row_1_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="apinotes.html" target="_self">API Notes</a></td><td class="desc"></td></tr> | |||
| <tr id="row_2_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="compiling.html" target="_self">Debugging & Compiling</a></td><td class="desc"></td></tr> | |||
| <tr id="row_3_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="duplex.html" target="_self">Duplex Mode</a></td><td class="desc"></td></tr> | |||
| <tr id="row_4_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="errors.html" target="_self">Error Handling</a></td><td class="desc"></td></tr> | |||
| <tr id="row_5_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="license.html" target="_self">License</a></td><td class="desc"></td></tr> | |||
| <tr id="row_6_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="multi.html" target="_self">Using Simultaneous Multiple APIs</a></td><td class="desc"></td></tr> | |||
| <tr id="row_7_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="playback.html" target="_self">Playback</a></td><td class="desc"></td></tr> | |||
| <tr id="row_8_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="probe.html" target="_self">Probing Device Capabilities</a></td><td class="desc"></td></tr> | |||
| <tr id="row_9_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="recording.html" target="_self">Recording</a></td><td class="desc"></td></tr> | |||
| <tr id="row_10_" class="even"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="settings.html" target="_self">Device Settings</a></td><td class="desc"></td></tr> | |||
| </table> | |||
| </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> | |||
+ 80
- 79
doc/html/playback.html
View File
| @@ -8,89 +8,90 @@ | |||
| <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">Playback </div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1><a class="anchor" id="playback">Playback </a></h1><p>In this example, we provide a complete program that demonstrates the use of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> for audio playback. Our program produces a two-channel sawtooth waveform for output.</p> | |||
| <div class="fragment"><pre class="fragment"><span class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</span> | |||
| <span class="preprocessor">#include <iostream></span> | |||
| <span class="preprocessor">#include <cstdlib></span> | |||
| <span class="comment">// Two-channel sawtooth wave generator.</span> | |||
| <span class="keywordtype">int</span> saw( <span class="keywordtype">void</span> *outputBuffer, <span class="keywordtype">void</span> *inputBuffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nBufferFrames, | |||
| <span class="keywordtype">double</span> streamTime, <a class="code" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806" title="RtAudio stream status (over- or underflow) flags.">RtAudioStreamStatus</a> status, <span class="keywordtype">void</span> *userData ) | |||
| { | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i, j; | |||
| <span class="keywordtype">double</span> *buffer = (<span class="keywordtype">double</span> *) outputBuffer; | |||
| <span class="keywordtype">double</span> *lastValues = (<span class="keywordtype">double</span> *) userData; | |||
| <span class="keywordflow">if</span> ( status ) | |||
| std::cout << <span class="stringliteral">"Stream underflow detected!"</span> << std::endl; | |||
| <span class="comment">// Write interleaved audio data.</span> | |||
| <span class="keywordflow">for</span> ( i=0; i<nBufferFrames; i++ ) { | |||
| <span class="keywordflow">for</span> ( j=0; j<2; j++ ) { | |||
| *buffer++ = lastValues[j]; | |||
| lastValues[j] += 0.005 * (j+1+(j*0.1)); | |||
| <span class="keywordflow">if</span> ( lastValues[j] >= 1.0 ) lastValues[j] -= 2.0; | |||
| } | |||
| } | |||
| <span class="keywordflow">return</span> 0; | |||
| } | |||
| <span class="keywordtype">int</span> main() | |||
| { | |||
| <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> dac; | |||
| <span class="keywordflow">if</span> ( dac.<a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount</a>() < 1 ) { | |||
| std::cout << <span class="stringliteral">"\nNo audio devices found!\n"</span>; | |||
| exit( 0 ); | |||
| } | |||
| <a class="code" href="structRtAudio_1_1StreamParameters.html" title="The structure for specifying input or ouput stream parameters.">RtAudio::StreamParameters</a> parameters; | |||
| parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a> = dac.<a class="code" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc" title="A function that returns the index of the default output device.">getDefaultOutputDevice</a>(); | |||
| parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a> = 2; | |||
| parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">firstChannel</a> = 0; | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate = 44100; | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bufferFrames = 256; <span class="comment">// 256 sample frames</span> | |||
| <span class="keywordtype">double</span> data[2]; | |||
| <span class="keywordflow">try</span> { | |||
| dac.<a class="code" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">openStream</a>( &parameters, NULL, RTAUDIO_FLOAT64, | |||
| sampleRate, &bufferFrames, &saw, (<span class="keywordtype">void</span> *)&data ); | |||
| dac.<a class="code" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80" title="A function that starts a stream.">startStream</a>(); | |||
| } | |||
| <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a>& e ) { | |||
| e.<a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>(); | |||
| exit( 0 ); | |||
| } | |||
| <span class="keywordtype">char</span> input; | |||
| std::cout << <span class="stringliteral">"\nPlaying ... press <enter> to quit.\n"</span>; | |||
| std::cin.get( input ); | |||
| <span class="keywordflow">try</span> { | |||
| <span class="comment">// Stop the stream</span> | |||
| dac.<a class="code" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">stopStream</a>(); | |||
| } | |||
| <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a>& e) { | |||
| e.<a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>(); | |||
| } | |||
| <span class="keywordflow">if</span> ( dac.<a class="code" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f" title="Returns true if a stream is open and false if not.">isStreamOpen</a>() ) dac.<a class="code" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a" title="A function that closes a stream and frees any associated stream memory.">closeStream</a>(); | |||
| <span class="keywordflow">return</span> 0; | |||
| } | |||
| </pre></div><p>We open the stream in exactly the same way as the previous example (except with a data format change) and specify the address of our callback function <em>"saw()"</em>. The callback function will automatically be invoked when the underlying audio system needs data for output. Note that the callback function is called only when the stream is "running" (between calls to the <a class="el" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80" title="A function that starts a stream.">RtAudio::startStream()</a> and <a class="el" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">RtAudio::stopStream()</a> functions). We can also pass a pointer value 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 that is made available in the callback function. In this way, it is possible to gain access to arbitrary data created in our <em>main()</em> function from within the globally defined callback function.</p> | |||
| <div class="textblock"><p>In this example, we provide a complete program that demonstrates the use of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> for audio playback. Our program produces a two-channel sawtooth waveform for output.</p> | |||
| <div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</span></div> | |||
| <div class="line"><span class="preprocessor">#include <iostream></span></div> | |||
| <div class="line"><span class="preprocessor">#include <cstdlib></span></div> | |||
| <div class="line"></div> | |||
| <div class="line"><span class="comment">// Two-channel sawtooth wave generator.</span></div> | |||
| <div class="line"><span class="keywordtype">int</span> saw( <span class="keywordtype">void</span> *outputBuffer, <span class="keywordtype">void</span> *inputBuffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nBufferFrames,</div> | |||
| <div class="line"> <span class="keywordtype">double</span> streamTime, <a class="code" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806" title="RtAudio stream status (over- or underflow) flags.">RtAudioStreamStatus</a> status, <span class="keywordtype">void</span> *userData )</div> | |||
| <div class="line">{</div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i, j;</div> | |||
| <div class="line"> <span class="keywordtype">double</span> *buffer = (<span class="keywordtype">double</span> *) outputBuffer;</div> | |||
| <div class="line"> <span class="keywordtype">double</span> *lastValues = (<span class="keywordtype">double</span> *) userData;</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">if</span> ( status )</div> | |||
| <div class="line"> std::cout << <span class="stringliteral">"Stream underflow detected!"</span> << std::endl;</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="comment">// Write interleaved audio data.</span></div> | |||
| <div class="line"> <span class="keywordflow">for</span> ( i=0; i<nBufferFrames; i++ ) {</div> | |||
| <div class="line"> <span class="keywordflow">for</span> ( j=0; j<2; j++ ) {</div> | |||
| <div class="line"> *buffer++ = lastValues[j];</div> | |||
| <div class="line"></div> | |||
| <div class="line"> lastValues[j] += 0.005 * (j+1+(j*0.1));</div> | |||
| <div class="line"> <span class="keywordflow">if</span> ( lastValues[j] >= 1.0 ) lastValues[j] -= 2.0;</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">return</span> 0;</div> | |||
| <div class="line">}</div> | |||
| <div class="line"></div> | |||
| <div class="line"><span class="keywordtype">int</span> main()</div> | |||
| <div class="line">{</div> | |||
| <div class="line"> <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> dac;</div> | |||
| <div class="line"> <span class="keywordflow">if</span> ( dac.<a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount</a>() < 1 ) {</div> | |||
| <div class="line"> std::cout << <span class="stringliteral">"\nNo audio devices found!\n"</span>;</div> | |||
| <div class="line"> exit( 0 );</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <a class="code" href="structRtAudio_1_1StreamParameters.html" title="The structure for specifying input or ouput stream parameters.">RtAudio::StreamParameters</a> parameters;</div> | |||
| <div class="line"> parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a> = dac.<a class="code" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc" title="A function that returns the index of the default output device.">getDefaultOutputDevice</a>();</div> | |||
| <div class="line"> parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a> = 2;</div> | |||
| <div class="line"> parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">firstChannel</a> = 0;</div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate = 44100;</div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bufferFrames = 256; <span class="comment">// 256 sample frames</span></div> | |||
| <div class="line"> <span class="keywordtype">double</span> data[2];</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">try</span> {</div> | |||
| <div class="line"> dac.<a class="code" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b" title="A public function for opening a stream with the specified parameters.">openStream</a>( &parameters, NULL, RTAUDIO_FLOAT64,</div> | |||
| <div class="line"> sampleRate, &bufferFrames, &saw, (<span class="keywordtype">void</span> *)&data );</div> | |||
| <div class="line"> dac.<a class="code" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80" title="A function that starts a stream.">startStream</a>();</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"> <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a>& e ) {</div> | |||
| <div class="line"> e.<a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>();</div> | |||
| <div class="line"> exit( 0 );</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"> </div> | |||
| <div class="line"> <span class="keywordtype">char</span> input;</div> | |||
| <div class="line"> std::cout << <span class="stringliteral">"\nPlaying ... press <enter> to quit.\n"</span>;</div> | |||
| <div class="line"> std::cin.get( input );</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">try</span> {</div> | |||
| <div class="line"> <span class="comment">// Stop the stream</span></div> | |||
| <div class="line"> dac.<a class="code" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">stopStream</a>();</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"> <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a>& e) {</div> | |||
| <div class="line"> e.<a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>();</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">if</span> ( dac.<a class="code" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f" title="Returns true if a stream is open and false if not.">isStreamOpen</a>() ) dac.<a class="code" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a" title="A function that closes a stream and frees any associated stream memory.">closeStream</a>();</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">return</span> 0;</div> | |||
| <div class="line">}</div> | |||
| </div><!-- fragment --><p>We open the stream in exactly the same way as the previous example (except with a data format change) and specify the address of our callback function <em>"saw()"</em>. The callback function will automatically be invoked when the underlying audio system needs data for output. Note that the callback function is called only when the stream is "running" (between calls to the <a class="el" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80" title="A function that starts a stream.">RtAudio::startStream()</a> and <a class="el" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">RtAudio::stopStream()</a> functions). We can also pass a pointer value 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 that is made available in the callback function. In this way, it is possible to gain access to arbitrary data created in our <em>main()</em> function from within the globally defined callback function.</p> | |||
| <p>In this example, we stop the stream with an explicit call to <a class="el" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">RtAudio::stopStream()</a>. It is also possible to stop a stream by returning a non-zero value from the callback function. A return value of 1 will cause the stream to finish draining its internal buffers and then halt (equivalent to calling the <a class="el" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">RtAudio::stopStream()</a> function). A return value of 2 will cause the stream to stop immediately (equivalent to calling the <a class="el" href="classRtAudio.html#ad0586b47cd6bb9591a80b4052815991f" title="Stop a stream, discarding any samples remaining in the input/output queue.">RtAudio::abortStream()</a> function). </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> | |||
+ 57
- 56
doc/html/probe.html
View File
| @@ -8,67 +8,68 @@ | |||
| <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">Probing Device Capabilities </div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1><a class="anchor" id="probe">Probing Device Capabilities </a></h1><p>A programmer may wish to query the available audio device capabilities before deciding which to use. The following example outlines how this can be done.</p> | |||
| <div class="fragment"><pre class="fragment"><span class="comment">// audioprobe.cpp</span> | |||
| <span class="preprocessor">#include <iostream></span> | |||
| <span class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</span> | |||
| <span class="keywordtype">int</span> main() | |||
| { | |||
| <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> audio; | |||
| <span class="comment">// Determine the number of devices available</span> | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> devices = audio.<a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount</a>(); | |||
| <span class="comment">// Scan through devices for various capabilities</span> | |||
| <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> info; | |||
| <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<=devices; i++ ) { | |||
| info = audio.<a class="code" href="classRtAudio.html#a02d7ff44ad1d7eae22283a052f3dfda8" title="Return an RtAudio::DeviceInfo structure for a specified device number.">getDeviceInfo</a>( i ); | |||
| <span class="keywordflow">if</span> ( info.<a class="code" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">probed</a> == <span class="keyword">true</span> ) { | |||
| <span class="comment">// Print, for example, the maximum number of output channels for each device</span> | |||
| std::cout << <span class="stringliteral">"device = "</span> << i; | |||
| std::cout << <span class="stringliteral">": maximum output channels = "</span> << info.<a class="code" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">outputChannels</a> << <span class="stringliteral">"\n"</span>; | |||
| } | |||
| } | |||
| <span class="keywordflow">return</span> 0; | |||
| } | |||
| </pre></div><p>The <a class="el" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> structure is defined in <a class="el" href="RtAudio_8h.html">RtAudio.h</a> and provides a variety of information useful in assessing the capabilities of a device:</p> | |||
| <div class="fragment"><pre class="fragment"> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> { | |||
| <span class="keywordtype">bool</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">probed</a>; <span class="comment">// true if the device capabilities were successfully probed.</span> | |||
| std::string <a class="code" href="structRtAudio_1_1DeviceInfo.html#a24df596ab8d54f2eb540c7cf16212b3b">name</a>; <span class="comment">// Character string device identifier.</span> | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">outputChannels</a>; <span class="comment">// Maximum output channels supported by device.</span> | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">inputChannels</a>; <span class="comment">// Maximum input channels supported by device.</span> | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a3e8ad34c2d14e24293a0beafc26186e7">duplexChannels</a>; <span class="comment">// Maximum simultaneous input/output channels supported by device.</span> | |||
| <span class="keywordtype">bool</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a5365245e73ffe29a05734de4474acd58">isDefaultOutput</a>; <span class="comment">// true if this is the default output device.</span> | |||
| <span class="keywordtype">bool</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a7c8aca084bd908799b6be5954b80def2">isDefaultInput</a>; <span class="comment">// true if this is the default input device.</span> | |||
| std::vector<unsigned int> <a class="code" href="structRtAudio_1_1DeviceInfo.html#afa65f5f92f66ce7aacd3ff35e11b230f">sampleRates</a>; <span class="comment">// Supported sample rates.</span> | |||
| <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a23251b549b89b2fe04a57fcd7cb76ea4">nativeFormats</a>; <span class="comment">// Bit mask of supported data formats.</span> | |||
| }; | |||
| </pre></div><p>The following data formats are defined and fully supported by <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>:</p> | |||
| <div class="fragment"><pre class="fragment"> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a>; | |||
| <span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_SINT8; <span class="comment">// Signed 8-bit integer</span> | |||
| <span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_SINT16; <span class="comment">// Signed 16-bit integer</span> | |||
| <span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_SINT24; <span class="comment">// Signed 24-bit integer (lower 3 bytes of 32-bit signed integer.)</span> | |||
| <span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_SINT32; <span class="comment">// Signed 32-bit integer</span> | |||
| <span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_FLOAT32; <span class="comment">// 32-bit float normalized between +/- 1.0</span> | |||
| <span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_FLOAT64; <span class="comment">// 64-bit double normalized between +/- 1.0</span> | |||
| </pre></div><p>The <code>nativeFormats</code> member of the <a class="el" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> structure is a bit mask of the above formats which are natively supported by the device. However, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> will automatically provide format conversion if a particular format is not natively supported. When the <code>probed</code> member of the <a class="el" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> structure is false, the remaining structure members are undefined and the device is probably unusable.</p> | |||
| <div class="textblock"><p>A programmer may wish to query the available audio device capabilities before deciding which to use. The following example outlines how this can be done.</p> | |||
| <div class="fragment"><div class="line"><span class="comment">// audioprobe.cpp</span></div> | |||
| <div class="line"></div> | |||
| <div class="line"><span class="preprocessor">#include <iostream></span></div> | |||
| <div class="line"><span class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</span></div> | |||
| <div class="line"></div> | |||
| <div class="line"><span class="keywordtype">int</span> main()</div> | |||
| <div class="line">{</div> | |||
| <div class="line"> <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> audio;</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="comment">// Determine the number of devices available</span></div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> devices = audio.<a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount</a>();</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="comment">// Scan through devices for various capabilities</span></div> | |||
| <div class="line"> <a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> info;</div> | |||
| <div class="line"> <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<=devices; i++ ) {</div> | |||
| <div class="line"></div> | |||
| <div class="line"> info = audio.<a class="code" href="classRtAudio.html#a02d7ff44ad1d7eae22283a052f3dfda8" title="Return an RtAudio::DeviceInfo structure for a specified device number.">getDeviceInfo</a>( i );</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">if</span> ( info.<a class="code" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">probed</a> == <span class="keyword">true</span> ) {</div> | |||
| <div class="line"> <span class="comment">// Print, for example, the maximum number of output channels for each device</span></div> | |||
| <div class="line"> std::cout << <span class="stringliteral">"device = "</span> << i;</div> | |||
| <div class="line"> std::cout << <span class="stringliteral">": maximum output channels = "</span> << info.<a class="code" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">outputChannels</a> << <span class="stringliteral">"\n"</span>;</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">return</span> 0;</div> | |||
| <div class="line">}</div> | |||
| </div><!-- fragment --><p>The <a class="el" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> structure is defined in <a class="el" href="RtAudio_8h.html">RtAudio.h</a> and provides a variety of information useful in assessing the capabilities of a device:</p> | |||
| <div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> {</div> | |||
| <div class="line"> <span class="keywordtype">bool</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">probed</a>; <span class="comment">// true if the device capabilities were successfully probed.</span></div> | |||
| <div class="line"> std::string <a class="code" href="structRtAudio_1_1DeviceInfo.html#a24df596ab8d54f2eb540c7cf16212b3b">name</a>; <span class="comment">// Character string device identifier.</span></div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">outputChannels</a>; <span class="comment">// Maximum output channels supported by device.</span></div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">inputChannels</a>; <span class="comment">// Maximum input channels supported by device.</span></div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a3e8ad34c2d14e24293a0beafc26186e7">duplexChannels</a>; <span class="comment">// Maximum simultaneous input/output channels supported by device.</span></div> | |||
| <div class="line"> <span class="keywordtype">bool</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a5365245e73ffe29a05734de4474acd58">isDefaultOutput</a>; <span class="comment">// true if this is the default output device.</span></div> | |||
| <div class="line"> <span class="keywordtype">bool</span> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a7c8aca084bd908799b6be5954b80def2">isDefaultInput</a>; <span class="comment">// true if this is the default input device.</span></div> | |||
| <div class="line"> std::vector<unsigned int> <a class="code" href="structRtAudio_1_1DeviceInfo.html#afa65f5f92f66ce7aacd3ff35e11b230f">sampleRates</a>; <span class="comment">// Supported sample rates.</span></div> | |||
| <div class="line"> <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a> <a class="code" href="structRtAudio_1_1DeviceInfo.html#a23251b549b89b2fe04a57fcd7cb76ea4">nativeFormats</a>; <span class="comment">// Bit mask of supported data formats.</span></div> | |||
| <div class="line">};</div> | |||
| </div><!-- fragment --><p>The following data formats are defined and fully supported by <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a>:</p> | |||
| <div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8" title="RtAudio data format type.">RtAudioFormat</a>;</div> | |||
| <div class="line"><span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_SINT8; <span class="comment">// Signed 8-bit integer</span></div> | |||
| <div class="line"><span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_SINT16; <span class="comment">// Signed 16-bit integer</span></div> | |||
| <div class="line"><span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_SINT24; <span class="comment">// Signed 24-bit integer (lower 3 bytes of 32-bit signed integer.)</span></div> | |||
| <div class="line"><span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_SINT32; <span class="comment">// Signed 32-bit integer</span></div> | |||
| <div class="line"><span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_FLOAT32; <span class="comment">// 32-bit float normalized between +/- 1.0</span></div> | |||
| <div class="line"><span class="keyword">static</span> <span class="keyword">const</span> RtAudioFormat RTAUDIO_FLOAT64; <span class="comment">// 64-bit double normalized between +/- 1.0</span></div> | |||
| </div><!-- fragment --><p>The <code>nativeFormats</code> member of the <a class="el" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> structure is a bit mask of the above formats which are natively supported by the device. However, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> will automatically provide format conversion if a particular format is not natively supported. When the <code>probed</code> member of the <a class="el" href="structRtAudio_1_1DeviceInfo.html" title="The public device information structure for returning queried values.">RtAudio::DeviceInfo</a> structure is false, the remaining structure members are undefined and the device is probably unusable.</p> | |||
| <p>Some audio devices may require a minimum channel value greater than one. <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> will provide automatic channel number compensation when the number of channels set by the user is less than that required by the device. Channel compensation is <em>NOT</em> possible when the number of channels set by the user is greater than that supported by the device.</p> | |||
| <p>It should be noted that the capabilities reported by a device driver or underlying audio API are not always accurate and/or may be dependent on a combination of device settings. For this reason, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> does not rely on the queried values when attempting to open a stream. </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> | |||
+ 67
- 66
doc/html/recording.html
View File
| @@ -8,75 +8,76 @@ | |||
| <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">Recording </div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1><a class="anchor" id="recording">Recording </a></h1><p>Using <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> for audio input is almost identical to the way it is used for playback. Here's the blocking playback example rewritten for recording:</p> | |||
| <div class="fragment"><pre class="fragment"><span class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</span> | |||
| <span class="preprocessor">#include <iostream></span> | |||
| <span class="preprocessor">#include <cstdlib></span> | |||
| <span class="preprocessor">#include <cstring></span> | |||
| <span class="keywordtype">int</span> record( <span class="keywordtype">void</span> *outputBuffer, <span class="keywordtype">void</span> *inputBuffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nBufferFrames, | |||
| <span class="keywordtype">double</span> streamTime, <a class="code" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806" title="RtAudio stream status (over- or underflow) flags.">RtAudioStreamStatus</a> status, <span class="keywordtype">void</span> *userData ) | |||
| { | |||
| <span class="keywordflow">if</span> ( status ) | |||
| std::cout << <span class="stringliteral">"Stream overflow detected!"</span> << std::endl; | |||
| <span class="comment">// Do something with the data in the "inputBuffer" buffer.</span> | |||
| <span class="keywordflow">return</span> 0; | |||
| } | |||
| <span class="keywordtype">int</span> main() | |||
| { | |||
| <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> adc; | |||
| <span class="keywordflow">if</span> ( adc.<a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount</a>() < 1 ) { | |||
| std::cout << <span class="stringliteral">"\nNo audio devices found!\n"</span>; | |||
| exit( 0 ); | |||
| } | |||
| <a class="code" href="structRtAudio_1_1StreamParameters.html" title="The structure for specifying input or ouput stream parameters.">RtAudio::StreamParameters</a> parameters; | |||
| parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a> = adc.<a class="code" href="classRtAudio.html#aad8b94edd3cd379ee300b125750ac6ce" title="A function that returns the index of the default input device.">getDefaultInputDevice</a>(); | |||
| parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a> = 2; | |||
| parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">firstChannel</a> = 0; | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate = 44100; | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bufferFrames = 256; <span class="comment">// 256 sample frames</span> | |||
| <span class="keywordflow">try</span> { | |||
| adc.<a class="code" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">openStream</a>( NULL, &parameters, RTAUDIO_SINT16, | |||
| sampleRate, &bufferFrames, &record ); | |||
| adc.<a class="code" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80" title="A function that starts a stream.">startStream</a>(); | |||
| } | |||
| <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a>& e ) { | |||
| e.<a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>(); | |||
| exit( 0 ); | |||
| } | |||
| <span class="keywordtype">char</span> input; | |||
| std::cout << <span class="stringliteral">"\nRecording ... press <enter> to quit.\n"</span>; | |||
| std::cin.get( input ); | |||
| <span class="keywordflow">try</span> { | |||
| <span class="comment">// Stop the stream</span> | |||
| adc.<a class="code" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">stopStream</a>(); | |||
| } | |||
| <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a>& e) { | |||
| e.<a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>(); | |||
| } | |||
| <span class="keywordflow">if</span> ( adc.<a class="code" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f" title="Returns true if a stream is open and false if not.">isStreamOpen</a>() ) adc.<a class="code" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a" title="A function that closes a stream and frees any associated stream memory.">closeStream</a>(); | |||
| <span class="keywordflow">return</span> 0; | |||
| } | |||
| </pre></div><p>In this example, we pass the address of the stream parameter structure as the second argument of the <a class="el" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">RtAudio::openStream()</a> function and pass a NULL value for the output stream parameters. In this example, the <em>record()</em> callback function performs no specific operations. </p> | |||
| </div> | |||
| <div class="textblock"><p>Using <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> for audio input is almost identical to the way it is used for playback. Here's the blocking playback example rewritten for recording:</p> | |||
| <div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</span></div> | |||
| <div class="line"><span class="preprocessor">#include <iostream></span></div> | |||
| <div class="line"><span class="preprocessor">#include <cstdlib></span></div> | |||
| <div class="line"><span class="preprocessor">#include <cstring></span></div> | |||
| <div class="line"></div> | |||
| <div class="line"><span class="keywordtype">int</span> record( <span class="keywordtype">void</span> *outputBuffer, <span class="keywordtype">void</span> *inputBuffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nBufferFrames,</div> | |||
| <div class="line"> <span class="keywordtype">double</span> streamTime, <a class="code" href="RtAudio_8h.html#a80e306d363583da3b0a1b65d9b57c806" title="RtAudio stream status (over- or underflow) flags.">RtAudioStreamStatus</a> status, <span class="keywordtype">void</span> *userData )</div> | |||
| <div class="line">{</div> | |||
| <div class="line"> <span class="keywordflow">if</span> ( status )</div> | |||
| <div class="line"> std::cout << <span class="stringliteral">"Stream overflow detected!"</span> << std::endl;</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="comment">// Do something with the data in the "inputBuffer" buffer.</span></div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">return</span> 0;</div> | |||
| <div class="line">}</div> | |||
| <div class="line"></div> | |||
| <div class="line"><span class="keywordtype">int</span> main()</div> | |||
| <div class="line">{</div> | |||
| <div class="line"> <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> adc;</div> | |||
| <div class="line"> <span class="keywordflow">if</span> ( adc.<a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount</a>() < 1 ) {</div> | |||
| <div class="line"> std::cout << <span class="stringliteral">"\nNo audio devices found!\n"</span>;</div> | |||
| <div class="line"> exit( 0 );</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <a class="code" href="structRtAudio_1_1StreamParameters.html" title="The structure for specifying input or ouput stream parameters.">RtAudio::StreamParameters</a> parameters;</div> | |||
| <div class="line"> parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a> = adc.<a class="code" href="classRtAudio.html#aad8b94edd3cd379ee300b125750ac6ce" title="A function that returns the index of the default input device.">getDefaultInputDevice</a>();</div> | |||
| <div class="line"> parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a> = 2;</div> | |||
| <div class="line"> parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">firstChannel</a> = 0;</div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate = 44100;</div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bufferFrames = 256; <span class="comment">// 256 sample frames</span></div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">try</span> {</div> | |||
| <div class="line"> adc.<a class="code" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b" title="A public function for opening a stream with the specified parameters.">openStream</a>( NULL, &parameters, RTAUDIO_SINT16,</div> | |||
| <div class="line"> sampleRate, &bufferFrames, &record );</div> | |||
| <div class="line"> adc.<a class="code" href="classRtAudio.html#aec017a89629ccef66a90b60be22a2f80" title="A function that starts a stream.">startStream</a>();</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"> <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a>& e ) {</div> | |||
| <div class="line"> e.<a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>();</div> | |||
| <div class="line"> exit( 0 );</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"> </div> | |||
| <div class="line"> <span class="keywordtype">char</span> input;</div> | |||
| <div class="line"> std::cout << <span class="stringliteral">"\nRecording ... press <enter> to quit.\n"</span>;</div> | |||
| <div class="line"> std::cin.get( input );</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">try</span> {</div> | |||
| <div class="line"> <span class="comment">// Stop the stream</span></div> | |||
| <div class="line"> adc.<a class="code" href="classRtAudio.html#af4c241ff86936ecc8108f0d9dfe3efdd" title="Stop a stream, allowing any samples remaining in the output queue to be played.">stopStream</a>();</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"> <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a>& e) {</div> | |||
| <div class="line"> e.<a class="code" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc" title="Prints thrown error message to stderr.">printMessage</a>();</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">if</span> ( adc.<a class="code" href="classRtAudio.html#a3863e45ff81dbe97176de0ee7545917f" title="Returns true if a stream is open and false if not.">isStreamOpen</a>() ) adc.<a class="code" href="classRtAudio.html#a90d599002ad32cf250a4cb866f2cc93a" title="A function that closes a stream and frees any associated stream memory.">closeStream</a>();</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">return</span> 0;</div> | |||
| <div class="line">}</div> | |||
| </div><!-- fragment --><p>In this example, we pass the address of the stream parameter structure as the second argument of the <a class="el" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b" title="A public function for opening a stream with the specified parameters.">RtAudio::openStream()</a> function and pass a NULL value for the output stream parameters. In this example, the <em>record()</em> callback function performs no specific operations. </p> | |||
| </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> | |||
+ 37
- 36
doc/html/settings.html
View File
| @@ -8,50 +8,51 @@ | |||
| <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">Device Settings </div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1><a class="anchor" id="settings">Device Settings </a></h1><p>The next step in using <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> is to open a stream with particular device and parameter settings.</p> | |||
| <div class="fragment"><pre class="fragment"><span class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</span> | |||
| <span class="keywordtype">int</span> main() | |||
| { | |||
| <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> dac; | |||
| <span class="keywordflow">if</span> ( dac.<a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount</a>() == 0 ) exit( 0 ); | |||
| <a class="code" href="structRtAudio_1_1StreamParameters.html" title="The structure for specifying input or ouput stream parameters.">RtAudio::StreamParameters</a> parameters; | |||
| parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a> = dac.<a class="code" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc" title="A function that returns the index of the default output device.">getDefaultOutputDevice</a>(); | |||
| parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a> = 2; | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate = 44100; | |||
| <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bufferFrames = 256; <span class="comment">// 256 sample frames</span> | |||
| <a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> options; | |||
| options.<a class="code" href="structRtAudio_1_1StreamOptions.html#a0ecc98b031aa3af49d09b781643e298b">flags</a> = RTAUDIO_NONINTERLEAVED; | |||
| <span class="keywordflow">try</span> { | |||
| dac.<a class="code" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">openStream</a>( &parameters, NULL, RTAUDIO_FLOAT32, | |||
| sampleRate, &bufferFrames, &myCallback, NULL, &options ); | |||
| } | |||
| <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a>& e ) { | |||
| std::cout << <span class="charliteral">'\n'</span> << e.<a class="code" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50" title="Returns the thrown error message string.">getMessage</a>() << <span class="charliteral">'\n'</span> << std::endl; | |||
| exit( 0 ); | |||
| } | |||
| <span class="keywordflow">return</span> 0; | |||
| } | |||
| </pre></div><p>The <a class="el" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">RtAudio::openStream()</a> function attempts to open a stream with a specified set of parameter values. In the above example, we attempt to open a two channel playback stream using the default output device, 32-bit floating point data, a sample rate of 44100 Hz, and a frame rate of 256 sample frames per output buffer. If the user specifies an invalid parameter value (such as a device id greater than or equal to the number of enumerated devices), an <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> is thrown of type = INVALID_USE. If a system error occurs or the device does not support the specified parameter values, an <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> of type = SYSTEM_ERROR is thrown. In either case, a descriptive error message is bundled with the exception and can be queried with the <a class="el" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50" title="Returns the thrown error message string.">RtError::getMessage()</a> or <a class="el" href="classRtError.html#aeb843b7a7785d66061c61ebfc29e7e9d" title="Returns the thrown error message as a c-style string.">RtError::what()</a> functions.</p> | |||
| <div class="textblock"><p>The next step in using <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> is to open a stream with particular device and parameter settings.</p> | |||
| <div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</span></div> | |||
| <div class="line"></div> | |||
| <div class="line"><span class="keywordtype">int</span> main()</div> | |||
| <div class="line">{</div> | |||
| <div class="line"> <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> dac;</div> | |||
| <div class="line"> <span class="keywordflow">if</span> ( dac.<a class="code" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount</a>() == 0 ) exit( 0 );</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <a class="code" href="structRtAudio_1_1StreamParameters.html" title="The structure for specifying input or ouput stream parameters.">RtAudio::StreamParameters</a> parameters;</div> | |||
| <div class="line"> parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a> = dac.<a class="code" href="classRtAudio.html#a3a3f3dbe13ea696b521e49cdaaa357bc" title="A function that returns the index of the default output device.">getDefaultOutputDevice</a>();</div> | |||
| <div class="line"> parameters.<a class="code" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a> = 2;</div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate = 44100;</div> | |||
| <div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bufferFrames = 256; <span class="comment">// 256 sample frames</span></div> | |||
| <div class="line"></div> | |||
| <div class="line"> <a class="code" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> options;</div> | |||
| <div class="line"> options.<a class="code" href="structRtAudio_1_1StreamOptions.html#a0ecc98b031aa3af49d09b781643e298b">flags</a> = RTAUDIO_NONINTERLEAVED;</div> | |||
| <div class="line"></div> | |||
| <div class="line"> <span class="keywordflow">try</span> {</div> | |||
| <div class="line"> dac.<a class="code" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b" title="A public function for opening a stream with the specified parameters.">openStream</a>( &parameters, NULL, RTAUDIO_FLOAT32,</div> | |||
| <div class="line"> sampleRate, &bufferFrames, &myCallback, NULL, &options );</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"> <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a>& e ) {</div> | |||
| <div class="line"> std::cout << <span class="charliteral">'\n'</span> << e.<a class="code" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50" title="Returns the thrown error message string.">getMessage</a>() << <span class="charliteral">'\n'</span> << std::endl;</div> | |||
| <div class="line"> exit( 0 );</div> | |||
| <div class="line"> }</div> | |||
| <div class="line"> </div> | |||
| <div class="line"> <span class="keywordflow">return</span> 0;</div> | |||
| <div class="line">}</div> | |||
| </div><!-- fragment --><p>The <a class="el" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b" title="A public function for opening a stream with the specified parameters.">RtAudio::openStream()</a> function attempts to open a stream with a specified set of parameter values. In the above example, we attempt to open a two channel playback stream using the default output device, 32-bit floating point data, a sample rate of 44100 Hz, and a frame rate of 256 sample frames per output buffer. If the user specifies an invalid parameter value (such as a device id greater than or equal to the number of enumerated devices), an <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> is thrown of type = INVALID_USE. If a system error occurs or the device does not support the specified parameter values, an <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> of type = SYSTEM_ERROR is thrown. In either case, a descriptive error message is bundled with the exception and can be queried with the <a class="el" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50" title="Returns the thrown error message string.">RtError::getMessage()</a> or <a class="el" href="classRtError.html#aeb843b7a7785d66061c61ebfc29e7e9d" title="Returns the thrown error message as a c-style string.">RtError::what()</a> functions.</p> | |||
| <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> provides four signed integer and two floating point data formats which can be specified using the RtAudioFormat parameter values mentioned earlier. If the opened device does not natively support the given format, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> will automatically perform the necessary data format conversion.</p> | |||
| <p>The <code>bufferFrames</code> parameter specifies the desired number of sample frames that will be written to and/or read from a device per write/read operation. This parameter can be used to control stream latency though there is no guarantee that the passed value will be that used by a device. In general, a lower <code>bufferFrames</code> value will produce less latency but perhaps less robust performance. A value of zero can be specified, in which case the smallest allowable value will be used. The <code>bufferFrames</code> parameter is passed as a pointer and the actual value used by the stream is set during the device setup procedure. <code>bufferFrames</code> values should be a power of two. Optimal and allowable buffer values tend to vary between systems and devices. Stream latency can also be controlled via the optional <a class="el" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> member <code>numberOfBuffers</code> (not used in the example above), though this tends to be more system dependent. In particular, the <code>numberOfBuffers</code> parameter is ignored when using the OS-X Core Audio, Jack, and the Windows ASIO APIs.</p> | |||
| <p>As noted earlier, the device capabilities reported by a driver or underlying audio API are not always accurate and/or may be dependent on a combination of device settings. Because of this, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> does not attempt to query a device's capabilities or use previously reported values when opening a device. Instead, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> simply attempts to set the given parameters on a specified device and then checks whether the setup is successful or not.</p> | |||
| <p>The RtAudioCallback parameter above is a pointer to a user-defined function that will be called whenever the audio system is ready for new output data or has new input data to be read. Further details on the use of a callback function are provided in the next section.</p> | |||
| <p>Several stream options are available to fine-tune the behavior of an audio stream. In the example above, we specify that data will be written by the user in a <em>non-interleaved</em> format via the <a class="el" href="structRtAudio_1_1StreamOptions.html" title="The structure for specifying stream options.">RtAudio::StreamOptions</a> member <code>flags</code>. That is, all <code>bufferFrames</code> of the first channel should be written consecutively, followed by all <code>bufferFrames</code> of the second channel. By default (when no option is specified), <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> expects data to be written in an <em>interleaved</em> format. </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> | |||
+ 24
- 15
doc/html/structRtAudio_1_1DeviceInfo-members.html
View File
| @@ -8,24 +8,33 @@ | |||
| <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 id="nav-path" class="navpath"> | |||
| <ul> | |||
| <li class="navelem"><a class="el" href="classRtAudio.html">RtAudio</a></li><li class="navelem"><a class="el" href="structRtAudio_1_1DeviceInfo.html">DeviceInfo</a></li> </ul> | |||
| </div> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="headertitle"> | |||
| <div class="title">RtAudio::DeviceInfo Member List</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>RtAudio::DeviceInfo Member List</h1>This is the complete list of members for <a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a>, including all inherited members.<table> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1DeviceInfo.html#a3e8ad34c2d14e24293a0beafc26186e7">duplexChannels</a></td><td><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">inputChannels</a></td><td><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1DeviceInfo.html#a7c8aca084bd908799b6be5954b80def2">isDefaultInput</a></td><td><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1DeviceInfo.html#a5365245e73ffe29a05734de4474acd58">isDefaultOutput</a></td><td><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1DeviceInfo.html#a24df596ab8d54f2eb540c7cf16212b3b">name</a></td><td><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1DeviceInfo.html#a23251b549b89b2fe04a57fcd7cb76ea4">nativeFormats</a></td><td><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">outputChannels</a></td><td><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">probed</a></td><td><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1DeviceInfo.html#afa65f5f92f66ce7aacd3ff35e11b230f">sampleRates</a></td><td><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td></td></tr> | |||
| </table></div> | |||
| <HR> | |||
| <p>This is the complete list of members for <a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a>, including all inherited members.</p> | |||
| <table class="directory"> | |||
| <tr class="even"><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a3e8ad34c2d14e24293a0beafc26186e7">duplexChannels</a></td><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">inputChannels</a></td><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a7c8aca084bd908799b6be5954b80def2">isDefaultInput</a></td><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a5365245e73ffe29a05734de4474acd58">isDefaultOutput</a></td><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a24df596ab8d54f2eb540c7cf16212b3b">name</a></td><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a23251b549b89b2fe04a57fcd7cb76ea4">nativeFormats</a></td><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">outputChannels</a></td><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">probed</a></td><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html#afa65f5f92f66ce7aacd3ff35e11b230f">sampleRates</a></td><td class="entry"><a class="el" href="structRtAudio_1_1DeviceInfo.html">RtAudio::DeviceInfo</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> | |||
+ 68
- 61
doc/html/structRtAudio_1_1DeviceInfo.html
View File
| @@ -8,154 +8,163 @@ | |||
| <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 --> | |||
| <div class="navpath"><a class="el" href="classRtAudio.html">RtAudio</a>::<a class="el" href="structRtAudio_1_1DeviceInfo.html">DeviceInfo</a> | |||
| </div> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| <div id="nav-path" class="navpath"> | |||
| <ul> | |||
| <li class="navelem"><a class="el" href="classRtAudio.html">RtAudio</a></li><li class="navelem"><a class="el" href="structRtAudio_1_1DeviceInfo.html">DeviceInfo</a></li> </ul> | |||
| </div> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="summary"> | |||
| <a href="#pub-attribs">Public Attributes</a> | | |||
| <a href="structRtAudio_1_1DeviceInfo-members.html">List of all members</a> </div> | |||
| <div class="headertitle"> | |||
| <div class="title">RtAudio::DeviceInfo Struct Reference</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>RtAudio::DeviceInfo Struct Reference</h1><!-- doxytag: class="RtAudio::DeviceInfo" --> | |||
| <p>The public device information structure for returning queried values. | |||
| <a href="#_details">More...</a></p> | |||
| <a href="structRtAudio_1_1DeviceInfo.html#details">More...</a></p> | |||
| <p><code>#include <<a class="el" href="RtAudio_8h_source.html">RtAudio.h</a>></code></p> | |||
| <p><a href="structRtAudio_1_1DeviceInfo-members.html">List of all members.</a></p> | |||
| <table border="0" cellpadding="0" cellspacing="0"> | |||
| <tr><td colspan="2"><h2>Public Attributes</h2></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">probed</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a24df596ab8d54f2eb540c7cf16212b3b">name</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">outputChannels</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">inputChannels</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a3e8ad34c2d14e24293a0beafc26186e7">duplexChannels</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a5365245e73ffe29a05734de4474acd58">isDefaultOutput</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a7c8aca084bd908799b6be5954b80def2">isDefaultInput</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">std::vector< unsigned int > </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#afa65f5f92f66ce7aacd3ff35e11b230f">sampleRates</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a23251b549b89b2fe04a57fcd7cb76ea4">nativeFormats</a></td></tr> | |||
| <table class="memberdecls"> | |||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> | |||
| Public Attributes</h2></td></tr> | |||
| <tr class="memitem:a97573717ccb1e75a834a0a108cd6982d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">probed</a></td></tr> | |||
| <tr class="separator:a97573717ccb1e75a834a0a108cd6982d"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a24df596ab8d54f2eb540c7cf16212b3b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a24df596ab8d54f2eb540c7cf16212b3b">name</a></td></tr> | |||
| <tr class="separator:a24df596ab8d54f2eb540c7cf16212b3b"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a81aaf488f8158ef55b1bb678f66feb7d"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">outputChannels</a></td></tr> | |||
| <tr class="separator:a81aaf488f8158ef55b1bb678f66feb7d"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a56247b458a937ae84d98ca9c4b243275"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">inputChannels</a></td></tr> | |||
| <tr class="separator:a56247b458a937ae84d98ca9c4b243275"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a3e8ad34c2d14e24293a0beafc26186e7"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a3e8ad34c2d14e24293a0beafc26186e7">duplexChannels</a></td></tr> | |||
| <tr class="separator:a3e8ad34c2d14e24293a0beafc26186e7"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a5365245e73ffe29a05734de4474acd58"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a5365245e73ffe29a05734de4474acd58">isDefaultOutput</a></td></tr> | |||
| <tr class="separator:a5365245e73ffe29a05734de4474acd58"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a7c8aca084bd908799b6be5954b80def2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a7c8aca084bd908799b6be5954b80def2">isDefaultInput</a></td></tr> | |||
| <tr class="separator:a7c8aca084bd908799b6be5954b80def2"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:afa65f5f92f66ce7aacd3ff35e11b230f"><td class="memItemLeft" align="right" valign="top">std::vector< unsigned int > </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#afa65f5f92f66ce7aacd3ff35e11b230f">sampleRates</a></td></tr> | |||
| <tr class="separator:afa65f5f92f66ce7aacd3ff35e11b230f"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a23251b549b89b2fe04a57fcd7cb76ea4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a23251b549b89b2fe04a57fcd7cb76ea4">nativeFormats</a></td></tr> | |||
| <tr class="separator:a23251b549b89b2fe04a57fcd7cb76ea4"><td class="memSeparator" colspan="2"> </td></tr> | |||
| </table> | |||
| <hr/><a name="_details"></a><h2>Detailed Description</h2> | |||
| <p>The public device information structure for returning queried values. </p> | |||
| <hr/><h2>Member Data Documentation</h2> | |||
| <a class="anchor" id="a97573717ccb1e75a834a0a108cd6982d"></a><!-- doxytag: member="RtAudio::DeviceInfo::probed" ref="a97573717ccb1e75a834a0a108cd6982d" args="" --> | |||
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> | |||
| <div class="textblock"><p>The public device information structure for returning queried values. </p> | |||
| </div><h2 class="groupheader">Member Data Documentation</h2> | |||
| <a class="anchor" id="a97573717ccb1e75a834a0a108cd6982d"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">bool <a class="el" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">RtAudio::DeviceInfo::probed</a></td> | |||
| <td class="memname">bool RtAudio::DeviceInfo::probed</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>true if the device capabilities were successfully probed. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a24df596ab8d54f2eb540c7cf16212b3b"></a><!-- doxytag: member="RtAudio::DeviceInfo::name" ref="a24df596ab8d54f2eb540c7cf16212b3b" args="" --> | |||
| <a class="anchor" id="a24df596ab8d54f2eb540c7cf16212b3b"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">std::string <a class="el" href="structRtAudio_1_1DeviceInfo.html#a24df596ab8d54f2eb540c7cf16212b3b">RtAudio::DeviceInfo::name</a></td> | |||
| <td class="memname">std::string RtAudio::DeviceInfo::name</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>Character string device identifier. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a81aaf488f8158ef55b1bb678f66feb7d"></a><!-- doxytag: member="RtAudio::DeviceInfo::outputChannels" ref="a81aaf488f8158ef55b1bb678f66feb7d" args="" --> | |||
| <a class="anchor" id="a81aaf488f8158ef55b1bb678f66feb7d"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">unsigned int <a class="el" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">RtAudio::DeviceInfo::outputChannels</a></td> | |||
| <td class="memname">unsigned int RtAudio::DeviceInfo::outputChannels</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>Maximum output channels supported by device. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a56247b458a937ae84d98ca9c4b243275"></a><!-- doxytag: member="RtAudio::DeviceInfo::inputChannels" ref="a56247b458a937ae84d98ca9c4b243275" args="" --> | |||
| <a class="anchor" id="a56247b458a937ae84d98ca9c4b243275"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">unsigned int <a class="el" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">RtAudio::DeviceInfo::inputChannels</a></td> | |||
| <td class="memname">unsigned int RtAudio::DeviceInfo::inputChannels</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>Maximum input channels supported by device. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a3e8ad34c2d14e24293a0beafc26186e7"></a><!-- doxytag: member="RtAudio::DeviceInfo::duplexChannels" ref="a3e8ad34c2d14e24293a0beafc26186e7" args="" --> | |||
| <a class="anchor" id="a3e8ad34c2d14e24293a0beafc26186e7"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">unsigned int <a class="el" href="structRtAudio_1_1DeviceInfo.html#a3e8ad34c2d14e24293a0beafc26186e7">RtAudio::DeviceInfo::duplexChannels</a></td> | |||
| <td class="memname">unsigned int RtAudio::DeviceInfo::duplexChannels</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>Maximum simultaneous input/output channels supported by device. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a5365245e73ffe29a05734de4474acd58"></a><!-- doxytag: member="RtAudio::DeviceInfo::isDefaultOutput" ref="a5365245e73ffe29a05734de4474acd58" args="" --> | |||
| <a class="anchor" id="a5365245e73ffe29a05734de4474acd58"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">bool <a class="el" href="structRtAudio_1_1DeviceInfo.html#a5365245e73ffe29a05734de4474acd58">RtAudio::DeviceInfo::isDefaultOutput</a></td> | |||
| <td class="memname">bool RtAudio::DeviceInfo::isDefaultOutput</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>true if this is the default output device. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a7c8aca084bd908799b6be5954b80def2"></a><!-- doxytag: member="RtAudio::DeviceInfo::isDefaultInput" ref="a7c8aca084bd908799b6be5954b80def2" args="" --> | |||
| <a class="anchor" id="a7c8aca084bd908799b6be5954b80def2"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">bool <a class="el" href="structRtAudio_1_1DeviceInfo.html#a7c8aca084bd908799b6be5954b80def2">RtAudio::DeviceInfo::isDefaultInput</a></td> | |||
| <td class="memname">bool RtAudio::DeviceInfo::isDefaultInput</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>true if this is the default input device. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="afa65f5f92f66ce7aacd3ff35e11b230f"></a><!-- doxytag: member="RtAudio::DeviceInfo::sampleRates" ref="afa65f5f92f66ce7aacd3ff35e11b230f" args="" --> | |||
| <a class="anchor" id="afa65f5f92f66ce7aacd3ff35e11b230f"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">std::vector<unsigned int> <a class="el" href="structRtAudio_1_1DeviceInfo.html#afa65f5f92f66ce7aacd3ff35e11b230f">RtAudio::DeviceInfo::sampleRates</a></td> | |||
| <td class="memname">std::vector<unsigned int> RtAudio::DeviceInfo::sampleRates</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>Supported sample rates (queried from list of standard rates). </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a23251b549b89b2fe04a57fcd7cb76ea4"></a><!-- doxytag: member="RtAudio::DeviceInfo::nativeFormats" ref="a23251b549b89b2fe04a57fcd7cb76ea4" args="" --> | |||
| <a class="anchor" id="a23251b549b89b2fe04a57fcd7cb76ea4"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname"><a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a> <a class="el" href="structRtAudio_1_1DeviceInfo.html#a23251b549b89b2fe04a57fcd7cb76ea4">RtAudio::DeviceInfo::nativeFormats</a></td> | |||
| <td class="memname"><a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a> RtAudio::DeviceInfo::nativeFormats</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>Bit mask of supported data formats. </p> | |||
| </div> | |||
| @@ -163,12 +172,10 @@ | |||
| <hr/>The documentation for this struct was generated from the following file:<ul> | |||
| <li><a class="el" href="RtAudio_8h_source.html">RtAudio.h</a></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> | |||
+ 19
- 10
doc/html/structRtAudio_1_1StreamOptions-members.html
View File
| @@ -8,19 +8,28 @@ | |||
| <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 id="nav-path" class="navpath"> | |||
| <ul> | |||
| <li class="navelem"><a class="el" href="classRtAudio.html">RtAudio</a></li><li class="navelem"><a class="el" href="structRtAudio_1_1StreamOptions.html">StreamOptions</a></li> </ul> | |||
| </div> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="headertitle"> | |||
| <div class="title">RtAudio::StreamOptions Member List</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>RtAudio::StreamOptions Member List</h1>This is the complete list of members for <a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a>, including all inherited members.<table> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1StreamOptions.html#a0ecc98b031aa3af49d09b781643e298b">flags</a></td><td><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1StreamOptions.html#a75a14cfab903d0e1c091bc16aec80240">numberOfBuffers</a></td><td><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1StreamOptions.html#adfd267059434edb21573c584e6367def">priority</a></td><td><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1StreamOptions.html#a2a4b0b8d690c624d20f4e8f4be6ca9ba">streamName</a></td><td><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a></td><td></td></tr> | |||
| </table></div> | |||
| <HR> | |||
| <p>This is the complete list of members for <a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a>, including all inherited members.</p> | |||
| <table class="directory"> | |||
| <tr class="even"><td class="entry"><a class="el" href="structRtAudio_1_1StreamOptions.html#a0ecc98b031aa3af49d09b781643e298b">flags</a></td><td class="entry"><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="structRtAudio_1_1StreamOptions.html#a75a14cfab903d0e1c091bc16aec80240">numberOfBuffers</a></td><td class="entry"><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="structRtAudio_1_1StreamOptions.html#adfd267059434edb21573c584e6367def">priority</a></td><td class="entry"><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="structRtAudio_1_1StreamOptions.html#a2a4b0b8d690c624d20f4e8f4be6ca9ba">streamName</a></td><td class="entry"><a class="el" href="structRtAudio_1_1StreamOptions.html">RtAudio::StreamOptions</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> | |||
+ 46
- 39
doc/html/structRtAudio_1_1StreamOptions.html
View File
| @@ -8,26 +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 --> | |||
| <div class="navpath"><a class="el" href="classRtAudio.html">RtAudio</a>::<a class="el" href="structRtAudio_1_1StreamOptions.html">StreamOptions</a> | |||
| </div> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| <div id="nav-path" class="navpath"> | |||
| <ul> | |||
| <li class="navelem"><a class="el" href="classRtAudio.html">RtAudio</a></li><li class="navelem"><a class="el" href="structRtAudio_1_1StreamOptions.html">StreamOptions</a></li> </ul> | |||
| </div> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="summary"> | |||
| <a href="#pub-attribs">Public Attributes</a> | | |||
| <a href="structRtAudio_1_1StreamOptions-members.html">List of all members</a> </div> | |||
| <div class="headertitle"> | |||
| <div class="title">RtAudio::StreamOptions Struct Reference</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>RtAudio::StreamOptions Struct Reference</h1><!-- doxytag: class="RtAudio::StreamOptions" --> | |||
| <p>The structure for specifying stream options. | |||
| <a href="#_details">More...</a></p> | |||
| <a href="structRtAudio_1_1StreamOptions.html#details">More...</a></p> | |||
| <p><code>#include <<a class="el" href="RtAudio_8h_source.html">RtAudio.h</a>></code></p> | |||
| <p><a href="structRtAudio_1_1StreamOptions-members.html">List of all members.</a></p> | |||
| <table border="0" cellpadding="0" cellspacing="0"> | |||
| <tr><td colspan="2"><h2>Public Attributes</h2></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41">RtAudioStreamFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamOptions.html#a0ecc98b031aa3af49d09b781643e298b">flags</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamOptions.html#a75a14cfab903d0e1c091bc16aec80240">numberOfBuffers</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamOptions.html#a2a4b0b8d690c624d20f4e8f4be6ca9ba">streamName</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamOptions.html#adfd267059434edb21573c584e6367def">priority</a></td></tr> | |||
| <table class="memberdecls"> | |||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> | |||
| Public Attributes</h2></td></tr> | |||
| <tr class="memitem:a0ecc98b031aa3af49d09b781643e298b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41">RtAudioStreamFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamOptions.html#a0ecc98b031aa3af49d09b781643e298b">flags</a></td></tr> | |||
| <tr class="separator:a0ecc98b031aa3af49d09b781643e298b"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a75a14cfab903d0e1c091bc16aec80240"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamOptions.html#a75a14cfab903d0e1c091bc16aec80240">numberOfBuffers</a></td></tr> | |||
| <tr class="separator:a75a14cfab903d0e1c091bc16aec80240"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a2a4b0b8d690c624d20f4e8f4be6ca9ba"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamOptions.html#a2a4b0b8d690c624d20f4e8f4be6ca9ba">streamName</a></td></tr> | |||
| <tr class="separator:a2a4b0b8d690c624d20f4e8f4be6ca9ba"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:adfd267059434edb21573c584e6367def"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamOptions.html#adfd267059434edb21573c584e6367def">priority</a></td></tr> | |||
| <tr class="separator:adfd267059434edb21573c584e6367def"><td class="memSeparator" colspan="2"> </td></tr> | |||
| </table> | |||
| <hr/><a name="_details"></a><h2>Detailed Description</h2> | |||
| <p>The structure for specifying stream options. </p> | |||
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> | |||
| <div class="textblock"><p>The structure for specifying stream options. </p> | |||
| <p>The following flags can be OR'ed together to allow a client to make changes to the default stream behavior:</p> | |||
| <ul> | |||
| <li><em>RTAUDIO_NONINTERLEAVED:</em> Use non-interleaved buffers (default = interleaved).</li> | |||
| @@ -36,66 +49,62 @@ | |||
| <li><em>RTAUDIO_SCHEDULE_REALTIME:</em> Attempt to select realtime scheduling for callback thread.</li> | |||
| <li><em>RTAUDIO_ALSA_USE_DEFAULT:</em> Use the "default" PCM device (ALSA only).</li> | |||
| </ul> | |||
| <p>By default, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> streams pass and receive audio data from the client in an interleaved format. By passing the RTAUDIO_NONINTERLEAVED flag to the <a class="el" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">openStream()</a> function, audio data will instead be presented in non-interleaved buffers. In this case, each buffer argument in the RtAudioCallback function will point to a single array of data, with <code>nFrames</code> samples for each channel concatenated back-to-back. For example, the first sample of data for the second channel would be located at index <code>nFrames</code> (assuming the <code>buffer</code> pointer was recast to the correct data type for the stream).</p> | |||
| <p>Certain audio APIs offer a number of parameters that influence the I/O latency of a stream. By default, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> will attempt to set these parameters internally for robust (glitch-free) performance (though some APIs, like Windows Direct Sound, make this difficult). By passing the RTAUDIO_MINIMIZE_LATENCY flag to the <a class="el" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">openStream()</a> function, internal stream settings will be influenced in an attempt to minimize stream latency, though possibly at the expense of stream performance.</p> | |||
| <p>By default, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> streams pass and receive audio data from the client in an interleaved format. By passing the RTAUDIO_NONINTERLEAVED flag to the <a class="el" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b" title="A public function for opening a stream with the specified parameters.">openStream()</a> function, audio data will instead be presented in non-interleaved buffers. In this case, each buffer argument in the RtAudioCallback function will point to a single array of data, with <code>nFrames</code> samples for each channel concatenated back-to-back. For example, the first sample of data for the second channel would be located at index <code>nFrames</code> (assuming the <code>buffer</code> pointer was recast to the correct data type for the stream).</p> | |||
| <p>Certain audio APIs offer a number of parameters that influence the I/O latency of a stream. By default, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> will attempt to set these parameters internally for robust (glitch-free) performance (though some APIs, like Windows Direct Sound, make this difficult). By passing the RTAUDIO_MINIMIZE_LATENCY flag to the <a class="el" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b" title="A public function for opening a stream with the specified parameters.">openStream()</a> function, internal stream settings will be influenced in an attempt to minimize stream latency, though possibly at the expense of stream performance.</p> | |||
| <p>If the RTAUDIO_HOG_DEVICE flag is set, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> will attempt to open the input and/or output stream device(s) for exclusive use. Note that this is not possible with all supported audio APIs.</p> | |||
| <p>If the RTAUDIO_SCHEDULE_REALTIME flag is set, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> will attempt to select realtime scheduling (round-robin) for the callback thread. The <code>priority</code> parameter will only be used if the RTAUDIO_SCHEDULE_REALTIME flag is set. It defines the thread's realtime priority.</p> | |||
| <p>If the RTAUDIO_ALSA_USE_DEFAULT flag is set, <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> will attempt to open the "default" PCM device when using the ALSA API. Note that this will override any specified input or output device id.</p> | |||
| <p>The <code>numberOfBuffers</code> parameter can be used to control stream latency in the Windows DirectSound, Linux OSS, and Linux Alsa APIs only. A value of two is usually the smallest allowed. Larger numbers can potentially result in more robust stream performance, though likely at the cost of stream latency. The value set by the user is replaced during execution of the <a class="el" href="classRtAudio.html#afacc99740fa4c5606fb35467cdea6da8" title="A public function for opening a stream with the specified parameters.">RtAudio::openStream()</a> function by the value actually used by the system.</p> | |||
| <p>The <code>numberOfBuffers</code> parameter can be used to control stream latency in the Windows DirectSound, Linux OSS, and Linux Alsa APIs only. A value of two is usually the smallest allowed. Larger numbers can potentially result in more robust stream performance, though likely at the cost of stream latency. The value set by the user is replaced during execution of the <a class="el" href="classRtAudio.html#a6907539d2527775df778ebce32ef1e3b" title="A public function for opening a stream with the specified parameters.">RtAudio::openStream()</a> function by the value actually used by the system.</p> | |||
| <p>The <code>streamName</code> parameter can be used to set the client name when using the Jack API. By default, the client name is set to RtApiJack. However, if you wish to create multiple instances of <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> with Jack, each instance must have a unique client name. </p> | |||
| <hr/><h2>Member Data Documentation</h2> | |||
| <a class="anchor" id="a0ecc98b031aa3af49d09b781643e298b"></a><!-- doxytag: member="RtAudio::StreamOptions::flags" ref="a0ecc98b031aa3af49d09b781643e298b" args="" --> | |||
| </div><h2 class="groupheader">Member Data Documentation</h2> | |||
| <a class="anchor" id="a0ecc98b031aa3af49d09b781643e298b"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname"><a class="el" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41">RtAudioStreamFlags</a> <a class="el" href="structRtAudio_1_1StreamOptions.html#a0ecc98b031aa3af49d09b781643e298b">RtAudio::StreamOptions::flags</a></td> | |||
| <td class="memname"><a class="el" href="RtAudio_8h.html#a2c0f59b200dcec4d4e760f9166b29c41">RtAudioStreamFlags</a> RtAudio::StreamOptions::flags</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>A bit-mask of stream flags (RTAUDIO_NONINTERLEAVED, RTAUDIO_MINIMIZE_LATENCY, RTAUDIO_HOG_DEVICE, RTAUDIO_ALSA_USE_DEFAULT). </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a75a14cfab903d0e1c091bc16aec80240"></a><!-- doxytag: member="RtAudio::StreamOptions::numberOfBuffers" ref="a75a14cfab903d0e1c091bc16aec80240" args="" --> | |||
| <a class="anchor" id="a75a14cfab903d0e1c091bc16aec80240"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">unsigned int <a class="el" href="structRtAudio_1_1StreamOptions.html#a75a14cfab903d0e1c091bc16aec80240">RtAudio::StreamOptions::numberOfBuffers</a></td> | |||
| <td class="memname">unsigned int RtAudio::StreamOptions::numberOfBuffers</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>Number of stream buffers. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a2a4b0b8d690c624d20f4e8f4be6ca9ba"></a><!-- doxytag: member="RtAudio::StreamOptions::streamName" ref="a2a4b0b8d690c624d20f4e8f4be6ca9ba" args="" --> | |||
| <a class="anchor" id="a2a4b0b8d690c624d20f4e8f4be6ca9ba"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">std::string <a class="el" href="structRtAudio_1_1StreamOptions.html#a2a4b0b8d690c624d20f4e8f4be6ca9ba">RtAudio::StreamOptions::streamName</a></td> | |||
| <td class="memname">std::string RtAudio::StreamOptions::streamName</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>A stream name (currently used only in Jack). </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="adfd267059434edb21573c584e6367def"></a><!-- doxytag: member="RtAudio::StreamOptions::priority" ref="adfd267059434edb21573c584e6367def" args="" --> | |||
| <a class="anchor" id="adfd267059434edb21573c584e6367def"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">int <a class="el" href="structRtAudio_1_1StreamOptions.html#adfd267059434edb21573c584e6367def">RtAudio::StreamOptions::priority</a></td> | |||
| <td class="memname">int RtAudio::StreamOptions::priority</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>Scheduling priority of callback thread (only used with flag RTAUDIO_SCHEDULE_REALTIME). </p> | |||
| </div> | |||
| @@ -103,12 +112,10 @@ | |||
| <hr/>The documentation for this struct was generated from the following file:<ul> | |||
| <li><a class="el" href="RtAudio_8h_source.html">RtAudio.h</a></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> | |||
+ 18
- 9
doc/html/structRtAudio_1_1StreamParameters-members.html
View File
| @@ -8,18 +8,27 @@ | |||
| <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 id="nav-path" class="navpath"> | |||
| <ul> | |||
| <li class="navelem"><a class="el" href="classRtAudio.html">RtAudio</a></li><li class="navelem"><a class="el" href="structRtAudio_1_1StreamParameters.html">StreamParameters</a></li> </ul> | |||
| </div> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="headertitle"> | |||
| <div class="title">RtAudio::StreamParameters Member List</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>RtAudio::StreamParameters Member List</h1>This is the complete list of members for <a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a>, including all inherited members.<table> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a></td><td><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">firstChannel</a></td><td><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a></td><td></td></tr> | |||
| <tr class="memlist"><td><a class="el" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a></td><td><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a></td><td></td></tr> | |||
| </table></div> | |||
| <HR> | |||
| <p>This is the complete list of members for <a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a>, including all inherited members.</p> | |||
| <table class="directory"> | |||
| <tr class="even"><td class="entry"><a class="el" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a></td><td class="entry"><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a></td><td class="entry"></td></tr> | |||
| <tr><td class="entry"><a class="el" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">firstChannel</a></td><td class="entry"><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</a></td><td class="entry"></td></tr> | |||
| <tr class="even"><td class="entry"><a class="el" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a></td><td class="entry"><a class="el" href="structRtAudio_1_1StreamParameters.html">RtAudio::StreamParameters</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> | |||
+ 38
- 31
doc/html/structRtAudio_1_1StreamParameters.html
View File
| @@ -8,64 +8,73 @@ | |||
| <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 --> | |||
| <div class="navpath"><a class="el" href="classRtAudio.html">RtAudio</a>::<a class="el" href="structRtAudio_1_1StreamParameters.html">StreamParameters</a> | |||
| </div> | |||
| <!-- Generated by Doxygen 1.8.2 --> | |||
| <div id="nav-path" class="navpath"> | |||
| <ul> | |||
| <li class="navelem"><a class="el" href="classRtAudio.html">RtAudio</a></li><li class="navelem"><a class="el" href="structRtAudio_1_1StreamParameters.html">StreamParameters</a></li> </ul> | |||
| </div> | |||
| </div><!-- top --> | |||
| <div class="header"> | |||
| <div class="summary"> | |||
| <a href="#pub-attribs">Public Attributes</a> | | |||
| <a href="structRtAudio_1_1StreamParameters-members.html">List of all members</a> </div> | |||
| <div class="headertitle"> | |||
| <div class="title">RtAudio::StreamParameters Struct Reference</div> </div> | |||
| </div><!--header--> | |||
| <div class="contents"> | |||
| <h1>RtAudio::StreamParameters Struct Reference</h1><!-- doxytag: class="RtAudio::StreamParameters" --> | |||
| <p>The structure for specifying input or ouput stream parameters. | |||
| <a href="#_details">More...</a></p> | |||
| <a href="structRtAudio_1_1StreamParameters.html#details">More...</a></p> | |||
| <p><code>#include <<a class="el" href="RtAudio_8h_source.html">RtAudio.h</a>></code></p> | |||
| <p><a href="structRtAudio_1_1StreamParameters-members.html">List of all members.</a></p> | |||
| <table border="0" cellpadding="0" cellspacing="0"> | |||
| <tr><td colspan="2"><h2>Public Attributes</h2></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a></td></tr> | |||
| <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">firstChannel</a></td></tr> | |||
| <table class="memberdecls"> | |||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> | |||
| Public Attributes</h2></td></tr> | |||
| <tr class="memitem:ab3c72bcf3ef12149ae9a4fb597cc5489"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">deviceId</a></td></tr> | |||
| <tr class="separator:ab3c72bcf3ef12149ae9a4fb597cc5489"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:a88a10091b6e284e21235cc6f25332ebd"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">nChannels</a></td></tr> | |||
| <tr class="separator:a88a10091b6e284e21235cc6f25332ebd"><td class="memSeparator" colspan="2"> </td></tr> | |||
| <tr class="memitem:ad4b4503782653ec93c83328c46abe50c"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">firstChannel</a></td></tr> | |||
| <tr class="separator:ad4b4503782653ec93c83328c46abe50c"><td class="memSeparator" colspan="2"> </td></tr> | |||
| </table> | |||
| <hr/><a name="_details"></a><h2>Detailed Description</h2> | |||
| <p>The structure for specifying input or ouput stream parameters. </p> | |||
| <hr/><h2>Member Data Documentation</h2> | |||
| <a class="anchor" id="ab3c72bcf3ef12149ae9a4fb597cc5489"></a><!-- doxytag: member="RtAudio::StreamParameters::deviceId" ref="ab3c72bcf3ef12149ae9a4fb597cc5489" args="" --> | |||
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> | |||
| <div class="textblock"><p>The structure for specifying input or ouput stream parameters. </p> | |||
| </div><h2 class="groupheader">Member Data Documentation</h2> | |||
| <a class="anchor" id="ab3c72bcf3ef12149ae9a4fb597cc5489"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">unsigned int <a class="el" href="structRtAudio_1_1StreamParameters.html#ab3c72bcf3ef12149ae9a4fb597cc5489">RtAudio::StreamParameters::deviceId</a></td> | |||
| <td class="memname">unsigned int RtAudio::StreamParameters::deviceId</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>Device index (0 to <a class="el" href="classRtAudio.html#a747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount()</a> - 1). </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="a88a10091b6e284e21235cc6f25332ebd"></a><!-- doxytag: member="RtAudio::StreamParameters::nChannels" ref="a88a10091b6e284e21235cc6f25332ebd" args="" --> | |||
| <a class="anchor" id="a88a10091b6e284e21235cc6f25332ebd"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">unsigned int <a class="el" href="structRtAudio_1_1StreamParameters.html#a88a10091b6e284e21235cc6f25332ebd">RtAudio::StreamParameters::nChannels</a></td> | |||
| <td class="memname">unsigned int RtAudio::StreamParameters::nChannels</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>Number of channels. </p> | |||
| </div> | |||
| </div> | |||
| <a class="anchor" id="ad4b4503782653ec93c83328c46abe50c"></a><!-- doxytag: member="RtAudio::StreamParameters::firstChannel" ref="ad4b4503782653ec93c83328c46abe50c" args="" --> | |||
| <a class="anchor" id="ad4b4503782653ec93c83328c46abe50c"></a> | |||
| <div class="memitem"> | |||
| <div class="memproto"> | |||
| <table class="memname"> | |||
| <tr> | |||
| <td class="memname">unsigned int <a class="el" href="structRtAudio_1_1StreamParameters.html#ad4b4503782653ec93c83328c46abe50c">RtAudio::StreamParameters::firstChannel</a></td> | |||
| <td class="memname">unsigned int RtAudio::StreamParameters::firstChannel</td> | |||
| </tr> | |||
| </table> | |||
| </div> | |||
| <div class="memdoc"> | |||
| </div><div class="memdoc"> | |||
| <p>First channel index on device (default = 0). </p> | |||
| </div> | |||
| @@ -73,12 +82,10 @@ | |||
| <hr/>The documentation for this struct was generated from the following file:<ul> | |||
| <li><a class="el" href="RtAudio_8h_source.html">RtAudio.h</a></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> | |||
+ 44
- 89
doc/html/tabs.css
View File
| @@ -1,105 +1,60 @@ | |||
| /* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ | |||
| DIV.tabs | |||
| { | |||
| float : left; | |||
| width : 100%; | |||
| background : url("tab_b.gif") repeat-x bottom; | |||
| margin-bottom : 4px; | |||
| } | |||
| DIV.tabs UL | |||
| { | |||
| margin : 0px; | |||
| padding-left : 10px; | |||
| list-style : none; | |||
| } | |||
| DIV.tabs LI, DIV.tabs FORM | |||
| { | |||
| display : inline; | |||
| margin : 0px; | |||
| padding : 0px; | |||
| } | |||
| DIV.tabs FORM | |||
| { | |||
| float : right; | |||
| .tabs, .tabs2, .tabs3 { | |||
| background-image: url('tab_b.png'); | |||
| width: 100%; | |||
| z-index: 101; | |||
| font-size: 13px; | |||
| font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; | |||
| } | |||
| DIV.tabs A | |||
| { | |||
| float : left; | |||
| background : url("tab_r.gif") no-repeat right top; | |||
| border-bottom : 1px solid #84B0C7; | |||
| font-size : 80%; | |||
| font-weight : bold; | |||
| text-decoration : none; | |||
| .tabs2 { | |||
| font-size: 10px; | |||
| } | |||
| DIV.tabs A:hover | |||
| { | |||
| background-position: 100% -150px; | |||
| .tabs3 { | |||
| font-size: 9px; | |||
| } | |||
| DIV.tabs A:link, DIV.tabs A:visited, | |||
| DIV.tabs A:active, DIV.tabs A:hover | |||
| { | |||
| color: #1A419D; | |||
| .tablist { | |||
| margin: 0; | |||
| padding: 0; | |||
| display: table; | |||
| } | |||
| DIV.tabs SPAN | |||
| { | |||
| float : left; | |||
| display : block; | |||
| background : url("tab_l.gif") no-repeat left top; | |||
| padding : 5px 9px; | |||
| white-space : nowrap; | |||
| .tablist li { | |||
| float: left; | |||
| display: table-cell; | |||
| background-image: url('tab_b.png'); | |||
| line-height: 36px; | |||
| list-style: none; | |||
| } | |||
| DIV.tabs #MSearchBox | |||
| { | |||
| float : right; | |||
| display : inline; | |||
| font-size : 1em; | |||
| } | |||
| DIV.tabs TD | |||
| { | |||
| font-size : 80%; | |||
| font-weight : bold; | |||
| text-decoration : none; | |||
| } | |||
| /* Commented Backslash Hack hides rule from IE5-Mac \*/ | |||
| DIV.tabs SPAN {float : none;} | |||
| /* End IE5-Mac hack */ | |||
| DIV.tabs A:hover SPAN | |||
| { | |||
| background-position: 0% -150px; | |||
| .tablist a { | |||
| display: block; | |||
| padding: 0 20px; | |||
| font-weight: bold; | |||
| background-image:url('tab_s.png'); | |||
| background-repeat:no-repeat; | |||
| background-position:right; | |||
| color: #283A5D; | |||
| text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); | |||
| text-decoration: none; | |||
| outline: none; | |||
| } | |||
| DIV.tabs LI.current A | |||
| { | |||
| background-position: 100% -150px; | |||
| border-width : 0px; | |||
| .tabs3 .tablist a { | |||
| padding: 0 10px; | |||
| } | |||
| DIV.tabs LI.current SPAN | |||
| { | |||
| background-position: 0% -150px; | |||
| padding-bottom : 6px; | |||
| .tablist a:hover { | |||
| background-image: url('tab_h.png'); | |||
| background-repeat:repeat-x; | |||
| color: #fff; | |||
| text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); | |||
| text-decoration: none; | |||
| } | |||
| DIV.navpath | |||
| { | |||
| background : none; | |||
| border : none; | |||
| border-bottom : 1px solid #84B0C7; | |||
| text-align : center; | |||
| margin : 2px; | |||
| padding : 2px; | |||
| .tablist li.current a { | |||
| background-image: url('tab_a.png'); | |||
| background-repeat:repeat-x; | |||
| color: #fff; | |||
| text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); | |||
| } | |||