ScummVM API documentation
Scumm::Player_V2CMS Class Reference

#include <player_v2cms.h>

Inheritance diagram for Scumm::Player_V2CMS:
Scumm::Player_V2Base Scumm::MusicEngine Common::Serializable

Public Member Functions

 Player_V2CMS (ScummEngine *scumm)
 
void setMusicVolume (int vol) override
 
void startSound (int sound) override
 
void stopSound (int sound) override
 
void stopAllSounds () override
 
int getMusicTimer () override
 
int getSoundStatus (int sound) const override
 
void onTimer ()
 
- Public Member Functions inherited from Scumm::Player_V2Base
 Player_V2Base (ScummEngine *scumm, bool pcjr)
 
- Public Member Functions inherited from Scumm::MusicEngine
virtual void setSfxVolume (int vol)
 
virtual void startSoundWithTrackID (int sound, int track)
 
virtual void setQuality (int qual)
 
void saveLoadWithSerializer (Common::Serializer &ser) override
 
virtual void restoreAfterLoad ()
 

Additional Inherited Members

- Protected Member Functions inherited from Scumm::Player_V2Base
virtual void nextTick ()
 
virtual void clear_channel (int i)
 
virtual void chainSound (int nr, byte *data)
 
virtual void chainNextSound ()
 
void execute_cmd (ChannelInfo *channel)
 
void next_freqs (ChannelInfo *channel)
 
- Protected Attributes inherited from Scumm::Player_V2Base
bool _isV3Game
 
ScummEngine_vm
 
bool _pcjr
 
int _header_len
 
int _current_nr
 
byte * _current_data
 
int _next_nr
 
byte * _next_data
 
byte * _retaddr
 
ChannelInfo _channels [5]
 

Detailed Description

Scumm V2 CMS/Gameblaster MIDI driver.

Member Function Documentation

◆ setMusicVolume()

void Scumm::Player_V2CMS::setMusicVolume ( int  vol)
overridevirtual

Set the output volume for music. Also used, if the inheriting class doesn't distinguish between music and sfx.

Parameters
volthe new output volume

Implements Scumm::MusicEngine.

◆ startSound()

void Scumm::Player_V2CMS::startSound ( int  sound)
overridevirtual

Start playing the sound with the given id.

Parameters
soundthe sound to start

Implements Scumm::MusicEngine.

◆ stopSound()

void Scumm::Player_V2CMS::stopSound ( int  sound)
overridevirtual

Stop playing the sound with the given id.

Parameters
soundthe sound to stop

Implements Scumm::MusicEngine.

◆ stopAllSounds()

void Scumm::Player_V2CMS::stopAllSounds ( )
overridevirtual

Start playing all currently playing sounds.

Implements Scumm::MusicEngine.

◆ getMusicTimer()

int Scumm::Player_V2CMS::getMusicTimer ( )
overridevirtual

Get the value of the music timer. Used for synchronising scripts with the music/sound.

Returns
the music timer

Reimplemented from Scumm::Player_V2Base.

◆ getSoundStatus()

int Scumm::Player_V2CMS::getSoundStatus ( int  sound) const
overridevirtual

Query the status of the sound with the given id. Usually this is just a boolean telling us whether the sound is playing or not.

Parameters
soundthe sound to for which we want the status
Returns
the status of the specified sound

Implements Scumm::MusicEngine.


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