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.
10 Commits
5 Branches
2.4MB
Tree: 1a463dd3e6
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1a463dd3e6'
${ noResults }
rtaudio/doc/html/classRtError.html

68 lines
4.2KB
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.2.8.1 -->

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

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

  13. <p>

  14. <code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.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 colspan=2><br><h2>Public Types</h2></td></tr>

  18. <tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#s11">TYPE</a> { <br>

  19. &nbsp;&nbsp;<b>WARNING</b>, 

  20. <b>DEBUG_WARNING</b>, 

  21. <b>UNSPECIFIED</b>, 

  22. <b>NO_DEVICES_FOUND</b>, 

  23. <br>

  24. &nbsp;&nbsp;<b>INVALID_DEVICE</b>, 

  25. <b>INVALID_STREAM</b>, 

  26. <b>MEMORY_ERROR</b>, 

  27. <b>INVALID_PARAMETER</b>, 

  28. <br>

  29. &nbsp;&nbsp;<b>DRIVER_ERROR</b>, 

  30. <b>SYSTEM_ERROR</b>, 

  31. <b>THREAD_ERROR</b>

  32. <br>

  33.  }</td></tr>

  34. <tr><td>&nbsp;</td><td><font size=-1><em>Defined RtError types.</em></font><br><br></td></tr>

  35. <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>

  36. <tr><td nowrap align=right valign=top><a name="a0" doxytag="RtError::RtError"></a>

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

  38. <tr><td>&nbsp;</td><td><font size=-1><em>The constructor.</em></font><br><br></td></tr>

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

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

  41. <tr><td>&nbsp;</td><td><font size=-1><em>The destructor.</em></font><br><br></td></tr>

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

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

  44. <tr><td>&nbsp;</td><td><font size=-1><em>Prints "thrown" error message to stdout.</em></font><br><br></td></tr>

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

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

  47. <tr><td>&nbsp;</td><td><font size=-1><em>Returns the "thrown" error message TYPE.</em></font><br><br></td></tr>

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

  49. virtual const char*&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr>

  50. <tr><td>&nbsp;</td><td><font size=-1><em>Returns the "thrown" error message string.</em></font><br><br></td></tr>

  51. </table>

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

  53. Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a>.

  54. <p>

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

  56. <p>

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

  58. <li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>

  59. <HR>

  60. 

  61. <table><tr><td><img src="../images/ccrma.gif">

  62.   <td>&copy;2001-2002 Gary P. Scavone, CCRMA, Stanford University. All Rights Reserved.<br>

  63.   Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>

  64. </table>

  65. 

  66. </BODY>

  67. </HTML>