Kyra::SoundTownsPC98_v2 Class Reference

Inheritance diagram for Kyra::SoundTownsPC98_v2:

Public Member Functions
	SoundTownsPC98_v2 (KyraEngine_v1 *vm, Audio::Mixer *mixer)
kType	getMusicType () const override
bool	init () override
void	process () override
void	initAudioResourceInfo (int set, void *info) override
void	selectAudioResourceSet (int set) override
bool	hasSoundFile (uint file) const override
void	loadSoundFile (uint file) override
void	loadSoundFile (const Common::Path &file) override
void	playTrack (uint8 track) override
void	haltTrack () override
void	beginFadeOut () override
int32	voicePlay (const char *file, Audio::SoundHandle *handle, uint8 volume=255, uint8 priority=255, bool isSfx=true) override
void	playSoundEffect (uint16 track, uint8 volume=0xFF) override
void	updateVolumeSettings () override
Public Member Functions inherited from Kyra::Sound
	Sound (KyraEngine_v1 *vm, Audio::Mixer *mixer)
virtual kType	getSfxType () const
virtual bool	useDigitalSfx () const
virtual void	unloadSoundFile (const Common::String &file)
virtual void	loadSfxFile (const Common::Path &file)
virtual void	stopAllSoundEffects ()
virtual bool	isPlaying () const
virtual void	beginFadeOut (int)
virtual void	pause (bool paused)
virtual void	enableMusic (int enable)
int	musicEnabled () const
void	enableSFX (bool enable)
bool	sfxEnabled () const
bool	isVoicePresent (const char *file) const
Audio::SeekableAudioStream *	getVoiceStream (const char *file) const
bool	playVoiceStream (Audio::AudioStream *stream, Audio::SoundHandle *handle=0, uint8 volume=255, uint8 priority=255, bool isSfx=false)
bool	voiceIsPlaying (const Audio::SoundHandle *handle=0) const
bool	allVoiceChannelsPlaying () const
uint32	voicePlayedTime (const Audio::SoundHandle &handle) const
void	voiceStop (const Audio::SoundHandle *handle=0)
virtual int	checkTrigger ()
virtual void	resetTrigger ()

Additional Inherited Members
Public Types inherited from Kyra::Sound
enum	kType {   kAdLib, kMidiMT32, kMidiGM, kTowns,   kPC98, kPCSpkr, kPCjr, kAmiga,   kSegaCD, kMac }
Protected Types inherited from Kyra::Sound
enum	{ kNumChannelHandles = 4 }
Protected Attributes inherited from Kyra::Sound
SoundChannel	_soundChannels [kNumChannelHandles]
int	_musicEnabled
bool	_sfxEnabled
KyraEngine_v1 *	_vm
Audio::Mixer *	_mixer

Member Function Documentation

init()

bool Kyra::SoundTownsPC98_v2::init ( )

overridevirtual

Initializes the output device.

Returns

true on success, else false

Implements Kyra::Sound.

process()

void Kyra::SoundTownsPC98_v2::process ( )

overridevirtual

Updates the device, this is needed for some devices.

Reimplemented from Kyra::Sound.

initAudioResourceInfo()

void Kyra::SoundTownsPC98_v2::initAudioResourceInfo ( int  set, void *  info  )

overridevirtual

Assigns static resource data with information on how to load audio resources to

Parameters

set	value defined in AudioResourceSet enum info various types of resource info data (file list, file name pattern, struct, etc. - depending on the inheriting driver type)

Implements Kyra::Sound.

selectAudioResourceSet()

void Kyra::SoundTownsPC98_v2::selectAudioResourceSet ( int  set )

overridevirtual

Select audio resource set.

Parameters

set	value defined in AudioResourceSet enum

Implements Kyra::Sound.

hasSoundFile()

bool Kyra::SoundTownsPC98_v2::hasSoundFile ( uint  file ) const

overridevirtual

Checks if a given sound file is present.

Parameters

track

track number

Returns

true if available, false otherwise

Implements Kyra::Sound.

loadSoundFile() [1/2]

void Kyra::SoundTownsPC98_v2::loadSoundFile ( uint  file )

inlineoverridevirtual

Load a specifc sound file for use of playing music and sound effects.

Implements Kyra::Sound.

loadSoundFile() [2/2]

void Kyra::SoundTownsPC98_v2::loadSoundFile ( const Common::Path &  file )

overridevirtual

Load a sound file for playing music (and sometimes sound effects) from.

Implements Kyra::Sound.

playTrack()

void Kyra::SoundTownsPC98_v2::playTrack ( uint8  track )

overridevirtual

Plays the specified track.

Parameters

track

track number

Implements Kyra::Sound.

haltTrack()

void Kyra::SoundTownsPC98_v2::haltTrack ( )

overridevirtual

Stop playback of the current track.

Implements Kyra::Sound.

beginFadeOut()

void Kyra::SoundTownsPC98_v2::beginFadeOut ( )

overridevirtual

Starts fading out the volume.

This keeps fading out the output until it is silenced, but does not change the volume set by setVolume! It will automatically reset the volume when playing a new track or sound effect.

Implements Kyra::Sound.

voicePlay()

int32 Kyra::SoundTownsPC98_v2::voicePlay ( const char *  file, Audio::SoundHandle *  handle, uint8  volume = 255, uint8  priority = 255, bool  isSfx = true  )

overridevirtual

Plays the specified voice file.

Also before starting to play the specified voice file, it stops the current voice.

Parameters

file	file to be played
volume	volume of the voice file
isSfx	marks file as sfx instead of voice
handle	store a copy of the sound handle

Returns

playtime of the voice file (-1 marks unknown playtime)

Reimplemented from Kyra::Sound.

playSoundEffect()

void Kyra::SoundTownsPC98_v2::playSoundEffect ( uint16  track, uint8  volume = 0xFF  )

overridevirtual

Plays the specified sound effect.

Parameters

track

sound effect id

Implements Kyra::Sound.

updateVolumeSettings()

void Kyra::SoundTownsPC98_v2::updateVolumeSettings ( )

overridevirtual

Updates internal volume settings according to ConfigManager.

Reimplemented from Kyra::Sound.

---

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

• engines/kyra/sound/sound_intern.h