summaryrefslogtreecommitdiff
path: root/doc/latex/classRtAudioError.tex
blob: 5201ef32a1464302707df9c62216f4ad1ee0cb69 (plain)
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
\section{Rt\-Audio\-Error  Class Reference}
\label{classRtAudioError}\index{RtAudioError@{Rt\-Audio\-Error}}
{\tt \#include $<$Rt\-Audio.h$>$}

\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum {\bf TYPE} \{ {\bf WARNING}, 
{\bf DEBUG\_\-WARNING}, 
{\bf UNSPECIFIED}, 
{\bf NO\_\-DEVICES\_\-FOUND}, 
{\bf INVALID\_\-DEVICE}, 
{\bf INVALID\_\-STREAM}, 
{\bf MEMORY\_\-ERROR}, 
{\bf INVALID\_\-PARAMETER}, 
{\bf DRIVER\_\-ERROR}, 
{\bf SYSTEM\_\-ERROR}, 
{\bf THREAD\_\-ERROR}
 \}
\end{CompactItemize}
\subsection*{Public Methods}
\begin{CompactItemize}
\item 
{\bf Rt\-Audio\-Error} (const char $\ast$p, {\bf TYPE} tipe=Rt\-Audio\-Error::UNSPECIFIED)
\begin{CompactList}\small\item\em The constructor.\item\end{CompactList}\item 
virtual {\bf $\sim$Rt\-Audio\-Error} (void)
\begin{CompactList}\small\item\em The destructor.\item\end{CompactList}\item 
virtual void {\bf print\-Message} (void)
\begin{CompactList}\small\item\em Prints \char`\"{}thrown\char`\"{} error message to stdout.\item\end{CompactList}\item 
virtual const {\bf TYPE}\& {\bf get\-Type} (void)
\begin{CompactList}\small\item\em Returns the \char`\"{}thrown\char`\"{} error message TYPE.\item\end{CompactList}\item 
virtual const char$\ast$ {\bf get\-Message} (void)
\begin{CompactList}\small\item\em Returns the \char`\"{}thrown\char`\"{} error message string.\item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
char {\bf error\_\-message} [256]
\item 
{\bf TYPE} {\bf type}
\end{CompactItemize}


\subsection{Member Enumeration Documentation}
\index{RtAudioError@{Rt\-Audio\-Error}!TYPE@{TYPE}}
\index{TYPE@{TYPE}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum Rt\-Audio\-Error::TYPE}\label{classRtAudioError_s11}


\begin{Desc}
\item[{\bf Enumeration values:}]\par
\begin{description}
\index{WARNING@{WARNING}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!WARNING@{WARNING}}\item[
{\em WARNING}\label{classRtAudioError_s11s0}
]\index{DEBUG_WARNING@{DEBUG\_\-WARNING}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!DEBUG_WARNING@{DEBUG\_\-WARNING}}\item[
{\em DEBUG\_\-WARNING}\label{classRtAudioError_s11s1}
]\index{UNSPECIFIED@{UNSPECIFIED}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!UNSPECIFIED@{UNSPECIFIED}}\item[
{\em UNSPECIFIED}\label{classRtAudioError_s11s2}
]\index{NO_DEVICES_FOUND@{NO\_\-DEVICES\_\-FOUND}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!NO_DEVICES_FOUND@{NO\_\-DEVICES\_\-FOUND}}\item[
{\em NO\_\-DEVICES\_\-FOUND}\label{classRtAudioError_s11s3}
]\index{INVALID_DEVICE@{INVALID\_\-DEVICE}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!INVALID_DEVICE@{INVALID\_\-DEVICE}}\item[
{\em INVALID\_\-DEVICE}\label{classRtAudioError_s11s4}
]\index{INVALID_STREAM@{INVALID\_\-STREAM}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!INVALID_STREAM@{INVALID\_\-STREAM}}\item[
{\em INVALID\_\-STREAM}\label{classRtAudioError_s11s5}
]\index{MEMORY_ERROR@{MEMORY\_\-ERROR}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!MEMORY_ERROR@{MEMORY\_\-ERROR}}\item[
{\em MEMORY\_\-ERROR}\label{classRtAudioError_s11s6}
]\index{INVALID_PARAMETER@{INVALID\_\-PARAMETER}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!INVALID_PARAMETER@{INVALID\_\-PARAMETER}}\item[
{\em INVALID\_\-PARAMETER}\label{classRtAudioError_s11s7}
]\index{DRIVER_ERROR@{DRIVER\_\-ERROR}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!DRIVER_ERROR@{DRIVER\_\-ERROR}}\item[
{\em DRIVER\_\-ERROR}\label{classRtAudioError_s11s8}
]\index{SYSTEM_ERROR@{SYSTEM\_\-ERROR}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!SYSTEM_ERROR@{SYSTEM\_\-ERROR}}\item[
{\em SYSTEM\_\-ERROR}\label{classRtAudioError_s11s9}
]\index{THREAD_ERROR@{THREAD\_\-ERROR}!RtAudioError@{Rt\-Audio\-Error}}\index{RtAudioError@{RtAudioError}!THREAD_ERROR@{THREAD\_\-ERROR}}\item[
{\em THREAD\_\-ERROR}\label{classRtAudioError_s11s10}
]\end{description}
\end{Desc}



\subsection{Constructor \& Destructor Documentation}
\index{RtAudioError@{Rt\-Audio\-Error}!RtAudioError@{RtAudioError}}
\index{RtAudioError@{RtAudioError}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Rt\-Audio\-Error::Rt\-Audio\-Error (const char $\ast$ {\em p}, {\bf TYPE} {\em tipe} = Rt\-Audio\-Error::UNSPECIFIED)}\label{classRtAudioError_a0}


The constructor.

\index{RtAudioError@{Rt\-Audio\-Error}!~RtAudioError@{$\sim$RtAudioError}}
\index{~RtAudioError@{$\sim$RtAudioError}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Rt\-Audio\-Error::$\sim$Rt\-Audio\-Error (void)\hspace{0.3cm}{\tt  [virtual]}}\label{classRtAudioError_a1}


The destructor.



\subsection{Member Function Documentation}
\index{RtAudioError@{Rt\-Audio\-Error}!printMessage@{printMessage}}
\index{printMessage@{printMessage}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Rt\-Audio\-Error::print\-Message (void)\hspace{0.3cm}{\tt  [virtual]}}\label{classRtAudioError_a2}


Prints \char`\"{}thrown\char`\"{} error message to stdout.

\index{RtAudioError@{Rt\-Audio\-Error}!getType@{getType}}
\index{getType@{getType}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf TYPE} \& Rt\-Audio\-Error::get\-Type (void)\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classRtAudioError_a3}


Returns the \char`\"{}thrown\char`\"{} error message TYPE.

\index{RtAudioError@{Rt\-Audio\-Error}!getMessage@{getMessage}}
\index{getMessage@{getMessage}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ Rt\-Audio\-Error::get\-Message (void)\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classRtAudioError_a4}


Returns the \char`\"{}thrown\char`\"{} error message string.



\subsection{Member Data Documentation}
\index{RtAudioError@{Rt\-Audio\-Error}!error_message@{error\_\-message}}
\index{error_message@{error\_\-message}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char Rt\-Audio\-Error::error\_\-message\hspace{0.3cm}{\tt  [protected]}}\label{classRtAudioError_n0}


\index{RtAudioError@{Rt\-Audio\-Error}!type@{type}}
\index{type@{type}!RtAudioError@{Rt\-Audio\-Error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf TYPE} Rt\-Audio\-Error::type\hspace{0.3cm}{\tt  [protected]}}\label{classRtAudioError_n1}




The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
{\bf Rt\-Audio.h}\end{CompactItemize}