1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
<HTML>
<HEAD>
<TITLE>The RtAudio Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<a class="qindex" href="index.html">Tutorial</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.2.8.1 -->
<h1>RtError Class Reference</h1>Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>></code>
<p>
<a href="classRtError-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classRtError.html#s11">TYPE</a> { <br>
<b>WARNING</b>,
<b>DEBUG_WARNING</b>,
<b>UNSPECIFIED</b>,
<b>NO_DEVICES_FOUND</b>,
<br>
<b>INVALID_DEVICE</b>,
<b>INVALID_STREAM</b>,
<b>MEMORY_ERROR</b>,
<b>INVALID_PARAMETER</b>,
<br>
<b>DRIVER_ERROR</b>,
<b>SYSTEM_ERROR</b>,
<b>THREAD_ERROR</b>
<br>
}</td></tr>
<tr><td> </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>
</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> </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 </td><td valign=bottom><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr>
<tr><td> </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 </td><td valign=bottom><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr>
<tr><td> </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>& </td><td valign=bottom><a class="el" href="classRtError.html#a3">getType</a> (void)</td></tr>
<tr><td> </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* </td><td valign=bottom><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the "thrown" error message string.</em></font><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>.
<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.
<p>
<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>
<HR>
<table><tr><td><img src="../images/ccrma.gif">
<td>©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>
</BODY>
</HTML>
|
