Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members

SoundEngine Class Reference

Collaboration diagram for SoundEngine:

Collaboration graph
[legend]
List of all members.

Detailed Description

SoundEngine is a facade for sound output from two different sources (music, FX).

Definition at line 48 of file SoundEngine.h.

Static Public Member Functions

void playFx (DmResID resID)
 Play a sound effect which is stored in a resource of type 'Tsfx' with the specified resource ID.

void playSong (DmResID resID)
 Play a song where the sequence of patterns is stored in a resource of type 'Ttrk' with the specified resource ID.

void stopSong ()
 Stop the currently playing song.

void timeTick ()
 This method needs to be invoked periodically, in order for SoundEngine to work.


Friends

class Presentation


Member Function Documentation

void SoundEngine::playFx DmResID    resID [static]
 

Play a sound effect which is stored in a resource of type 'Tsfx' with the specified resource ID.

Parameters:
resID the ID of the 'Tsfx' resource

void SoundEngine::playSong DmResID    resID [static]
 

Play a song where the sequence of patterns is stored in a resource of type 'Ttrk' with the specified resource ID.

The patterns themselves are stored in resources of type 'Tpat' where the pattern ID is the resource ID.

Parameters:
resID the ID of the 'Ttrk' resource

void SoundEngine::stopSong   [static]
 

Stop the currently playing song.

void SoundEngine::timeTick   [static]
 

This method needs to be invoked periodically, in order for SoundEngine to work.


Friends And Related Function Documentation

friend class Presentation [friend]
 

Definition at line 99 of file SoundEngine.h.


The documentation for this class was generated from the following file:
Razor! Engine Developer's Guide. Copyright © by Tilo Christ. All Rights Reserved. Last updated: 31 May 2003