syBR::AudioCore::AudioSystem Class Reference

Base audio system class. More...

#include <AudioSystem.hpp>

List of all members.

Public Member Functions

AudioSystem ()

Constructor.

virtual ~AudioSystem ()

Destructor.

virtual bool initialize ()=0

Initialize sound system.

virtual void terminate ()=0

Terminate sound system.

void update ()

Update sound system.

virtual bool musicPlay ()=0

Play the music.

virtual void musicStop ()=0

Stop playing the music.

virtual bool musicPause ()=0

Pause the music.

Protected Attributes

MusicSystem * m_pMusicSystem

Music system object.

Detailed Description

Base audio system class.

This is the main object which gives access to sound and music modules. This is a pure abstract class which needs a concrete implementation (using OpenAL, DirectSound or any other sound library).

Constructor & Destructor Documentation

syBR::AudioCore::AudioSystem::AudioSystem ( )

Constructor.

syBR::AudioCore::AudioSystem::~AudioSystem ( ) [virtual]

Destructor.

Member Function Documentation

virtual bool syBR::AudioCore::AudioSystem::initialize ( ) [pure virtual]

Initialize sound system.

Returns:

One of these:

true if system was successfully initialized
false otherwise

virtual void syBR::AudioCore::AudioSystem::terminate ( ) [pure virtual]

Terminate sound system.

void syBR::AudioCore::AudioSystem::update ( )

Update sound system.

virtual bool syBR::AudioCore::AudioSystem::musicPlay ( ) [pure virtual]

Play the music.

Returns:

One of these:

true in case of success
false otherwise

virtual void syBR::AudioCore::AudioSystem::musicStop ( ) [pure virtual]

Stop playing the music.

virtual bool syBR::AudioCore::AudioSystem::musicPause ( ) [pure virtual]

Pause the music.

Returns:

New status of the music:

true if music is now paused
false if music is now resumed

Member Data Documentation

MusicSystem* syBR::AudioCore::AudioSystem::m_pMusicSystem [protected]

Music system object.

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

/home/seb/syBR/audioCore/src/AudioSystem.hpp
/home/seb/syBR/audioCore/src/AudioSystem.cpp


Public Member Functions
	AudioSystem ()
	Constructor.
virtual	~AudioSystem ()
	Destructor.
virtual bool	initialize ()=0
	Initialize sound system.
virtual void	terminate ()=0
	Terminate sound system.
void	update ()
	Update sound system.
virtual bool	musicPlay ()=0
	Play the music.
virtual void	musicStop ()=0
	Stop playing the music.
virtual bool	musicPause ()=0
	Pause the music.
Protected Attributes
MusicSystem *	m_pMusicSystem
	Music system object.