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

Video::SilentAudioStream Class Reference

An AudioStream that just returns silent samples and runs infinitely. More...

Inheritance diagram for Video::SilentAudioStream:
Collaboration diagram for Video::SilentAudioStream:

List of all members.

Public Member Functions

 SilentAudioStream (int rate, bool stereo)
int readBuffer (int16 *buffer, const int numSamples)
 Fill the given buffer with up to numSamples samples.
bool endOfData () const
 End of data reached? If this returns true, it means that at this time there is no data available in the stream.
bool isStereo () const
 Is this a stereo stream?
int getRate () const
 Sample rate of the stream.

Private Attributes

int _rate
bool _isStereo

Detailed Description

An AudioStream that just returns silent samples and runs infinitely.

Definition at line 341 of file bink_decoder.cpp.


Constructor & Destructor Documentation

Video::SilentAudioStream::SilentAudioStream ( int  rate,
bool  stereo 
) [inline]

Definition at line 343 of file bink_decoder.cpp.


Member Function Documentation

bool Video::SilentAudioStream::endOfData (  )  const [inline, virtual]

End of data reached? If this returns true, it means that at this time there is no data available in the stream.

However there may be more data in the future. This is used by e.g. a rate converter to decide whether to keep on converting data or stop.

Implements Audio::AudioStream.

Definition at line 350 of file bink_decoder.cpp.

int Video::SilentAudioStream::getRate (  )  const [inline, virtual]

Sample rate of the stream.

Implements Audio::AudioStream.

Definition at line 352 of file bink_decoder.cpp.

bool Video::SilentAudioStream::isStereo (  )  const [inline, virtual]

Is this a stereo stream?

Implements Audio::AudioStream.

Definition at line 351 of file bink_decoder.cpp.

int Video::SilentAudioStream::readBuffer ( int16 buffer,
const int  numSamples 
) [inline, virtual]

Fill the given buffer with up to numSamples samples.

Returns the actual number of samples read, or -1 if a critical error occurred (note: you *must* check if this value is less than what you requested, this can happen when the stream is fully used up).

Data has to be in native endianess, 16 bit per sample, signed. For stereo stream, buffer will be filled with interleaved left and right channel samples, starting with a 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.

Implements Audio::AudioStream.

Definition at line 345 of file bink_decoder.cpp.


Member Data Documentation

Definition at line 356 of file bink_decoder.cpp.

Definition at line 355 of file bink_decoder.cpp.


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


Generated on Sat Aug 17 2019 05:03:43 for ResidualVM by doxygen 1.7.1
curved edge   curved edge