ScummVM API documentation
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Scumm::IMuse Class Referenceabstract

#include <imuse.h>

Inheritance diagram for Scumm::IMuse:
Scumm::MusicEngine Common::Serializable Scumm::IMuseInternal

Public Types

enum  {
  PROP_TEMPO_BASE, PROP_LIMIT_PLAYERS, PROP_RECYCLE_PLAYERS, PROP_QUALITY,
  PROP_MUSICVOLUME, PROP_SFXVOLUME
}
 

Public Member Functions

virtual void on_timer (MidiDriver *midi)=0
 
virtual void pause (bool paused)=0
 
virtual void saveLoadIMuse (Common::Serializer &ser, ScummEngine *scumm, bool fixAfterLoad=true)=0
 
virtual bool get_sound_active (int sound) const =0
 
virtual int32 doCommand (int numargs, int args[])=0
 
virtual int clear_queue ()=0
 
virtual uint32 property (int prop, uint32 value)=0
 
virtual void addSysexHandler (byte mfgID, sysexfunc handler)=0
 
virtual void startSoundWithNoteOffset (int sound, int offset)=0
 
void setQuality (int qual) override
 
- Public Member Functions inherited from Scumm::MusicEngine
virtual void setMusicVolume (int vol)=0
 
virtual void setSfxVolume (int vol)
 
virtual void startSound (int sound)=0
 
virtual void startSoundWithTrackID (int sound, int track)
 
virtual void stopSound (int sound)=0
 
virtual void stopAllSounds ()=0
 
virtual int getSoundStatus (int sound) const =0
 
virtual int getMusicTimer ()
 
virtual void toggleMusic (bool enable)
 
virtual void toggleSoundEffects (bool enable)
 
void saveLoadWithSerializer (Common::Serializer &ser) override
 
virtual void restoreAfterLoad ()
 

Static Public Member Functions

static IMuse * create (ScummEngine *vm, MidiDriver *nativeMidiDriver, MidiDriver *adlibMidiDriver, MidiDriverFlags sndType, bool nativeMT32)
 

Detailed Description

iMuse implementation interface. MusicEngine derivative for state-tracked, interactive, persistent event-based music playback and control. This class serves as an interface to actual implementations so that client code is not exposed to the details of any specific implementation.

Member Function Documentation

◆ setQuality()

void Scumm::IMuse::setQuality ( int  qual)
inlineoverridevirtual

Set sound quality if applicable (used for Macintosh sound)

Parameters
qualquality setting (range and meaning are specific to the respective player)

Reimplemented from Scumm::MusicEngine.

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