AUDIO: Clarify the return value of Mixer::getOutputBufSize()

This commit is contained in:
Cameron Cawley 2024-06-03 18:44:15 +01:00
parent 065279d313
commit bd124e2956

View File

@ -338,6 +338,10 @@ public:
/**
* Return the output sample buffer size of the system.
*
* The return value is measured in frame units instead of bytes. It can be converted
* to bytes by multiplying it with the sample size and the number of channels. For
* example, for 16-bit stereo output it should be multiplied by 4.
*
* @return The number of samples processed at each audio callback.
*/
virtual uint getOutputBufSize() const = 0;