audiere::SingleSoundEffect Class Reference

Inheritance diagram for audiere::SingleSoundEffect:

[legend]Collaboration diagram for audiere::SingleSoundEffect:

[legend]List of all members.

Public Member Functions
	SingleSoundEffect (OutputStream *os)
void	play ()
void	stop ()
void	setVolume (float volume)
float	getVolume ()
void	setPan (float pan)
float	getPan ()
void	setPitchShift (float shift)
float	getPitchShift ()

---

Detailed Description

Definition at line 7 of file sound_effect.cpp.

---

Constructor & Destructor Documentation

audiere::SingleSoundEffect::SingleSoundEffect (  OutputStream *  os  )  [inline]

Definition at line 9 of file sound_effect.cpp.

---

Member Function Documentation

float audiere::SingleSoundEffect::getPan (   )  [inline, virtual]

Get current pan. Implements audiere::SoundEffect. Definition at line 42 of file sound_effect.cpp.

float audiere::SingleSoundEffect::getPitchShift (   )  [inline, virtual]

Get current pitch shift. Defaults to 1.0. Implements audiere::SoundEffect. Definition at line 50 of file sound_effect.cpp.

float audiere::SingleSoundEffect::getVolume (   )  [inline, virtual]

Gets the current volume. Returns: current volume of the output stream Implements audiere::SoundEffect. Definition at line 34 of file sound_effect.cpp.

void audiere::SingleSoundEffect::play (   )  [inline, virtual]

Trigger playback of the sound. If the SoundEffect is of type SINGLE, this plays the sound if it isn't playing yet, and starts it again if it is. If the SoundEffect is of type MULTIPLE, play() simply starts playing the sound again. Implements audiere::SoundEffect. Definition at line 17 of file sound_effect.cpp.

void audiere::SingleSoundEffect::setPan (  float  pan  )  [inline, virtual]

Set current pan. Parameters: pan  -1.0 = left, 0.0 = center (default), 1.0 = right Implements audiere::SoundEffect. Definition at line 38 of file sound_effect.cpp.

void audiere::SingleSoundEffect::setPitchShift (  float  shift  )  [inline, virtual]

Set current pitch shift. Parameters: shift  can range from 0.5 to 2.0. default is 1.0. Implements audiere::SoundEffect. Definition at line 46 of file sound_effect.cpp.

void audiere::SingleSoundEffect::setVolume (  float  volume  )  [inline, virtual]

Sets the sound's volume. Parameters: volume  0.0 = silence, 1.0 = maximum volume (default) Implements audiere::SoundEffect. Definition at line 30 of file sound_effect.cpp.

void audiere::SingleSoundEffect::stop (   )  [inline, virtual]

If the sound is of type SINGLE, stop the sound. If it is of type MULTIPLE, stop all playing instances of the sound. Implements audiere::SoundEffect. Definition at line 25 of file sound_effect.cpp.

---

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

• sound_effect.cpp

---