ugdk::Sample Class Reference

#include <sample.h>

List of all members.

Public Member Functions
void	Play ()
	Plays the sound.
void	PlayForever ()
	Plays this sample until told to stop.
void	Play (int loops)
	Plays the sound the given number of times.
void	Stop ()
	Stops playing the sound.
bool	IsPlaying ()
	Returns whether the sound is playing or not.
void	SetVolume (double vol)
	Sets the volume.
double	Volume ()
	Returns the sound's volume.
Friends
class	AudioManager

---

Detailed Description

Note: It isn't possible to instantiate a Sample directly. In order to play a sound, you must call LoadSample() from AudioManager. All memory management is done my the AudioManager.

See also:

AudioManager

---

Member Function Documentation

bool ugdk::Sample::IsPlaying

(

)

Returns whether the sound is playing or not.

void ugdk::Sample::Play

(

)

Plays the sound.

void ugdk::Sample::Play

(

int

loops

)

Plays the sound the given number of times.

void ugdk::Sample::PlayForever

(

)

Plays this sample until told to stop.

void ugdk::Sample::SetVolume

(

double

vol

)

Sets the volume.

Sets the volume between 0 and 1. 0 is silent, 1 is the max volume.

Parameters:

vol	The volume.

void ugdk::Sample::Stop

(

)

Stops playing the sound.

double ugdk::Sample::Volume

(

)

Returns the sound's volume.

Returns:

The actual volume, 0.0 <= volume <= 1.0

---

Friends And Related Function Documentation

friend class AudioManager [friend]

---

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

• src/ugdk/audio/sample.h
• src/ugdk/audio/sample.cc