MTropolis::AudioPlayer Class Reference

Inheritance diagram for MTropolis::AudioPlayer:

Public Member Functions
	AudioPlayer (Audio::Mixer *mixer, byte volume, int8 balance, const Common::SharedPtr< AudioMetadata > &metadata, const Common::SharedPtr< CachedAudio > &audio, bool isLooping, size_t currentPos, size_t startPos, size_t endPos)
int	readBuffer (int16 *buffer, const int numSamples) override
bool	isStereo () const override
int	getRate () const override
bool	endOfData () const override
void	sendToMixer (Audio::Mixer *mixer, byte volume, int8 balance)
void	stop ()
Public Member Functions inherited from Audio::AudioStream
virtual bool	endOfStream () const

Member Function Documentation

readBuffer()

int MTropolis::AudioPlayer::readBuffer ( int16 *  buffer, const int  numSamples  )

overridevirtual

Fill the given buffer with up to numSamples samples.

Data must be in native endianness, 16 bits per sample, signed. For stereo stream, the buffer will be filled with interleaved left and right channel samples, starting with the left sample. Furthermore, the samples in the left and right are summed up. So if you request 4 samples from a stereo stream, you will get a total of two left channel and two right channel samples.

Returns

The actual number of samples read, or -1 if a critical error occurred.

Note

You must check whether the returned value is less than what you requested. This indicates that the stream is fully used up.

Implements Audio::AudioStream.

isStereo()

bool MTropolis::AudioPlayer::isStereo ( ) const

overridevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

getRate()

int MTropolis::AudioPlayer::getRate ( ) const

overridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

endOfData()

bool MTropolis::AudioPlayer::endOfData ( ) const

overridevirtual

Check whether end of data has been reached.

If this returns true, it indicates that at this time there is no data available in the stream. However, there might be more data in the future.

This is used by e.g. a rate converter to decide whether to keep on converting data or to stop.

Implements Audio::AudioStream.

---

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

• engines/mtropolis/audio_player.h