Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

ONE::sound::SoundEffect Class Reference

Inheritance diagram for ONE::sound::SoundEffect:

Inheritance graph
[legend]
List of all members.

Detailed Description

a simple sound effect handle

Author:
Daniel Seibert


Public Member Functions

float getDuration () const
 returns the length of the sound in seconds
int play (int chan=-1, int rep=0)
 plays the effect
 ~SoundEffect ()

Friends

class AudioDevice


Constructor & Destructor Documentation

ONE::sound::SoundEffect::~SoundEffect  ) 
 


Member Function Documentation

float ONE::sound::SoundEffect::getDuration  )  const
 

returns the length of the sound in seconds

int ONE::sound::SoundEffect::play int  chan = -1,
int  rep = 0
 

plays the effect

The effect may be played in several channels concurrently.

Parameters:
chan the desired channel or -1 for the first available one
rep the number of repetitions, 0 for single, -1 for infinite
Returns:
the channel that is actually used for playing


Friends And Related Function Documentation

friend class AudioDevice [friend]
 


Generated on Wed Sep 7 19:03:30 2005 for ONEngine by  doxygen 1.4.3