ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

AudioCDManager Class Reference

Abstract Audio CD manager class. More...

#include <audiocd.h>

Inheritance diagram for AudioCDManager:
Collaboration diagram for AudioCDManager:

List of all members.

Classes

struct  Status
 A structure containing the current playback information. More...

Public Member Functions

virtual ~AudioCDManager ()
virtual bool open ()=0
 Initialize the specified CD drive for audio playback.
virtual void close ()=0
 Close the currently open CD drive.
virtual bool play (int track, int numLoops, int startFrame, int duration, bool onlyEmulate=false, Audio::Mixer::SoundType soundType=Audio::Mixer::kMusicSoundType)=0
 Start audio CD playback.
virtual bool isPlaying () const =0
 Get if audio is being played.
virtual void setVolume (byte volume)=0
 Set the audio volume.
virtual void setBalance (int8 balance)=0
 Set the speakers balance.
virtual void stop ()=0
 Stop audio playback.
virtual void update ()=0
 Update audio status.
virtual Status getStatus () const =0
 Get the playback status.

Detailed Description

Abstract Audio CD manager class.

Subclasses implement the actual functionality.

Definition at line 34 of file audiocd.h.


Constructor & Destructor Documentation

virtual AudioCDManager::~AudioCDManager (  )  [inline, virtual]

Definition at line 36 of file audiocd.h.


Member Function Documentation

virtual void AudioCDManager::close (  )  [pure virtual]

Close the currently open CD drive.

Implemented in DefaultAudioCDManager, and SdlAudioCDManager.

virtual Status AudioCDManager::getStatus (  )  const [pure virtual]

Get the playback status.

Returns:
a Status struct with playback data.

Implemented in DefaultAudioCDManager.

virtual bool AudioCDManager::isPlaying (  )  const [pure virtual]

Get if audio is being played.

Returns:
true if CD audio is playing

Implemented in DefaultAudioCDManager, and SdlAudioCDManager.

virtual bool AudioCDManager::open (  )  [pure virtual]

Initialize the specified CD drive for audio playback.

Returns:
true if the CD drive was inited successfully

Implemented in DefaultAudioCDManager, and SdlAudioCDManager.

virtual bool AudioCDManager::play ( int  track,
int  numLoops,
int  startFrame,
int  duration,
bool  onlyEmulate = false,
Audio::Mixer::SoundType  soundType = Audio::Mixer::kMusicSoundType 
) [pure virtual]

Start audio CD playback.

Parameters:
track the track to play.
numLoops how often playback should be repeated (<=0 means infinitely often).
startFrame the frame at which playback should start (75 frames = 1 second).
duration the number of frames to play.
onlyEmulate determines if the track should be emulated only
soundType What 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

Implemented in DefaultAudioCDManager, and SdlAudioCDManager.

virtual void AudioCDManager::setBalance ( int8  balance  )  [pure virtual]

Set the speakers balance.

Implemented in DefaultAudioCDManager.

virtual void AudioCDManager::setVolume ( byte  volume  )  [pure virtual]

Set the audio volume.

Implemented in DefaultAudioCDManager.

virtual void AudioCDManager::stop (  )  [pure virtual]

Stop audio playback.

Implemented in DefaultAudioCDManager, and SdlAudioCDManager.

virtual void AudioCDManager::update (  )  [pure virtual]

Update audio status.

Implemented in DefaultAudioCDManager, and SdlAudioCDManager.


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


Generated on Sat May 18 2019 05:04:45 for ResidualVM by doxygen 1.7.1
curved edge   curved edge