ScummVM API documentation
Kyra::SoundDigital_MR Class Reference

#include <sound_digital_mr.h>

Public Member Functions

 SoundDigital_MR (KyraEngine_MR *vm, Audio::Mixer *mixer)
 
int playSound (const char *filename, uint8 priority, Audio::Mixer::SoundType type, int volume=255, bool loop=false, int channel=-1)
 
bool isPlaying (int channel)
 
void stopSound (int channel)
 
void stopAllSounds ()
 
void beginFadeOut (int channel, int ticks)
 

Detailed Description

Digital audio output device.

This is just used for Kyrandia 3.

Member Function Documentation

◆ playSound()

int Kyra::SoundDigital_MR::playSound ( const char *  filename,
uint8  priority,
Audio::Mixer::SoundType  type,
int  volume = 255,
bool  loop = false,
int  channel = -1 
)

Plays a sound.

Parameters
filenamefile to be played
prioritypriority of the sound
typetype
volumechannel volume
looptrue if the sound should loop (endlessly)
channeltell the sound player to use a specific channel for playback
Returns
channel playing the sound

◆ isPlaying()

bool Kyra::SoundDigital_MR::isPlaying ( int  channel)

Checks if a given channel is playing a sound.

Parameters
channelchannel number to check
Returns
true if playing, else false

◆ stopSound()

void Kyra::SoundDigital_MR::stopSound ( int  channel)

Stop the playback of a sound in the given channel.

Parameters
channelchannel number

◆ stopAllSounds()

void Kyra::SoundDigital_MR::stopAllSounds ( )

Stops playback of all sounds.

◆ beginFadeOut()

void Kyra::SoundDigital_MR::beginFadeOut ( int  channel,
int  ticks 
)

Makes the sound in a given channel fading out.

Parameters
channelchannel number
ticksfadeout time

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