EPOC::Sound Class Reference

#include <Sound.h>

Inheritance diagram for EPOC::Sound:

Inheritance graph
[legend]
Collaboration diagram for EPOC::Sound:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Sound (AudioManager *pAudioManager)
virtual ~Sound ()
virtual void Cleanup ()
virtual bool Update (float fTimeDelta)
virtual bool Load (std::string sFilePath)
virtual bool Play (int nLoops=0)
virtual void Stop ()
virtual void Pause ()
virtual void Resume ()
virtual void SetVolume (int nVolume=100)
virtual int GetVolume ()
virtual void SetPanning (float fPanning=0.0f)
virtual float GetPanning ()
virtual void SetDistance (float fDistance=0.0f)
virtual float GetDistance ()
virtual void NotifyChannelDone (int nChannel)
void SetRemoveWhenDone (bool bStatus)
bool IsRemovedWhenDone ()
bool IsPlaying ()
bool IsPaused ()
bool IsDone ()
MixChunkGetMixChunk ()

Protected Attributes

bool m_bDone
bool m_bPlaying
bool m_bPause
bool m_bRemoveWhenDone
int m_nVolume
int m_nCurrentChannel
int m_nLeftPanning
int m_nRightPanning
int m_nDistance
float m_fPanningRatio
float m_fDistanceRatio
MixChunkm_pMixChunk
AudioManagerm_pAudioManager


Constructor & Destructor Documentation

Sound::Sound ( AudioManager pAudioManager  ) 

Sound::~Sound (  )  [virtual]


Member Function Documentation

void Sound::Cleanup (  )  [virtual]

bool Sound::Update ( float  fTimeDelta  )  [virtual]

Updates class data

Remarks:
This function is called once per frame.
Parameters:
fTimeDelta the time that has passed since last update, measured in milliseconds
Returns:
true if the update succeeded and false if it didn't

Reimplemented from EPOC::BaseObject.

virtual bool EPOC::Sound::Load ( std::string  sFilePath  )  [virtual]

bool Sound::Play ( int  nLoops = 0  )  [virtual]

void Sound::Stop (  )  [virtual]

void Sound::Pause (  )  [virtual]

void Sound::Resume (  )  [virtual]

void Sound::SetVolume ( int  nVolume = 100  )  [virtual]

int Sound::GetVolume (  )  [virtual]

void Sound::SetPanning ( float  fPanning = 0.0f  )  [virtual]

float Sound::GetPanning (  )  [virtual]

void Sound::SetDistance ( float  fDistance = 0.0f  )  [virtual]

float Sound::GetDistance (  )  [virtual]

void Sound::NotifyChannelDone ( int  nChannel  )  [virtual]

void EPOC::Sound::SetRemoveWhenDone ( bool  bStatus  )  [inline]

bool EPOC::Sound::IsRemovedWhenDone (  )  [inline]

bool EPOC::Sound::IsPlaying (  )  [inline]

bool EPOC::Sound::IsPaused (  )  [inline]

bool EPOC::Sound::IsDone (  )  [inline]

MixChunk* EPOC::Sound::GetMixChunk (  )  [inline]


Member Data Documentation

bool EPOC::Sound::m_bDone [protected]

bool EPOC::Sound::m_bPlaying [protected]

bool EPOC::Sound::m_bPause [protected]

bool EPOC::Sound::m_bRemoveWhenDone [protected]

int EPOC::Sound::m_nVolume [protected]

int EPOC::Sound::m_nCurrentChannel [protected]

int EPOC::Sound::m_nLeftPanning [protected]

int EPOC::Sound::m_nRightPanning [protected]

int EPOC::Sound::m_nDistance [protected]

float EPOC::Sound::m_fPanningRatio [protected]

float EPOC::Sound::m_fDistanceRatio [protected]

MixChunk* EPOC::Sound::m_pMixChunk [protected]

AudioManager* EPOC::Sound::m_pAudioManager [protected]


The documentation for this class was generated from the following files:
Generated on Tue Feb 12 08:26:08 2008 for EPOC by  doxygen 1.5.4