Recent Changes - Search:

Documentation

Help

Tutorials

RoadMap

Help Docs for wiki writers:

PmWiki

edit SideBar

SetAndPlayBackGroundMusic

bool SetAndPlayBackGroundMusic(
std::string _NameOfAudio,
int _NumberOfTimesToLoop,
int _Volume,
int _ms
)

Public function of the Epee Engine Class

Description:
plays a sound file

Note about using this funtion
a pointer is saved to the loaded file and can be assessed with the flowing functions
StopBackGroundMusic and IsBackGoundMusicPlaying
This is NOT added to the sound list.
You can only have one music file loaded and playing at a time
if the function is called again the current playing music is stop.
A Sound object and music and play at the same time

Arguments:

Required:
std::string _NameOfAudio
name of audio file to play
int _NumberOfTimesToLoop
number of times to play

Optional:
int _Volume
volume to play the music at
defaults to MIX_MAX_VOLUME

int _ms
time in milliseconds to fade in the music
defaults to 0

Return Value:
returns true on successes, false otherwise

Edit - History - Print - Recent Changes - Search
Page last modified on April 04, 2007, at 05:25 PM