Release 2.0 tarball2.0

1 files changed, 135 insertions, 0 deletions

diff --git a/doc/latex/classRtAudioError.tex b/doc/latex/classRtAudioError.tex
new file mode 100644
index 0000000..5201ef3
--- /dev/null
+++ b/doc/latex/classRtAudioError.tex
@@ -0,0 +1,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}