falkTX
/
rtaudio
mirror of https://github.com/falkTX/rtaudio
1
0
Fork 0
Code Releases 27 Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
14 Commits
5 Branches
4.7MB
Tree: 830706e436
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '830706e436'
${ noResults }
rtaudio/doc/html/classRtError.html

130 lines
7.6KB
Raw Blame History 

  1. <HTML>

  2. <HEAD>

  3. <TITLE>The RtAudio Tutorial</TITLE>

  4. <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">

  5. </HEAD>

  6. <BODY BGCOLOR="#FFFFFF">

  7. <CENTER>

  8. <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>

  9. <HR>

  10. <!-- Generated by Doxygen 1.3.4 -->

  11. <h1>RtError Class Reference</h1>Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> &amp; RtMidi.  

  12. <a href="#_details">More...</a>

  13. <p>

  14. <code>#include &lt;<a class="el" href="RtError_8h-source.html">RtError.h</a>&gt;</code>

  15. <p>

  16. <a href="classRtError-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>

  17. <tr><td></td></tr>

  18. <tr><td colspan=2><br><h2>Public Types</h2></td></tr>

  19. <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>

  20. &nbsp;&nbsp;<a class="el" href="classRtError.html#w11w0">WARNING</a>, 

  21. <a class="el" href="classRtError.html#w11w1">DEBUG_WARNING</a>, 

  22. <a class="el" href="classRtError.html#w11w2">UNSPECIFIED</a>, 

  23. <a class="el" href="classRtError.html#w11w3">NO_DEVICES_FOUND</a>, 

  24. <br>

  25. &nbsp;&nbsp;<a class="el" href="classRtError.html#w11w4">INVALID_DEVICE</a>, 

  26. <a class="el" href="classRtError.html#w11w5">INVALID_STREAM</a>, 

  27. <a class="el" href="classRtError.html#w11w6">MEMORY_ERROR</a>, 

  28. <a class="el" href="classRtError.html#w11w7">INVALID_PARAMETER</a>, 

  29. <br>

  30. &nbsp;&nbsp;<a class="el" href="classRtError.html#w11w8">DRIVER_ERROR</a>, 

  31. <a class="el" href="classRtError.html#w11w9">SYSTEM_ERROR</a>, 

  32. <a class="el" href="classRtError.html#w11w10">THREAD_ERROR</a>

  33. <br>

  34.  }</td></tr>

  35. 

  36. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Defined RtError types. </em> <a href="#w11">More...</a><em><br><br></td></tr>

  37. <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>

  38. <tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a0" doxytag="RtError::RtError" ></a>

  39. &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>

  40. 

  41. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The constructor. <br><br></td></tr>

  42. <tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="RtError::~RtError" ></a>

  43. virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr>

  44. 

  45. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The destructor. <br><br></td></tr>

  46. <tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="RtError::printMessage" ></a>

  47. virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr>

  48. 

  49. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prints thrown error message to stderr. <br><br></td></tr>

  50. <tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="RtError::getType" ></a>

  51. 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>

  52. 

  53. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the thrown error message type. <br><br></td></tr>

  54. <tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="RtError::getMessage" ></a>

  55. virtual const  std::string &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr>

  56. 

  57. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the thrown error message string. <br><br></td></tr>

  58. <tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="RtError::getMessageString" ></a>

  59. virtual const  char *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a5">getMessageString</a> (void)</td></tr>

  60. 

  61. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the thrown error message as a C string. <br><br></td></tr>

  62. </table>

  63. <hr><a name="_details"></a><h2>Detailed Description</h2>

  64. Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> &amp; RtMidi. 

  65. <p>

  66. 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. 

  67. <p>

  68. <hr><h2>Member Enumeration Documentation</h2>

  69. <a class="anchor" name="w11" doxytag="RtError::Type" ></a><p>

  70. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">

  71.   <tr>

  72.     <td class="mdRow">

  73.       <table cellpadding="0" cellspacing="0" border="0">

  74.         <tr>

  75.           <td class="md" nowrap valign="top"> enum <a class="el" href="classRtError.html#w11">RtError::Type</a>

  76.       </table>

  77.     </td>

  78.   </tr>

  79. </table>

  80. <table cellspacing=5 cellpadding=0 border=0>

  81.   <tr>

  82.     <td>

  83.       &nbsp;

  84.     </td>

  85.     <td>

  86. 

  87. <p>

  88. Defined RtError types. 

  89. <p>

  90. <dl compact><dt><b>Enumeration values: </b></dt><dd>

  91. <table border=0 cellspacing=2 cellpadding=0>

  92. <tr><td valign=top><em><a class="anchor" name="w11w0" doxytag="WARNING" ></a>WARNING</em>&nbsp;</td><td>

  93. A non-critical error. </td></tr>

  94. <tr><td valign=top><em><a class="anchor" name="w11w1" doxytag="DEBUG_WARNING" ></a>DEBUG_WARNING</em>&nbsp;</td><td>

  95. A non-critical error which might be useful for debugging. </td></tr>

  96. <tr><td valign=top><em><a class="anchor" name="w11w2" doxytag="UNSPECIFIED" ></a>UNSPECIFIED</em>&nbsp;</td><td>

  97. The default, unspecified error type. </td></tr>

  98. <tr><td valign=top><em><a class="anchor" name="w11w3" doxytag="NO_DEVICES_FOUND" ></a>NO_DEVICES_FOUND</em>&nbsp;</td><td>

  99. No devices found on system. </td></tr>

  100. <tr><td valign=top><em><a class="anchor" name="w11w4" doxytag="INVALID_DEVICE" ></a>INVALID_DEVICE</em>&nbsp;</td><td>

  101. An invalid device ID was specified. </td></tr>

  102. <tr><td valign=top><em><a class="anchor" name="w11w5" doxytag="INVALID_STREAM" ></a>INVALID_STREAM</em>&nbsp;</td><td>

  103. An invalid stream ID was specified. </td></tr>

  104. <tr><td valign=top><em><a class="anchor" name="w11w6" doxytag="MEMORY_ERROR" ></a>MEMORY_ERROR</em>&nbsp;</td><td>

  105. An error occured during memory allocation. </td></tr>

  106. <tr><td valign=top><em><a class="anchor" name="w11w7" doxytag="INVALID_PARAMETER" ></a>INVALID_PARAMETER</em>&nbsp;</td><td>

  107. An invalid parameter was specified to a function. </td></tr>

  108. <tr><td valign=top><em><a class="anchor" name="w11w8" doxytag="DRIVER_ERROR" ></a>DRIVER_ERROR</em>&nbsp;</td><td>

  109. A system driver error occured. </td></tr>

  110. <tr><td valign=top><em><a class="anchor" name="w11w9" doxytag="SYSTEM_ERROR" ></a>SYSTEM_ERROR</em>&nbsp;</td><td>

  111. A system error occured. </td></tr>

  112. <tr><td valign=top><em><a class="anchor" name="w11w10" doxytag="THREAD_ERROR" ></a>THREAD_ERROR</em>&nbsp;</td><td>

  113. A thread error occured. </td></tr>

  114. </table>

  115. </dl>

  116.     </td>

  117.   </tr>

  118. </table>

  119. <hr>The documentation for this class was generated from the following file:<ul>

  120. <li><a class="el" href="RtError_8h-source.html">RtError.h</a></ul>

  121. <HR>

  122. 

  123. <table><tr><td><img src="../images/mcgill.gif" width=165></td>

  124.   <td>&copy;2001-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br>

  125.   Maintained by Gary P. Scavone, <a href="mailto:gary@music.mcgill.ca">gary@music.mcgill.ca</a></td></tr>

  126. </table>

  127. 

  128. </BODY>

  129. </HTML>