ScummVM API documentation
Public Member Functions | List of all members
Agi::SoundGenPCJr Class Reference
Inheritance diagram for Agi::SoundGenPCJr:
Agi::SoundGen Audio::AudioStream

Public Member Functions

 SoundGenPCJr (AgiBase *vm, Audio::Mixer *pMixer)
 
void play (int resnum) override
 
void stop () override
 
int readBuffer (int16 *buffer, const int numSamples) override
 
bool isStereo () const override
 
bool endOfData () const override
 
int getRate () const override
 
- Public Member Functions inherited from Agi::SoundGen
 SoundGen (AgiBase *vm, Audio::Mixer *pMixer)
 
- Public Member Functions inherited from Audio::AudioStream
virtual bool endOfStream () const
 

Additional Inherited Members

- Public Attributes inherited from Agi::SoundGen
AgiBase * _vm
 
Audio::Mixer * _mixer
 
Audio::SoundHandle * _soundHandle
 
uint32 _sampleRate
 

Member Function Documentation

◆ readBuffer()

int Agi::SoundGenPCJr::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 Agi::SoundGenPCJr::isStereo ( ) const
inlineoverridevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

◆ endOfData()

bool Agi::SoundGenPCJr::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.

◆ getRate()

int Agi::SoundGenPCJr::getRate ( ) const
inlineoverridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

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