Version

    Other Documentation

menu_open
Wwise SDK 2019.2.15

◆ QueryBufferingStatus()

virtual AKRESULT AK::IAkAutoStream::QueryBufferingStatus ( AkUInt32 out_uNumBytesAvailable )
pure virtual

Get the amount of buffering that the stream has. The buffering is defined as the number of bytes that the stream has buffered, excluding the number of bytes that is currently granted to the user (with GetBuffer()).

Remarks
The returned value corresponds to the buffering status at that moment, and does not even guarantee that it will not shrink.
Returns
  • AK_DataReady: Some data has been buffered (out_uNumBytesAvailable is greater than 0).
  • AK_NoDataReady: No data is available, and the end of file has not been reached.
  • AK_NoMoreData: Some or no data is available, but the end of file has been reached. The stream will not buffer any more data.
  • AK_Fail: The stream is invalid due to an I/O error.
Parameters
out_uNumBytesAvailable Number of bytes available in the stream's buffer(s).

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise