Version

menu_open
Wwise SDK 2023.1.4

◆ Read()

virtual AKRESULT AK::IAkStdStream::Read ( void *  in_pBuffer,
AkUInt32  in_uReqSize,
bool  in_bWait,
AkPriority  in_priority,
AkReal32  in_fDeadline,
AkUInt32 out_uSize 
)
pure virtual

Schedule a read request.

Warning
Use only with a multiple of the block size, queried via AK::IAkStdStream::GetBlockSize().
Remarks
If the call is asynchronous (in_bWait = false), wait until AK::IAkStdStream::GetStatus() stops returning AK_StmStatusPending.
Returns
AK_Success if the operation was successfully scheduled (but not necessarily completed)
See also
Parameters
in_pBufferUser buffer address
in_uReqSizeRequested read size
in_bWaitBlock until the operation is complete
in_priorityHeuristic: operation priority
in_fDeadlineHeuristic: operation deadline (ms)
out_uSizeThe size that was actually read

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