ScummVM API documentation
Public Member Functions | List of all members
Sword2::MusicInputStream Class Reference
Inheritance diagram for Sword2::MusicInputStream:
Audio::AudioStream

Public Member Functions

 MusicInputStream (int cd, SoundFileHandle *fh, uint32 musicId, bool looping)
 
int readBuffer (int16 *buffer, const int numSamples) override
 
bool endOfData () const override
 
bool isStereo () const override
 
int getRate () const override
 
int getCD ()
 
void fadeUp ()
 
void fadeDown ()
 
bool isReady ()
 
int32 isFading ()
 
bool readyToRemove ()
 
int32 getTimeRemaining ()
 
- Public Member Functions inherited from Audio::AudioStream
virtual bool endOfStream () const
 

Member Function Documentation

◆ readBuffer()

int Sword2::MusicInputStream::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.

◆ endOfData()

bool Sword2::MusicInputStream::endOfData ( ) const
inlineoverridevirtual

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.

◆ isStereo()

bool Sword2::MusicInputStream::isStereo ( ) const
inlineoverridevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

◆ getRate()

int Sword2::MusicInputStream::getRate ( ) const
inlineoverridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

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