SFXController

consoledoc.h

A sound source that drives multi-source playback.

More...

bool

trace 

int

getCurrentSlot()

void

setCurrentSlot(int index)

Detailed Description

A sound source that drives multi-source playback.

This class acts as an interpreter for SFXPlayLists. It goes through the slots of the playlist it is attached to and performs the actions described by each of the slots in turn. As SFXControllers are created implicitly by the SFX system when instantiating a source for a play list it is in most cases not necessary to directly deal with the class. The following example demonstrates how a controller would commonly be created.

// Create a play list from two SFXProfiles.
%playList = new SFXPlayList()
{
   // Use a looped description so the list playback will loop.
   description = AudioMusicLoop2D;

   track[ 0 ] = Profile1;
   track[ 1 ] = Profile2;
};

// Play the list.  This will implicitly create a controller.
sfxPlayOnce( %playList );

note:

Play lists are updated at regular intervals by the sound system. This processing determines the granularity at which playlist action timing takes place.

note:

This class cannot be instantiated directly. Use sfxPlayOnce() or sfxCreateSource() with the playlist you want to play to create an instance of this class.

bool trace 

getCurrentSlot()

setCurrentSlot(int index)