---

audiere::SoundEffect Class Reference

#include <audiere.h>

Inheritance diagram for audiere::SoundEffect:

[legend]Collaboration diagram for audiere::SoundEffect:

[legend]List of all members.

Public Methods
virtual void ADR_CALL	play ()=0
virtual void ADR_CALL	stop ()=0
Protected Methods
	~SoundEffect ()

---

Detailed Description

SoundEffect is a conveneence class which provides a simple mechanism for basic sound playback. There are two types of sound effects: SINGLE and MULTIPLE. SINGLE sound effects only allow the sound to be played once at a time. MULTIPLE sound effects always open a new stream to the audio device for each time it is played (cleaning up or reusing old streams if possible).

Definition at line 539 of file audiere.h.

---

Constructor & Destructor Documentation

audiere::SoundEffect::~SoundEffect (    )  [inline, protected]

Definition at line 541 of file audiere.h.

---

Member Function Documentation

virtual void ADR_CALL audiere::SoundEffect::play (    )  [pure 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. Implemented in audiere::SingleSoundEffect, and audiere::MultipleSoundEffect.

virtual void ADR_CALL audiere::SoundEffect::stop (    )  [pure virtual]

If the sound is of type SINGLE, stop the sound. If it is of type MULTIPLE, stop all playing instances of the sound. Implemented in audiere::SingleSoundEffect, and audiere::MultipleSoundEffect.

---

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

• audiere.h

---