OSDL::Audio::AudioModule Class Reference

#include <OSDLAudio.h>

List of all members.

---

Detailed Description

Root module for all audio services.

Definition at line 42 of file OSDLAudio.h.

Public Member Functions
virtual const std::string	toString (Ceylan::VerbosityLevels level=Ceylan::high) const throw ()
	Returns an user-friendly description of the state of this object.
Static Public Member Functions
static std::string	DescribeEnvironmentVariables () throw ()
	Returns a summary about the possible use of video-related environment variables, for the selected back-end, expressed in specified format.
static bool	IsAudioInitialized () throw ()
	Tells whether audio has already been initialized.
Static Protected Attributes
static bool	_AudioInitialized
	Keeps tracks of audio initialization calls.
Private Member Functions
	AudioModule () throw ( AudioException )
	Private constructor to be sure it will not be implicitly called.
virtual	~AudioModule () throw ()
	Virtual destructor ensuring correct audio clean-up.
	AudioModule (const AudioModule &source) throw ()
	Copy constructor made private to ensure that it will be never called.
AudioModule &	operator= (const AudioModule &source) throw ()
	Assignment operator made private to ensure that it will be never called.
Static Private Attributes
static std::string	SDLEnvironmentVariables []
	Array of all known environment variables related to audio, for SDL back-end.
Friends
class	OSDL::CommonModule
class	CommonModule

---

Constructor & Destructor Documentation

AudioModule::AudioModule

(

)

throw ( AudioException ) [private]

Private constructor to be sure it will not be implicitly called.

Exceptions:

AudioException

if the audio subsystem initialization failed.

Definition at line 79 of file OSDLAudio.cc.

References _AudioInitialized, OSDL::CommonModule::BackendSuccess, OSDL::Utils::getBackendLastError(), and OSDL::CommonModule::UseAudio.

AudioModule::~AudioModule

(

)

throw () [private, virtual]

Virtual destructor ensuring correct audio clean-up.

Definition at line 107 of file OSDLAudio.cc.

References OSDL::CommonModule::UseAudio.

OSDL::Audio::AudioModule::AudioModule

(

const AudioModule &

source

)

throw () [explicit, private]

Copy constructor made private to ensure that it will be never called.

The compiler should complain whenever this undefined constructor is called, implicitly or not.

---

Member Function Documentation

const string AudioModule::toString

(

Ceylan::VerbosityLevels

level = Ceylan::high

)

const throw () [virtual]

Returns an user-friendly description of the state of this object.

Parameters:

level

the requested verbosity level.

Note:

Text output format is determined from overall settings.

See also:

Ceylan::TextDisplayable

Definition at line 119 of file OSDLAudio.cc.

References OSDL::Video::Pixels::toString().

string AudioModule::DescribeEnvironmentVariables

(

)

throw () [static]

Returns a summary about the possible use of video-related environment variables, for the selected back-end, expressed in specified format.

Note:

The SDL back-end can be partly driven by a set of environment variables.

Definition at line 135 of file OSDLAudio.cc.

References SDLEnvironmentVariables, and OSDL::Video::Pixels::toString().

bool AudioModule::IsAudioInitialized

(

)

throw () [static]

Tells whether audio has already been initialized.

Note:

This method is static so that calling it is convenient : no need to explicitly retrieve the common module, then audio module before knowing the result.

The need to retrieve the right module from scratch at each call is rather inefficient though.

Definition at line 186 of file OSDLAudio.cc.

References _AudioInitialized.

AudioModule& OSDL::Audio::AudioModule::operator=

(

const AudioModule &

source

)

throw () [private]

Assignment operator made private to ensure that it will be never called.

The compiler should complain whenever this undefined operator is called, implicitly or not.

---

Friends And Related Function Documentation

friend class OSDL::CommonModule [friend]

Definition at line 47 of file OSDLAudio.h.

friend class CommonModule [friend]

Definition at line 162 of file OSDLAudio.h.

---

Member Data Documentation

bool AudioModule::_AudioInitialized [static, protected]

Keeps tracks of audio initialization calls.

Definition at line 105 of file OSDLAudio.h.

Referenced by AudioModule(), and IsAudioInitialized().

string AudioModule::SDLEnvironmentVariables [static, private]

Array of all known environment variables related to audio, for SDL back-end.

Definition at line 158 of file OSDLAudio.h.

Referenced by DescribeEnvironmentVariables().

---

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

• OSDLAudio.h
• OSDLAudio.cc

---