hpl::cMusicHandler Class Reference

Public Member Functions
	cMusicHandler (iLowLevelSound *apLowLevelSound, cResources *apResources)
bool	Play (const tString &asFileName, float afVolume, float afFadeStepSize, bool abLoop)
void	Stop (float afFadeStepSize)
void	Pause ()
void	Resume ()
void	Lock (cMusicLock *apLock)
void	UnLock ()
tString	GetCurrentSongName ()
float	GetCurrentSongVolume ()
cMusicEntry *	GetCurrentSong ()
void	Update (float afTimeStep)

Member Function Documentation

Play()

bool hpl::cMusicHandler::Play	(	const tString &	asFileName,
		float	afVolume,
		float	afFadeStepSize,
		bool	abLoop
	)

Play a song. Playing a song that is already playing updates it's properties.

Parameters

asFileName	file to be played
afVolume	volume to be played at
afFadeStepSize	volume increse/decrease per app step when fading to new volume.
abLoop	If the music should be looped or not.

Returns

Stop()

void hpl::cMusicHandler::Stop

(

float

afFadeStepSize

)

Stop playing the current music.

Parameters

afFadeStepSize

volume increse/decrease per app step when fading volume to 0.

Lock()

void hpl::cMusicHandler::Lock

(

cMusicLock *

apLock

)

No more music can be played when locked. Latest song that has been tried to be palyed is saved in lock.

Parameters

apLock

UnLock()

void hpl::cMusicHandler::UnLock

(

)

Remove lock.

---

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

• engines/hpl1/engine/sound/MusicHandler.h