ScummVM API documentation
Sherlock::Sound Class Reference

Public Member Functions

 Sound (SherlockEngine *vm, Audio::Mixer *mixer)
 
void syncSoundSettings ()
 
void loadSound (const Common::Path &name, int priority)
 
bool playSound (const Common::Path &name, WaitType waitType, int priority=100, const Common::Path &libraryFilename=Common::Path())
 
void playAiff (const Common::Path &name, int volume=Audio::Mixer::kMaxChannelVolume, bool loop=false)
 
void stopAiff ()
 
void playLoadedSound (int bufNum, WaitType waitType)
 
void freeLoadedSounds ()
 
void stopSound ()
 
void freeDigiSound ()
 
Audio::SoundHandlegetFreeSoundHandle ()
 
void setVolume (int volume)
 
void playSpeech (const Common::Path &name)
 
void stopSpeech ()
 
bool isSpeechPlaying ()
 

Public Attributes

bool _digitized
 
int _voices
 
bool _soundOn
 
bool _speechOn
 
bool _soundPlaying
 
bool _speechPlaying
 
int _soundVolume
 
Common::String _talkSoundFile
 

Member Function Documentation

◆ syncSoundSettings()

void Sherlock::Sound::syncSoundSettings ( )

Saves sound-related settings

◆ loadSound()

void Sherlock::Sound::loadSound ( const Common::Path name,
int  priority 
)

Load a sound

◆ playSound()

bool Sherlock::Sound::playSound ( const Common::Path name,
WaitType  waitType,
int  priority = 100,
const Common::Path libraryFilename = Common::Path() 
)

Play the sound in the specified resource

◆ playAiff()

void Sherlock::Sound::playAiff ( const Common::Path name,
int  volume = Audio::Mixer::kMaxChannelVolume,
bool  loop = false 
)

Play the specified AIFF file. (Used for the 3DO Scalpel intro.)

◆ stopAiff()

void Sherlock::Sound::stopAiff ( )

Stop the AIFF sound that was started with playAiff().

◆ playLoadedSound()

void Sherlock::Sound::playLoadedSound ( int  bufNum,
WaitType  waitType 
)

Play a previously loaded sound

◆ freeLoadedSounds()

void Sherlock::Sound::freeLoadedSounds ( )

Free any previously loaded sounds

◆ stopSound()

void Sherlock::Sound::stopSound ( )

Stop playing any active sound

◆ getFreeSoundHandle()

Audio::SoundHandle& Sherlock::Sound::getFreeSoundHandle ( )

Return a sound handle to use

◆ setVolume()

void Sherlock::Sound::setVolume ( int  volume)

Set the volume

◆ playSpeech()

void Sherlock::Sound::playSpeech ( const Common::Path name)

Play a specified voice resource

◆ stopSpeech()

void Sherlock::Sound::stopSpeech ( )

Stop any currently playing speech

◆ isSpeechPlaying()

bool Sherlock::Sound::isSpeechPlaying ( )

Returns true if speech is currently playing


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