sx::AudioPass Class Reference

#include <SXCore.h>

Inheritance diagram for sx::AudioPass:

Public Member Functions
EX	AudioPass (const string &id)
EX	~AudioPass ()
EX void	setPause (bool pause)
EX bool	isPaused () const
EX void	load ()
EX void	unload ()
EX bool	isLoaded () const
EX void	setAudioListener (AudioListener &listener)
EX void	addAudioObject (AudioObject &object)
EX void	removeAudioObject (const string &id)
EX void	removeAudioObjects ()
EX void	update ()
Public Member Functions inherited from sx::SXResource
virtual EX	~SXResource ()
EX const string &	getID () const

Additional Inherited Members
Protected Attributes inherited from sx::SXResource
string	id

Detailed Description

A collection of AudioObjects with an AudioListener. The update method updates the sound sources and the listener.

Constructor & Destructor Documentation

EX sx::AudioPass::AudioPass

(

const string &

id

)

constructor

EX sx::AudioPass::~AudioPass

(

)

deconstructor

Member Function Documentation

EX void sx::AudioPass::addAudioObject

(

AudioObject &

object

)

Adds an AudioObject to objects. If another AudioObject with the same id was added before, it's replaced by object.

EX bool sx::AudioPass::isLoaded ( ) const

virtual

Returns true iff this is loaded. As this is always loaded, true is returned.

Implements sx::SXResource.

EX bool sx::AudioPass::isPaused

(

)

const

Returns true iff setPause was invoked the last time with pause == true.

EX void sx::AudioPass::load ( )

virtual

as this is always loaded, this method has no effect on this

Implements sx::SXResource.

EX void sx::AudioPass::removeAudioObject

(

const string &

id

)

Removes the AudioObject with id. If no such AudioObject exists, the method has no effect.

EX void sx::AudioPass::removeAudioObjects

(

)

Removes all AudioObjects.

EX void sx::AudioPass::setAudioListener

(

AudioListener &

listener

)

setter

EX void sx::AudioPass::setPause

(

bool

pause

)

Pauses all AudioObjects in objects, if pause is true. Continues playing all AudioObjects paused by the last invocation of setPause(true), if pause is false. Objects in the pause state, not paused by setPause, are still in the pause state after the invocation of setPause(false).

EX void sx::AudioPass::unload

(

)

as this is always loaded, this method has no effect on this

EX void sx::AudioPass::update

(

)

Updates the AudioObjects in objects and the AudioListener listener. In between two update calls, the change of the listener's and objects' parameters won't influence the sound! Hence update must be called periodically!

---

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

• fluid/res/include/sx/SXCore.h