Cafu Engine
MixerTrackManT Class Reference

The mixer track manager manages the limited mixer tracks that are needed to playback a sound object. More...

#include "MixerTrackMan.hpp"

Public Member Functions

MixerTrackTGetMixerTrack (unsigned int Priority=0)
 Interface to get a free mixer track that can be used to playback a sound object. More...
 
void CleanUp ()
 Deletes all mixer tracks that are currently unused (have no playing sound file attached to them). More...
 
void UpdateAll ()
 Calls Update() for all mixer tracks. More...
 
void ReleaseAll ()
 Releases all mixer tracks. More...
 

Static Public Member Functions

static MixerTrackManTGetInstance ()
 Returns an instance to the global mixer track manager. More...
 

Detailed Description

The mixer track manager manages the limited mixer tracks that are needed to playback a sound object.

Member Function Documentation

void MixerTrackManT::CleanUp ( )

Deletes all mixer tracks that are currently unused (have no playing sound file attached to them).

MixerTrackManT * MixerTrackManT::GetInstance ( )
static

Returns an instance to the global mixer track manager.

MixerTrackT * MixerTrackManT::GetMixerTrack ( unsigned int  Priority = 0)

Interface to get a free mixer track that can be used to playback a sound object.

The method checks all currently available mixer tracks for one that is no longer used (sound object attached to it is no longer playing) and returns it. If no "free" mixer track is found it attempts to create a new one and returns it.

Parameters
PriorityThe priority of this request for a mixer track. Usually one should use the priority of the sound object this mixer track is intended for.
Returns
The mixer track that can be used for playback or NULL if no mixer track could be optained.
void MixerTrackManT::ReleaseAll ( )

Releases all mixer tracks.

void MixerTrackManT::UpdateAll ( )

Calls Update() for all mixer tracks.


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