libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2024-12-13 12:39:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarify the AudioStream::readSample requirements

Browse Source 
svn-id: r18844
This commit is contained in:
Max Horn 2005-09-18 14:49:54 +00:00
parent 6a420f524e
commit 7aa398a9d0
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
sound/audiostream.h
View File

@ -40,8 +40,13 @@ public:
* a critical error occured (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.
* 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.
*/
virtual int readBuffer(int16 *buffer, const int numSamples) = 0;