Version

menu_open
Wwise SDK 2023.1.5

◆ GetBuffer()

virtual AKRESULT AK::IAkAutoStream::GetBuffer ( void *&  out_pBuffer,
AkUInt32 out_uSize,
bool  in_bWait 
)
pure virtual

Get data from the Stream Manager buffers.

Remarks
Grants a buffer if data is available. Each successful call to this method returns a new buffer of data, at the current stream position. Buffers should be released as soon as they are not needed, using AK::IAkAutoStream::ReleaseBuffer().
Note: AK::IAkAutoStream::ReleaseBuffer() does not take any argument, because it releases buffers in order.
Returns
  • AK_DataReady : the buffer was granted
  • AK_NoDataReady : the buffer is not granted yet (never happens when called with in_bWait flag)
  • AK_NoMoreData : the buffer was granted but reached end of file (next call will return with size 0)
  • AK_Fail : there was an I/O error
See also
Parameters
out_pBufferReturned address of granted data space
out_uSizeReturned size of granted data space
in_bWaitBlock until data is ready

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