Table of Contents

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_pBuffer  User buffer address
in_uReqSize  Requested read size
in_bWait  Block until the operation is complete
in_priority  Heuristic: operation priority
in_fDeadline  Heuristic: operation deadline (ms)
out_uSize  The size that was actually read