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.

338 lines
10KB

  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>RtAudioError Class Reference</h1><code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>&gt;</code>
  12. <p>
  13. <a href="classRtAudioError-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  14. <tr><td colspan=2><br><h2>Public Types</h2></td></tr>
  15. <tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#s11">TYPE</a> { <br>
  16. &nbsp;&nbsp;<a class="el" href="classRtAudioError.html#s11s0">WARNING</a>,
  17. <a class="el" href="classRtAudioError.html#s11s1">DEBUG_WARNING</a>,
  18. <a class="el" href="classRtAudioError.html#s11s2">UNSPECIFIED</a>,
  19. <a class="el" href="classRtAudioError.html#s11s3">NO_DEVICES_FOUND</a>,
  20. <br>
  21. &nbsp;&nbsp;<a class="el" href="classRtAudioError.html#s11s4">INVALID_DEVICE</a>,
  22. <a class="el" href="classRtAudioError.html#s11s5">INVALID_STREAM</a>,
  23. <a class="el" href="classRtAudioError.html#s11s6">MEMORY_ERROR</a>,
  24. <a class="el" href="classRtAudioError.html#s11s7">INVALID_PARAMETER</a>,
  25. <br>
  26. &nbsp;&nbsp;<a class="el" href="classRtAudioError.html#s11s8">DRIVER_ERROR</a>,
  27. <a class="el" href="classRtAudioError.html#s11s9">SYSTEM_ERROR</a>,
  28. <a class="el" href="classRtAudioError.html#s11s10">THREAD_ERROR</a>
  29. <br>
  30. }</td></tr>
  31. <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
  32. <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#a0">RtAudioError</a> (const char *p, <a class="el" href="classRtAudioError.html#s11">TYPE</a> tipe=RtAudioError::UNSPECIFIED)</td></tr>
  33. <tr><td>&nbsp;</td><td><font size=-1><em>The constructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
  34. <tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#a1">~RtAudioError</a> (void)</td></tr>
  35. <tr><td>&nbsp;</td><td><font size=-1><em>The destructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
  36. <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#a2">printMessage</a> (void)</td></tr>
  37. <tr><td>&nbsp;</td><td><font size=-1><em>Prints "thrown" error message to stdout.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
  38. <tr><td nowrap align=right valign=top>virtual const <a class="el" href="classRtAudioError.html#s11">TYPE</a>&amp;&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#a3">getType</a> (void)</td></tr>
  39. <tr><td>&nbsp;</td><td><font size=-1><em>Returns the "thrown" error message TYPE.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
  40. <tr><td nowrap align=right valign=top>virtual const char*&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#a4">getMessage</a> (void)</td></tr>
  41. <tr><td>&nbsp;</td><td><font size=-1><em>Returns the "thrown" error message string.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
  42. <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
  43. <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#n0">error_message</a> [256]</td></tr>
  44. <tr><td nowrap align=right valign=top><a class="el" href="classRtAudioError.html#s11">TYPE</a>&nbsp;</td><td valign=bottom><a class="el" href="classRtAudioError.html#n1">type</a></td></tr>
  45. </table>
  46. <hr><h2>Member Enumeration Documentation</h2>
  47. <a name="s11" doxytag="RtAudioError::TYPE"></a><p>
  48. <table width="100%" cellpadding="2" cellspacing="0" border="0">
  49. <tr>
  50. <td class="md">
  51. <table cellpadding="0" cellspacing="0" border="0">
  52. <tr>
  53. <td nowrap valign="top"><b>
  54. enum RtAudioError::TYPE
  55. </b></td>
  56. </tr>
  57. </table>
  58. </td>
  59. </tr>
  60. </table>
  61. <table cellspacing=5 cellpadding=0 border=0>
  62. <tr>
  63. <td>
  64. &nbsp;
  65. </td>
  66. <td>
  67. <p>
  68. <dl compact><dt>
  69. <b>Enumeration values:</b><dd>
  70. <table border=0 cellspacing=2 cellpadding=0>
  71. <tr><td valign=top><a name="s11s0" doxytag="WARNING"></a><em>WARNING</em>
  72. &nbsp;</td><td>
  73. </td></tr>
  74. <tr><td valign=top><a name="s11s1" doxytag="DEBUG_WARNING"></a><em>DEBUG_WARNING</em>
  75. &nbsp;</td><td>
  76. </td></tr>
  77. <tr><td valign=top><a name="s11s2" doxytag="UNSPECIFIED"></a><em>UNSPECIFIED</em>
  78. &nbsp;</td><td>
  79. </td></tr>
  80. <tr><td valign=top><a name="s11s3" doxytag="NO_DEVICES_FOUND"></a><em>NO_DEVICES_FOUND</em>
  81. &nbsp;</td><td>
  82. </td></tr>
  83. <tr><td valign=top><a name="s11s4" doxytag="INVALID_DEVICE"></a><em>INVALID_DEVICE</em>
  84. &nbsp;</td><td>
  85. </td></tr>
  86. <tr><td valign=top><a name="s11s5" doxytag="INVALID_STREAM"></a><em>INVALID_STREAM</em>
  87. &nbsp;</td><td>
  88. </td></tr>
  89. <tr><td valign=top><a name="s11s6" doxytag="MEMORY_ERROR"></a><em>MEMORY_ERROR</em>
  90. &nbsp;</td><td>
  91. </td></tr>
  92. <tr><td valign=top><a name="s11s7" doxytag="INVALID_PARAMETER"></a><em>INVALID_PARAMETER</em>
  93. &nbsp;</td><td>
  94. </td></tr>
  95. <tr><td valign=top><a name="s11s8" doxytag="DRIVER_ERROR"></a><em>DRIVER_ERROR</em>
  96. &nbsp;</td><td>
  97. </td></tr>
  98. <tr><td valign=top><a name="s11s9" doxytag="SYSTEM_ERROR"></a><em>SYSTEM_ERROR</em>
  99. &nbsp;</td><td>
  100. </td></tr>
  101. <tr><td valign=top><a name="s11s10" doxytag="THREAD_ERROR"></a><em>THREAD_ERROR</em>
  102. &nbsp;</td><td>
  103. </td></tr>
  104. </table>
  105. </dl>
  106. </td>
  107. </tr>
  108. </table>
  109. <hr><h2>Constructor &amp; Destructor Documentation</h2>
  110. <a name="a0" doxytag="RtAudioError::RtAudioError"></a><p>
  111. <table width="100%" cellpadding="2" cellspacing="0" border="0">
  112. <tr>
  113. <td class="md">
  114. <table cellpadding="0" cellspacing="0" border="0">
  115. <tr>
  116. <td nowrap valign="top"><b>
  117. RtAudioError::RtAudioError (
  118. </b></td>
  119. <td valign="bottom"><b>
  120. const char * <em>p</em>,
  121. </b></td>
  122. </tr>
  123. <tr>
  124. <td></td>
  125. <td><b>
  126. <a class="el" href="classRtAudioError.html#s11">TYPE</a> <em>tipe</em> = RtAudioError::UNSPECIFIED&nbsp;)
  127. </b></td>
  128. </tr>
  129. </table>
  130. </td>
  131. </tr>
  132. </table>
  133. <table cellspacing=5 cellpadding=0 border=0>
  134. <tr>
  135. <td>
  136. &nbsp;
  137. </td>
  138. <td>
  139. <p>
  140. The constructor.
  141. <p>
  142. </td>
  143. </tr>
  144. </table>
  145. <a name="a1" doxytag="RtAudioError::~RtAudioError"></a><p>
  146. <table width="100%" cellpadding="2" cellspacing="0" border="0">
  147. <tr>
  148. <td class="md">
  149. <table cellpadding="0" cellspacing="0" border="0">
  150. <tr>
  151. <td nowrap valign="top"><b>
  152. RtAudioError::~RtAudioError (
  153. </b></td>
  154. <td valign="bottom"><b>
  155. void&nbsp;)<code> [virtual]</code>
  156. </b></td>
  157. </tr>
  158. </table>
  159. </td>
  160. </tr>
  161. </table>
  162. <table cellspacing=5 cellpadding=0 border=0>
  163. <tr>
  164. <td>
  165. &nbsp;
  166. </td>
  167. <td>
  168. <p>
  169. The destructor.
  170. <p>
  171. </td>
  172. </tr>
  173. </table>
  174. <hr><h2>Member Function Documentation</h2>
  175. <a name="a2" doxytag="RtAudioError::printMessage"></a><p>
  176. <table width="100%" cellpadding="2" cellspacing="0" border="0">
  177. <tr>
  178. <td class="md">
  179. <table cellpadding="0" cellspacing="0" border="0">
  180. <tr>
  181. <td nowrap valign="top"><b>
  182. void RtAudioError::printMessage (
  183. </b></td>
  184. <td valign="bottom"><b>
  185. void&nbsp;)<code> [virtual]</code>
  186. </b></td>
  187. </tr>
  188. </table>
  189. </td>
  190. </tr>
  191. </table>
  192. <table cellspacing=5 cellpadding=0 border=0>
  193. <tr>
  194. <td>
  195. &nbsp;
  196. </td>
  197. <td>
  198. <p>
  199. Prints "thrown" error message to stdout.
  200. <p>
  201. </td>
  202. </tr>
  203. </table>
  204. <a name="a3" doxytag="RtAudioError::getType"></a><p>
  205. <table width="100%" cellpadding="2" cellspacing="0" border="0">
  206. <tr>
  207. <td class="md">
  208. <table cellpadding="0" cellspacing="0" border="0">
  209. <tr>
  210. <td nowrap valign="top"><b>
  211. const <a class="el" href="classRtAudioError.html#s11">TYPE</a> &amp; RtAudioError::getType (
  212. </b></td>
  213. <td valign="bottom"><b>
  214. void&nbsp;)<code> [inline, virtual]</code>
  215. </b></td>
  216. </tr>
  217. </table>
  218. </td>
  219. </tr>
  220. </table>
  221. <table cellspacing=5 cellpadding=0 border=0>
  222. <tr>
  223. <td>
  224. &nbsp;
  225. </td>
  226. <td>
  227. <p>
  228. Returns the "thrown" error message TYPE.
  229. <p>
  230. </td>
  231. </tr>
  232. </table>
  233. <a name="a4" doxytag="RtAudioError::getMessage"></a><p>
  234. <table width="100%" cellpadding="2" cellspacing="0" border="0">
  235. <tr>
  236. <td class="md">
  237. <table cellpadding="0" cellspacing="0" border="0">
  238. <tr>
  239. <td nowrap valign="top"><b>
  240. const char * RtAudioError::getMessage (
  241. </b></td>
  242. <td valign="bottom"><b>
  243. void&nbsp;)<code> [inline, virtual]</code>
  244. </b></td>
  245. </tr>
  246. </table>
  247. </td>
  248. </tr>
  249. </table>
  250. <table cellspacing=5 cellpadding=0 border=0>
  251. <tr>
  252. <td>
  253. &nbsp;
  254. </td>
  255. <td>
  256. <p>
  257. Returns the "thrown" error message string.
  258. <p>
  259. </td>
  260. </tr>
  261. </table>
  262. <hr><h2>Member Data Documentation</h2>
  263. <a name="n0" doxytag="RtAudioError::error_message"></a><p>
  264. <table width="100%" cellpadding="2" cellspacing="0" border="0">
  265. <tr>
  266. <td class="md">
  267. <table cellpadding="0" cellspacing="0" border="0">
  268. <tr>
  269. <td nowrap valign="top"><b>
  270. char RtAudioError::error_message<code> [protected]</code>
  271. </b></td>
  272. </tr>
  273. </table>
  274. </td>
  275. </tr>
  276. </table>
  277. <table cellspacing=5 cellpadding=0 border=0>
  278. <tr>
  279. <td>
  280. &nbsp;
  281. </td>
  282. <td>
  283. <p>
  284. </td>
  285. </tr>
  286. </table>
  287. <a name="n1" doxytag="RtAudioError::type"></a><p>
  288. <table width="100%" cellpadding="2" cellspacing="0" border="0">
  289. <tr>
  290. <td class="md">
  291. <table cellpadding="0" cellspacing="0" border="0">
  292. <tr>
  293. <td nowrap valign="top"><b>
  294. <a class="el" href="classRtAudioError.html#s11">TYPE</a> RtAudioError::type<code> [protected]</code>
  295. </b></td>
  296. </tr>
  297. </table>
  298. </td>
  299. </tr>
  300. </table>
  301. <table cellspacing=5 cellpadding=0 border=0>
  302. <tr>
  303. <td>
  304. &nbsp;
  305. </td>
  306. <td>
  307. <p>
  308. </td>
  309. </tr>
  310. </table>
  311. <hr>The documentation for this class was generated from the following file:<ul>
  312. <li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>
  313. <HR>
  314. <table><tr><td><img src="../ccrma.gif">
  315. <td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
  316. Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
  317. </table>
  318. </BODY>
  319. </HTML>