RtAudioError Class Reference

Exception handling class for RtAudio. More...

#include <RtAudio.h>

Inheritance diagram for RtAudioError:

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)
	The constructor.
virtual void	printMessage (void) const
	Prints thrown error message to stderr.
virtual const Type &	getType (void) const
	Returns the thrown error message type.
virtual const std::string	getMessage (void) const
	Returns the thrown error message string.

Protected Attributes
Type	type_

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

Type

enum RtAudioError::Type

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.

Constructor & Destructor Documentation

RtAudioError()

RtAudioError::RtAudioError ( const std::string & message, Type type = RtAudioError::UNSPECIFIED )

inline

The constructor.

Member Function Documentation

getMessage()

virtual const std::string RtAudioError::getMessage ( void ) const

inlinevirtual

Returns the thrown error message string.

getType()

virtual const Type & RtAudioError::getType ( void ) const

inlinevirtual

Returns the thrown error message type.

printMessage()

virtual void RtAudioError::printMessage ( void ) const

inlinevirtual

Prints thrown error message to stderr.

Member Data Documentation

type_

Type RtAudioError::type_

protected

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/rtaudio/RtAudio.h