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

SoundEngine Class Reference

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

#include <SoundEngine.h>

Collaboration diagram for SoundEngine:

Collaboration graph

[legend]
List of all members.

Static Public Methods

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

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. More...

void stopSong ()
 Stop the currently playing song. More...

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


Friends

class  Presentation

Detailed Description

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

Definition at line 62 of file SoundEngine.h.


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

Definition at line 49 of file SoundEngine.cpp.

Referenced by DemoActionEngine::nextPeriod().

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

Definition at line 58 of file SoundEngine.cpp.

Referenced by DemoActionEngine::restart().

void SoundEngine::stopSong ( ) [static]
 

Stop the currently playing song.

Definition at line 67 of file SoundEngine.cpp.

void SoundEngine::timeTick ( ) [static]
 

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

Definition at line 95 of file SoundEngine.cpp.

Referenced by Presentation::nextPeriod().


Friends And Related Function Documentation

class Presentation [friend]
 

Definition at line 113 of file SoundEngine.h.


The documentation for this class was generated from the following files:
Razor! Engine Developer's Guide. Copyright © by Tilo Christ. All Rights Reserved. Last updated: 4 Nov 2000