Release 3.0 tarball3.0

1 files changed, 100 insertions, 38 deletions

diff --git a/doc/html/classRtError.html b/doc/html/classRtError.html
index b81582a..7301c2c 100644
--- a/doc/html/classRtError.html
+++ b/doc/html/classRtError.html
@@ -7,60 +7,122 @@
 <CENTER>
 <a class="qindex" href="index.html">Tutorial</a> &nbsp; <a class="qindex" href="annotated.html">Class/Enum List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </CENTER>
 <HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>RtError  Class Reference</h1>Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a>. 
+<!-- Generated by Doxygen 1.3.4 -->
+<h1>RtError Class Reference</h1>Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> &amp; RtMidi.  
 <a href="#_details">More...</a>
 <p>
-<code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>&gt;</code>
+<code>#include &lt;<a class="el" href="RtError_8h-source.html">RtError.h</a>&gt;</code>
 <p>
 <a href="classRtError-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
+<tr><td></td></tr>
 <tr><td colspan=2><br><h2>Public Types</h2></td></tr>
-<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#s11">TYPE</a> { <br>
-&nbsp;&nbsp;<b>WARNING</b>, 
-<b>DEBUG_WARNING</b>, 
-<b>UNSPECIFIED</b>, 
-<b>NO_DEVICES_FOUND</b>, 
+<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#w11">Type</a> { <br>
+&nbsp;&nbsp;<a class="el" href="classRtError.html#w11w0">WARNING</a>, 
+<a class="el" href="classRtError.html#w11w1">DEBUG_WARNING</a>, 
+<a class="el" href="classRtError.html#w11w2">UNSPECIFIED</a>, 
+<a class="el" href="classRtError.html#w11w3">NO_DEVICES_FOUND</a>, 
 <br>
-&nbsp;&nbsp;<b>INVALID_DEVICE</b>, 
-<b>INVALID_STREAM</b>, 
-<b>MEMORY_ERROR</b>, 
-<b>INVALID_PARAMETER</b>, 
+&nbsp;&nbsp;<a class="el" href="classRtError.html#w11w4">INVALID_DEVICE</a>, 
+<a class="el" href="classRtError.html#w11w5">INVALID_STREAM</a>, 
+<a class="el" href="classRtError.html#w11w6">MEMORY_ERROR</a>, 
+<a class="el" href="classRtError.html#w11w7">INVALID_PARAMETER</a>, 
 <br>
-&nbsp;&nbsp;<b>DRIVER_ERROR</b>, 
-<b>SYSTEM_ERROR</b>, 
-<b>THREAD_ERROR</b>
+&nbsp;&nbsp;<a class="el" href="classRtError.html#w11w8">DRIVER_ERROR</a>, 
+<a class="el" href="classRtError.html#w11w9">SYSTEM_ERROR</a>, 
+<a class="el" href="classRtError.html#w11w10">THREAD_ERROR</a>
 <br>
  }</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Defined RtError types.</em></font><br><br></td></tr>
-<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
-<tr><td nowrap align=right valign=top><a name="a0" doxytag="RtError::RtError"></a>
-&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a0">RtError</a> (const char *p, <a class="el" href="classRtError.html#s11">TYPE</a> tipe=RtError::UNSPECIFIED)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>The constructor.</em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top><a name="a1" doxytag="RtError::~RtError"></a>
-virtual&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>The destructor.</em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top><a name="a2" doxytag="RtError::printMessage"></a>
-virtual void&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Prints "thrown" error message to stdout.</em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top><a name="a3" doxytag="RtError::getType"></a>
-virtual const <a class="el" href="classRtError.html#s11">TYPE</a>&amp;&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a3">getType</a> (void)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Returns the "thrown" error message TYPE.</em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top><a name="a4" doxytag="RtError::getMessage"></a>
-virtual const char*&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Returns the "thrown" error message string.</em></font><br><br></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Defined RtError types. </em> <a href="#w11">More...</a><em><br><br></td></tr>
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a0" doxytag="RtError::RtError" ></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a0">RtError</a> (const  std::string &amp;message, <a class="el" href="classRtError.html#w11">Type</a> type=RtError::UNSPECIFIED)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The constructor. <br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="RtError::~RtError" ></a>
+virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The destructor. <br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="RtError::printMessage" ></a>
+virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prints thrown error message to stderr. <br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="RtError::getType" ></a>
+virtual const  <a class="el" href="classRtError.html#w11">Type</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a3">getType</a> (void)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the thrown error message type. <br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="RtError::getMessage" ></a>
+virtual const  std::string &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the thrown error message string. <br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="RtError::getMessageString" ></a>
+virtual const  char *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a5">getMessageString</a> (void)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the thrown error message as a C string. <br><br></td></tr>
 </table>
 <hr><a name="_details"></a><h2>Detailed Description</h2>
-Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a>.
+Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> &amp; RtMidi. 
 <p>
-The RtError class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#s11">RtError::TYPE</a>. Almost all <a class="el" href="classRtAudio.html">RtAudio</a> methods can "throw" an RtError, most typically if an invalid stream identifier is supplied to a method or a driver error occurs. There are a number of cases within <a class="el" href="classRtAudio.html">RtAudio</a> where warning messages may be displayed but an exception is not thrown. There is a private <a class="el" href="classRtAudio.html">RtAudio</a> method, error(), which can be modified to globally control how these messages are handled and reported. 
+The RtError class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#w11">RtError::Type</a>. See the <a class="el" href="classRtAudio.html">RtAudio</a> and RtMidi documentation to know which methods can throw an RtError. 
 <p>
+<hr><h2>Member Enumeration Documentation</h2>
+<a class="anchor" name="w11" doxytag="RtError::Type" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> enum <a class="el" href="classRtError.html#w11">RtError::Type</a>
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+Defined RtError types. 
+<p>
+<dl compact><dt><b>Enumeration values: </b></dt><dd>
+<table border=0 cellspacing=2 cellpadding=0>
+<tr><td valign=top><em><a class="anchor" name="w11w0" doxytag="WARNING" ></a>WARNING</em>&nbsp;</td><td>
+A non-critical error. </td></tr>
+<tr><td valign=top><em><a class="anchor" name="w11w1" doxytag="DEBUG_WARNING" ></a>DEBUG_WARNING</em>&nbsp;</td><td>
+A non-critical error which might be useful for debugging. </td></tr>
+<tr><td valign=top><em><a class="anchor" name="w11w2" doxytag="UNSPECIFIED" ></a>UNSPECIFIED</em>&nbsp;</td><td>
+The default, unspecified error type. </td></tr>
+<tr><td valign=top><em><a class="anchor" name="w11w3" doxytag="NO_DEVICES_FOUND" ></a>NO_DEVICES_FOUND</em>&nbsp;</td><td>
+No devices found on system. </td></tr>
+<tr><td valign=top><em><a class="anchor" name="w11w4" doxytag="INVALID_DEVICE" ></a>INVALID_DEVICE</em>&nbsp;</td><td>
+An invalid device ID was specified. </td></tr>
+<tr><td valign=top><em><a class="anchor" name="w11w5" doxytag="INVALID_STREAM" ></a>INVALID_STREAM</em>&nbsp;</td><td>
+An invalid stream ID was specified. </td></tr>
+<tr><td valign=top><em><a class="anchor" name="w11w6" doxytag="MEMORY_ERROR" ></a>MEMORY_ERROR</em>&nbsp;</td><td>
+An error occured during memory allocation. </td></tr>
+<tr><td valign=top><em><a class="anchor" name="w11w7" doxytag="INVALID_PARAMETER" ></a>INVALID_PARAMETER</em>&nbsp;</td><td>
+An invalid parameter was specified to a function. </td></tr>
+<tr><td valign=top><em><a class="anchor" name="w11w8" doxytag="DRIVER_ERROR" ></a>DRIVER_ERROR</em>&nbsp;</td><td>
+A system driver error occured. </td></tr>
+<tr><td valign=top><em><a class="anchor" name="w11w9" doxytag="SYSTEM_ERROR" ></a>SYSTEM_ERROR</em>&nbsp;</td><td>
+A system error occured. </td></tr>
+<tr><td valign=top><em><a class="anchor" name="w11w10" doxytag="THREAD_ERROR" ></a>THREAD_ERROR</em>&nbsp;</td><td>
+A thread error occured. </td></tr>
+</table>
+</dl>
+    </td>
+  </tr>
+</table>
 <hr>The documentation for this class was generated from the following file:<ul>
-<li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>
+<li><a class="el" href="RtError_8h-source.html">RtError.h</a></ul>
 <HR>
 
-<table><tr><td><img src="../images/ccrma.gif">
-  <td>&copy;2001-2002 Gary P. Scavone, CCRMA, Stanford University. All Rights Reserved.<br>
-  Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
+<table><tr><td><img src="../images/mcgill.gif" width=165></td>
+  <td>&copy;2001-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br>
+  Maintained by Gary P. Scavone, <a href="mailto:gary@music.mcgill.ca">gary@music.mcgill.ca</a></td></tr>
 </table>
 
 </BODY>