KGrSounds Class Reference

#include <kgrsounds.h>

Inheritance diagram for KGrSounds:

Public Member Functions
	KGrSounds ()
	~KGrSounds ()
int	loadSound (const QString &fileName)
int	play (int effect)
void	reset ()
void	setEffectsVolume (double volume)
void	setMusicVolume (double volume)
void	setMuted (bool mute)
void	setTimedSound (int i)
void	setVolume (int effect, qreal volume)
void	stop (int token)
void	stopAllSounds ()

Detailed Description

Definition at line 28 of file kgrsounds.h.

Constructor & Destructor Documentation

KGrSounds::KGrSounds

(

)

Construct the KGrSounds class.

Definition at line 23 of file kgrsounds.cpp.

KGrSounds::~KGrSounds

(

)

Definition at line 30 of file kgrsounds.cpp.

Member Function Documentation

int KGrSounds::loadSound

(

const QString &

fileName

)

Load a sound sample.

A token is returned to use to play back the sample.

Definition at line 34 of file kgrsounds.cpp.

int KGrSounds::play

(

int

effect

)

Play a sound effect.

This method returns a token that can be used to stop the sound if it is still playing. Trying to stop a completed sound has no effect.

Definition at line 60 of file kgrsounds.cpp.

void KGrSounds::reset

(

)

Stop sound and discard the loaded sound effects.

Definition at line 54 of file kgrsounds.cpp.

void KGrSounds::setEffectsVolume

(

double

volume

)

Set volume for the sound effects.

Parameters

volume

the playing volume. 0.0 means mute, 1.0 means full volume.

void KGrSounds::setMusicVolume

(

double

volume

)

Set volume for the background music.

Parameters

volume

the playing volume. 0.0 means mute, 1.0 means full volume.

void KGrSounds::setMuted

(

bool

mute

)

Definition at line 91 of file kgrsounds.cpp.

void KGrSounds::setTimedSound

(

int

i

)

Set up a sound to have its latest start-time recorded.

Definition at line 42 of file kgrsounds.cpp.

void KGrSounds::setVolume	(	int	effect,
		qreal	volume
	)

Change the volume of one type of sound (e.g.

footstep) by a given factor.

Parameters

volume

0.0 for mute, > 1.0 to increase, < 1.0 to decrease.

Definition at line 99 of file kgrsounds.cpp.

void KGrSounds::stop

(

int

token

)

Stop playing the sound associated with the given token.

Definition at line 84 of file kgrsounds.cpp.

void KGrSounds::stopAllSounds

(

)

Stop all sounds currently playing.

Definition at line 47 of file kgrsounds.cpp.

---

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

• kgrsounds.h
• kgrsounds.cpp