Home   Class/Enum List   File List   Compound Members  

Public Types | Public Member Functions | List of all members
RtAudioError Class Reference

Exception handling class for RtAudio. More...

#include <RtAudio.h>

Inherits exception.

Public Types

enum  Type {
  WARNING, DEBUG_WARNING, UNSPECIFIED, NO_DEVICES_FOUND,
  INVALID_DEVICE, MEMORY_ERROR, INVALID_PARAMETER, INVALID_USE,
  DRIVER_ERROR, SYSTEM_ERROR, THREAD_ERROR
}
 Defined RtAudioError types. More...
 

Public Member Functions

 RtAudioError (const std::string &message, Type type=RtAudioError::UNSPECIFIED) throw ()
 The constructor.
 
virtual ~RtAudioError (void) throw ()
 The destructor.
 
virtual void printMessage (void) const throw ()
 Prints thrown error message to stderr.
 
virtual const TypegetType (void) const throw ()
 Returns the thrown error message type.
 
virtual const std::string & getMessage (void) const throw ()
 Returns the thrown error message string.
 
virtual const char * what (void) const throw ()
 Returns the thrown error message as a c-style string.
 

Detailed Description

Exception handling class for RtAudio.

The RtAudioError class is quite simple but it does allow errors to be "caught" by RtAudioError::Type. See the RtAudio documentation to know which methods can throw an RtAudioError.

Member Enumeration Documentation

Defined RtAudioError types.

Enumerator
WARNING 

A non-critical error.

DEBUG_WARNING 

A non-critical error which might be useful for debugging.

UNSPECIFIED 

The default, unspecified error type.

NO_DEVICES_FOUND 

No devices found on system.

INVALID_DEVICE 

An invalid device ID was specified.

MEMORY_ERROR 

An error occured during memory allocation.

INVALID_PARAMETER 

An invalid parameter was specified to a function.

INVALID_USE 

The function was called incorrectly.

DRIVER_ERROR 

A system driver error occured.

SYSTEM_ERROR 

A system error occured.

THREAD_ERROR 

A thread error occured.


The documentation for this class was generated from the following file:

©2001-2016 Gary P. Scavone, McGill University. All Rights Reserved.
Maintained by Gary P. Scavone.