---

ISoundManager Class Reference

Controls and manages high-level sound objects. More...

#include <ISound.h>

List of all members.

Public Methods
virtual bool	Init ()=0
virtual void	Term ()=0
virtual bool	IsInitialized ()=0
virtual bool	LoadScript (std::string sFileName)=0
virtual bool	RemoveAll ()=0
virtual bool	GetSound (std::string sSoundName, ISound *&pSound)=0
virtual bool	GetSoundInit (std::string sSoundName, SoundInit &init)=0
virtual bool	ReleaseSound (std::string sSoundName, ISound *pSound)=0
virtual bool	IsSoundRegistered (std::string sSoundName)=0
virtual void	ResetSoundItr ()=0
virtual bool	GetNextSound (std::string &sSoundName)=0
virtual bool	RemoveSound (std::string sSoundName)=0
virtual bool	RemoveAllSounds ()=0
virtual bool	GetSound3D (std::string sSound3DName, ISound3D *&pSound3D)=0
virtual bool	GetSound3DInit (std::string sSound3DName, Sound3DInit &init)=0
virtual bool	ReleaseSound3D (std::string sSound3DName, ISound3D *pSound3D)=0
virtual bool	IsSound3DRegistered (std::string sSound3DName)=0
virtual void	ResetSound3DItr ()=0
virtual bool	GetNextSound3D (std::string &sSound3DName)=0
virtual bool	RemoveSound3D (std::string sSound3DName)=0
virtual bool	RemoveAllSounds3D ()=0
virtual bool	CreateSoundScape (ISoundScape *&pSoundScape)=0
virtual bool	InitSoundScape (std::string sSoundScapeName, ISoundScape *&pSoundScape)=0
virtual bool	IsSoundScapeRegistered (std::string sSoundScapeName)=0
virtual void	ResetSoundScapeItr ()=0
virtual bool	GetNextSoundScape (std::string &sSoundScapeName)=0
virtual bool	RemoveSoundScape (std::string sSoundScapeName)=0
virtual bool	RemoveAllSoundScapes ()=0

---

Detailed Description

Controls and manages high-level sound objects.

ISoundManager is responsible for managing high-level sound objects, including multiple-instance ISound and ISound3D objects, and ISoundScape objects. Definitions are loaded using a text-based script, and individual objects are instantiated using the string-based identifiers found in the scripts.

---

Member Function Documentation

bool ISoundManager::GetSound ( std::string sSoundName, ISound *& pSound ) [pure virtual]

Gets a cached sound if one is available. If not, the function creates and returns a new sound object. Parameters: sSoundName   name of the sound definition as defined in a loaded script file. pSound   ISound interface to retrieve. Returns: true indicates success, false indicates failure. See also: ReleaseSound()

bool ISoundManager::GetSound3D ( std::string sSound3DName, ISound3D *& pSound3D ) [pure virtual]

Gets a cached 3D sound if one is available. If not, the function creates and returns a new 3D sound object. Parameters: sSound3DName   name of the 3D sound definition as defined in a loaded script file. pSound3D   ISound3D interface to retrieve. Returns: true indicates success, false indicates failure. See also: ReleaseSound3D()

bool ISoundManager::GetSound3DInit ( std::string sSound3DName, Sound3DInit & init ) [pure virtual]

Retrieves a 3D sound initialization structure for a given sound script definition. This allows you to create 3D sounds indepenent of the sound caching mechanism while still using the script system. Returns: true indicates success, false indicates failure.

bool ISoundManager::GetSoundInit ( std::string sSoundName, SoundInit & init ) [pure virtual]

Retrieves a sound initialization structure for a given sound script definition. This allows you to create sounds indepenent of the sound caching mechanism while still using the script system. Returns: true indicates success, false indicates failure.

bool ISoundManager::Init ( ) [pure virtual]

Initializes the sound manager. This must be called after the low-level audio manager has been initalized, and before any other sound manager calls are made, except for IsInitialized(). Returns: true indicates success, false indicates failure. See also: Term(), IsInitialized()

bool ISoundManager::IsInitialized ( ) [pure virtual]

Determines if the sound manager is initialized. Returns: true indicates the manager is initialized, false indicates the manager is not initialized. See also: Init(), Term()

bool ISoundManager::LoadScript ( std::string sFileName ) [pure virtual]

Loads a sound script containing ISound, ISound3D, or ISoundScape definitions. Parameters: sFileName   name of the sound script to load Returns: true indicates success, false indicates failure. See also: RemoveAll()

bool ISoundManager::RemoveAll ( ) [pure virtual]

Removes all ISound, ISound3D, and ISoundscape definitions. In addition, all sound objects currently associated with ISound or ISound3D definitions will be removed. Parameters: sFileName   name of the sound script to load Returns: true indicates success, false indicates failure. See also: RemoveAll()

void ISoundManager::Term ( ) [pure virtual]

Shuts down the sound manager. This should be called before the low-level audio manager is shut down. Any calls made to this interface after Term() is called will fail except for Init() and IsInitialized(), which simply reports status and cannot fail. See also: Init(), IsInitialized()

---

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

• ISound.h

---