ISoundEngine

The interface of the sound engine.  The ISoundEngine plays the given sound file when called.  It is responsible for managing whatever underlying sound engine implementation is used.  The ISoundEngine is accessible through the GameEngine.

Project

RulesCore

Include

ISoundEngine.h

Summary
ISoundEngine
The interface of the sound engine.
Public
Pure Virtual Functions
PlaySound
Plays the given sound.
Protected
Destructor
~ISoundEngine
The ISoundEngine destructor.

Public

Summary
Pure Virtual Functions
PlaySound
Plays the given sound.

Pure Virtual Functions

PlaySound

virtual void PlaySound(const wxString &sound) const=0

Plays the given sound.  The sound name must be the name of a sound file in the /sounds directory or one of its subdirectories.  If the sound cannot be played, an error message is thrown to the screen.

Parameters

soundThe name of the sound file to play.

Protected

Summary
Destructor
~ISoundEngine
The ISoundEngine destructor.

Destructor

~ISoundEngine

virtual ~ISoundEngine()=0

The ISoundEngine destructor.  It is pure virtual because this class must be derived from in order to be used.

virtual void PlaySound(const wxString &sound) const=0
Plays the given sound.
virtual ~ISoundEngine()=0
The ISoundEngine destructor.
The interface of the sound engine.
The engine that drives the game.
RulesCore is the HOSS of Cities3D.