csl::Spatializer Class Reference

#include <SpatialAudio.h>

Inheritance diagram for csl::Spatializer:

csl::UnitGenerator csl::Observer csl::Model csl::Auralizer

List of all members.

Public Member Functions

 Spatializer (PannerType panMode=kAutomatic, SpeakerLayout *speakerLayout=SpeakerLayout::defaultSpeakerLayout())
 ~Spatializer ()
void addSource (SpatialSource &s)
 Add a sound souce to the list of inputs to be processed.
void removeSource (SpatialSource &s)
 Remove a Sound Source.
unsigned numSources ()
void setPanningMode (PannerType panType)
 number of active inputs.
virtual void update (void *arg)
 called when the speaker layout changes, so panners update precalculated data.
virtual void nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
 fill the buffer with data :-)

Private Attributes

SpatialPannermPanner
map< SpatialSource
*, DistanceSimulator * > 
mInputsHashMap
SpeakerLayoutmSpeakerLayout


Detailed Description

Container class that simplifies the spatial audio interface. This layer hides most of the inner-working of audio spatialization, providing a simple interface for sound placement in a space.

Constructor & Destructor Documentation

Spatializer::Spatializer ( PannerType  panMode = kAutomatic,
SpeakerLayout speakerLayout = SpeakerLayout::defaultSpeakerLayout() 
)

Spatializer::~Spatializer (  ) 

References mPanner.


Member Function Documentation

void Spatializer::addSource ( SpatialSource s  ) 

Add a sound souce to the list of inputs to be processed.

References csl::SpatialPanner::addSource(), mInputsHashMap, and mPanner.

Referenced by main().

void Spatializer::removeSource ( SpatialSource s  ) 

Remove a Sound Source.

References csl::logMsg(), mInputsHashMap, mPanner, and csl::SpatialPanner::removeSource().

unsigned csl::Spatializer::numSources (  )  [inline]

void Spatializer::setPanningMode ( PannerType  panType  ) 

void Spatializer::update ( void *  arg  )  [virtual]

called when the speaker layout changes, so panners update precalculated data.

Implements csl::Observer.

void Spatializer::nextBuffer ( Buffer outputBuffer,
unsigned  outBufNum 
) throw (CException) [virtual]

fill the buffer with data :-)

Reimplemented from csl::UnitGenerator.

References csl::logMsg().


Member Data Documentation

a map between a source passed/key and a the corresponding distance simulator (used for removing sources)

Referenced by addSource(), removeSource(), and setPanningMode().

If null, it will use the default layout by calling SpeakerLayout::defaultSpeakerLayout();

Referenced by setPanningMode().


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

Generated on Thu Sep 17 23:14:18 2009 for CSL by  doxygen 1.5.8