ScummVM API documentation
Scumm::Player_V3A Class Reference

#include <player_v3a.h>

Inheritance diagram for Scumm::Player_V3A:
Scumm::MusicEngine Audio::Paula Common::Serializable

Public Member Functions

 Player_V3A (ScummEngine *scumm, Audio::Mixer *mixer)
 
void setMusicVolume (int vol) override
 
void startSound (int sound) override
 
void stopSound (int sound) override
 
void stopAllSounds () override
 
int getSoundStatus (int sound) const override
 
int getMusicTimer () override
 
- 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 ()
 

Protected Member Functions

void interrupt () override
 
void interruptChannel (byte channel) override
 

Detailed Description

Scumm V3 Amiga sound/music driver.

Member Function Documentation

◆ setMusicVolume()

void Scumm::Player_V3A::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_V3A::startSound ( int  sound)
overridevirtual

Start playing the sound with the given id.

Parameters
soundthe sound to start

Implements Scumm::MusicEngine.

◆ stopSound()

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

Stop playing the sound with the given id.

Parameters
soundthe sound to stop

Implements Scumm::MusicEngine.

◆ stopAllSounds()

void Scumm::Player_V3A::stopAllSounds ( )
overridevirtual

Start playing all currently playing sounds.

Implements Scumm::MusicEngine.

◆ getSoundStatus()

int Scumm::Player_V3A::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.

◆ getMusicTimer()

int Scumm::Player_V3A::getMusicTimer ( )
overridevirtual

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

Returns
the music timer

Reimplemented from Scumm::MusicEngine.


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