---

ISoundScape Class Reference

Class defining a collection of sounds which make up a soundscape. More...

#include <ISound.h>

Inheritance diagram for ISoundScape::

List of all members.

Public Methods
virtual bool	Init ()=0
virtual bool	AddElement (const BackgroundInit &init)=0
virtual bool	AddElement (const PeriodicInit &init)=0
virtual bool	SetVolume (float fVolume)=0
virtual bool	GetVolume (float &fVolume) const=0

---

Detailed Description

Class defining a collection of sounds which make up a soundscape.

ISoundScape represents a collection of looping background sounds and randomly firing 3D positional elements which can be collectively adjusted and controlled via the IPlayable interface.

---

Member Function Documentation

bool ISoundScape::AddElement ( const PeriodicInit & init ) [pure virtual]

Adds a periodic element to the soundscape. Parameters: init   defines the characteristics of the periodic element Returns: true indicates success, false indicates failure.

bool ISoundScape::AddElement ( const BackgroundInit & init ) [pure virtual]

Adds a background element to the soundscape. Parameters: init   defines the characteristics of the background element Returns: true indicates success, false indicates failure.

bool ISoundScape::GetVolume ( float & fVolume ) const [pure virtual]

Gets the volume for this soundscape. Parameters: fVolume   retrieves the current object's volume Returns: true indicates success, false indicates failure. See also: SetVolume()

bool ISoundScape::SetVolume ( float fVolume ) [pure virtual]

Sets the collective volume of a soundscape. This value will decrease the volume in addition to any decrease from maximum volume set in the master volume controls. Parameters: fVolume   sets the volume desired Returns: true indicates success, false indicates failure. See also: GetVolume()

---

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

• ISound.h

---