ScummVM API documentation
Classes | Public Member Functions | Protected Member Functions | List of all members
AtariAudioCDManager Class Referencefinal

#include <atari-audiocd.h>

Inheritance diagram for AtariAudioCDManager:
DefaultAudioCDManager AudioCDManager Common::NonCopyable

Public Member Functions

bool open () override
 
void close () override
 
bool play (int track, int numLoops, int startFrame, int duration, bool onlyEmulate, Audio::Mixer::SoundType soundType) override
 
void stop () override
 
bool isPlaying () const override
 
void update () override
 
bool existExtractedCDAudioFiles (uint track) override
 
- Public Member Functions inherited from DefaultAudioCDManager
bool open () override
 
void close () override
 
bool play (int track, int numLoops, int startFrame, int duration, bool onlyEmulate=false, Audio::Mixer::SoundType soundType=Audio::Mixer::kMusicSoundType) override
 
bool playAbsolute (int startFrame, int numLoops, int duration, bool onlyEmulate=false, Audio::Mixer::SoundType soundType=Audio::Mixer::kMusicSoundType, const char *cuesheet="disc.cue") override
 
void stop () override
 
bool isPlaying () const override
 
void setVolume (byte volume) override
 
void setBalance (int8 balance) override
 
void update () override
 
Status getStatus () const override
 
bool existExtractedCDAudioFiles (uint track) override
 
bool isDataAndCDAudioReadFromSameCD () override
 

Protected Member Functions

bool openCD (int drive) override
 
- Protected Member Functions inherited from DefaultAudioCDManager
bool openRealCD ()
 
virtual bool openCD (const Common::Path &drive)
 

Additional Inherited Members

- Protected Attributes inherited from DefaultAudioCDManager
Audio::SoundHandle _handle
 
bool _emulating
 
Status _cd
 
Audio::Mixer * _mixer
 

Detailed Description

The Atari MetaDOS audio cd manager. Implements real audio cd playback via the MetaDOS BOS drivers.

Member Function Documentation

◆ open()

bool AtariAudioCDManager::open ( )
overridevirtual

Initialize the specified CD drive for audio playback.

Returns
true if the CD drive was inited successfully

Implements AudioCDManager.

◆ close()

void AtariAudioCDManager::close ( )
overridevirtual

Close the currently open CD drive

Implements AudioCDManager.

◆ play()

bool AtariAudioCDManager::play ( int  track,
int  numLoops,
int  startFrame,
int  duration,
bool  onlyEmulate,
Audio::Mixer::SoundType  soundType 
)
overridevirtual

Start audio CD playback

Parameters
trackthe track to play.
numLoopshow often playback should be repeated (<=0 means infinitely often).
startFramethe frame at which playback should start (75 frames = 1 second).
durationthe number of frames to play.
onlyEmulatedetermines if the track should be emulated only
soundTypeWhat sound type to play as. By default, it's as music
Note
The onlyEmulate parameter is deprecated.
Returns
true if the track started playing, false otherwise

Implements AudioCDManager.

◆ stop()

void AtariAudioCDManager::stop ( )
overridevirtual

Stop audio playback.

Implements AudioCDManager.

◆ isPlaying()

bool AtariAudioCDManager::isPlaying ( ) const
overridevirtual

Get if audio is being played.

Returns
true if CD audio is playing

Implements AudioCDManager.

◆ update()

void AtariAudioCDManager::update ( )
overridevirtual

Update audio status.

Implements AudioCDManager.

◆ existExtractedCDAudioFiles()

bool AtariAudioCDManager::existExtractedCDAudioFiles ( uint  track)
overridevirtual

Checks whether the extracted audio cd tracks exists as files in the search paths.

Returns
true if audio files of the expected naming scheme are found, and supported by ScummVM.

Implements AudioCDManager.

◆ openCD()

bool AtariAudioCDManager::openCD ( int  drive)
overrideprotectedvirtual

Open a CD using the specified drive index

Parameters
driveThe index of the drive
Note
The index is implementation-defined, but 0 is always the best choice

Reimplemented from DefaultAudioCDManager.

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