ScummVM API documentation
Ultima::Ultima8::MidiPlayer Class Reference

Public Member Functions

void load (byte *data, size_t size, int seqNo)
 
void loadTransitionData (byte *data, size_t size)
 
void play (int trackNo, int branchNo)
 
void playTransition (int trackNo, bool overlay)
 
void stop ()
 
void pause (bool pause)
 
bool isPlaying ()
 
void startFadeOut (uint16 length)
 
bool isFading ()
 
void syncSoundSettings ()
 
void setLooping (bool loop)
 
bool hasBranchIndex (uint8 index)
 
bool isFMSynth () const
 
byte getSequenceCallbackData (int seq) const
 
void onTimer ()
 

Static Public Member Functions

static void xmidiCallback (byte eventData, void *data)
 
static void timerCallback (void *data)
 

Member Function Documentation

◆ load()

void Ultima::Ultima8::MidiPlayer::load ( byte *  data,
size_t  size,
int  seqNo 
)

Load the specified music data

◆ loadTransitionData()

void Ultima::Ultima8::MidiPlayer::loadTransitionData ( byte *  data,
size_t  size 
)

Load the XMIDI data containing the transition tracks. Call this function before calling playTransition.

◆ play()

void Ultima::Ultima8::MidiPlayer::play ( int  trackNo,
int  branchNo 
)

Play the specified music track, starting at the specified branch. Use branchNo -1 to start from the beginning.

◆ playTransition()

void Ultima::Ultima8::MidiPlayer::playTransition ( int  trackNo,
bool  overlay 
)

Plays the specified transition track. If overlay is specified, the transition is overlaid on the currently playing music track and this track is stopped when the transition ends. If overlay is not specified, the currently playing music track is stopped before the transition is started.

◆ stop()

void Ultima::Ultima8::MidiPlayer::stop ( )

Stop the currently playing track.

◆ pause()

void Ultima::Ultima8::MidiPlayer::pause ( bool  pause)

Pause or resume playback of the current track.

◆ isPlaying()

bool Ultima::Ultima8::MidiPlayer::isPlaying ( )

Returns true if a track is playing.

◆ startFadeOut()

void Ultima::Ultima8::MidiPlayer::startFadeOut ( uint16  length)

Starts a fade-out of the specified duration (in milliseconds).

◆ isFading()

bool Ultima::Ultima8::MidiPlayer::isFading ( )

Returns true if the music is currently fading.

◆ syncSoundSettings()

void Ultima::Ultima8::MidiPlayer::syncSoundSettings ( )

Synchronizes the user volume settings with those of the game.

◆ setLooping()

void Ultima::Ultima8::MidiPlayer::setLooping ( bool  loop)

Sets whether the music should loop

◆ hasBranchIndex()

bool Ultima::Ultima8::MidiPlayer::hasBranchIndex ( uint8  index)

Returns true if the current music track has a branch defined for the specified index.


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