CSndWrapSDL Class Reference

This is the Linux implementation of the Sound Wrapper. More...

#include <SndWrapSDL.h>

Inheritance diagram for CSndWrapSDL:

Public Member Functions
eC_Bool	DeInit (void)
eC_UByte	GetVolume ()
eC_Bool	Init (void)
void	LoadSnd (const eC_String &pkPath, const SoundResource_t &eID, eC_UInt uiDeviceID=0)
eC_Bool	PauseSnd (const SoundResource_t &eID)
eC_Bool	PlaySnd (const SoundResource_t &eID, eC_UInt Flags=PLAY_ASYNC)
eC_Bool	ResumeSnd (const SoundResource_t &eID)
eC_Bool	SetVolume (eC_UByte ubVolume)
eC_Bool	StopSnd (const SoundResource_t &eID)
void	UnloadSnd (const SoundResource_t &eID)
Public Member Functions inherited from CSndWrap
virtual eC_UInt	GetNOFSounds ()
virtual eC_UByte	GetVolume ()=0
virtual eC_Bool	PauseSnd (const SoundResource_t &eID)=0
virtual eC_Bool	PlaySnd (const SoundResource_t &eID, eC_UInt uiFlags=2)=0
virtual eC_Bool	ResumeSnd (const SoundResource_t &eID)=0
virtual eC_Bool	SetVolume (eC_UByte ubVolume)=0
virtual eC_Bool	StopSnd (const SoundResource_t &eID)=0

Static Public Member Functions
static void	CreateInstance ()
	Constructor.
Static Public Member Functions inherited from CSndWrap
static void	DeleteInstance ()
	Deletes the Sound-Wrapper instance.

Additional Inherited Members
Protected Member Functions inherited from CSndWrap
	CSndWrap ()
	Constructor.
	CSndWrap (const CSndWrap &kSource)
virtual	~CSndWrap ()
	Destructor.
virtual void	LoadSnd (const eC_String &kPath, const SoundResource_t &eID, eC_UInt uiDeviceID=0)=0
CSndWrap &	operator= (const CSndWrap &kSource)
virtual eC_Bool	SetNOFSounds (eC_UInt uiNOFSounds)
virtual void	UnloadSnd (const SoundResource_t &eID)=0
Protected Attributes inherited from CSndWrap
eC_UInt	m_uiNOFSounds
	total number of sound-objects.

Detailed Description

This is the Linux implementation of the Sound Wrapper.

Member Function Documentation

DeInit()

eC_Bool CSndWrapSDL::DeInit

(

void

)

Method to give the sound library the opportunity to clean up

Returns

true if successful

GetVolume()

eC_UByte CSndWrapSDL::GetVolume ( )

virtual

Method to get the volume of an output device. The volume has to be implemented in percent. The range is from 0 till 100.

Returns

The currently set volume in percent.

Implements CSndWrap.

Init()

eC_Bool CSndWrapSDL::Init

(

void

)

Method to initialize the sound library

Returns

true if successful

LoadSnd()

void CSndWrapSDL::LoadSnd ( const eC_String &  kPath, const SoundResource_t &  eID, eC_UInt  uiDeviceID = 0  )

virtual

Method to load a sound file.

Parameters

kPath	Path to the sound file.
eID	ID of the sound.
uiDeviceID	TBD

Implements CSndWrap.

PauseSnd()

eC_Bool CSndWrapSDL::PauseSnd ( const SoundResource_t &  eID )

virtual

Method to break playback on a specified sound.

Parameters

eID	ID of the sound you want to pause.

Returns

False on error.

Implements CSndWrap.

PlaySnd()

eC_Bool CSndWrapSDL::PlaySnd ( const SoundResource_t &  eID, eC_UInt  uiFlags = PLAY_ASYNC  )

virtual

Method to send data to the specified output device.

Parameters

eID

ID of the sound you want to play.

uiFlags

Flags to set for playing. possible flags: PLAY_SYNC - wait until playback has finished before returning PLAY_ASYNC - return immediately to calling function PLAY_WAIT - if a sound is currently playing, wait for the playing sound to end, then play the new sound PLAY_DISCARD - if a sound is currently playing, return without playing the new sound PLAY_IMMEDIATELY - if a sound is currently playing, immediately stop playback and play the new sound

Returns

False on error.

Implements CSndWrap.

ResumeSnd()

eC_Bool CSndWrapSDL::ResumeSnd ( const SoundResource_t &  eID )

virtual

Method for continuing the playback of a specified sound.

Parameters

eID	ID of the sound you want to resume.

Returns

False on error.

Implements CSndWrap.

SetVolume()

eC_Bool CSndWrapSDL::SetVolume ( eC_UByte  ubVolume )

virtual

Method to set the volume of an output device. The volume has to be implemented in percent. The range is from 0 till 100.

Parameters

ubVolume

to set in percent.

Returns

False on error.

Implements CSndWrap.

StopSnd()

eC_Bool CSndWrapSDL::StopSnd ( const SoundResource_t &  eID )

virtual

Method to stop playback of a specified sound.

Parameters

eID	ID of the sound you want to stop.

Returns

False on error.

Implements CSndWrap.

UnloadSnd()

void CSndWrapSDL::UnloadSnd ( const SoundResource_t &  eID )

virtual

Method to unload a sound file.

Parameters

eID	ID of the sound to unload.

Implements CSndWrap.

---

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

• SndWrapSDL.h