ScummVM API documentation
Public Member Functions | Protected Attributes | List of all members
Ultima::Nuvie::PCSpeakerSweepFreqStream Class Reference
Inheritance diagram for Ultima::Nuvie::PCSpeakerSweepFreqStream:
Ultima::Nuvie::PCSpeakerStream Audio::RewindableAudioStream Audio::AudioStream

Public Member Functions

 PCSpeakerSweepFreqStream (uint start, uint end, uint16 d, uint16 s)
 
uint32 getLengthInMsec ()
 
int readBuffer (sint16 *buffer, const int numSamples) override
 
- Public Member Functions inherited from Ultima::Nuvie::PCSpeakerStream
bool isStereo () const override
 
int getRate () const override
 
bool endOfData () const override
 
bool rewind () override
 
- Public Member Functions inherited from Audio::AudioStream
virtual bool endOfStream () const
 

Protected Attributes

uint32 start_freq
 
uint32 finish_freq
 
uint32 cur_freq
 
uint16 duration
 
uint16 stepping
 
uint32 freq_step
 
float samples_per_step
 
float sample_pos
 
uint32 total_samples_played
 
uint32 num_steps
 
uint32 cur_step
 
- Protected Attributes inherited from Ultima::Nuvie::PCSpeakerStream
PCSpeaker * pcspkr
 
bool finished
 

Member Function Documentation

◆ readBuffer()

int Ultima::Nuvie::PCSpeakerSweepFreqStream::readBuffer ( sint16 *  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.

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