Version

menu_open
Wwise SDK 2019.2.15

◆ Read()

virtual AKRESULT AK::StreamMgr::IAkIOHookBlocking::Read ( AkFileDesc in_fileDesc,
const AkIoHeuristics in_heuristics,
void *  out_pBuffer,
AkIOTransferInfo in_transferInfo 
)
pure virtual

Reads data from a file (synchronous). Read data from the file described by in_fileDesc, in address out_pBuffer and with size and position passed within io_transferInfo. When transfer is complete, return with the proper return code.

Remarks
File position passed in io_transferInfo takes the offset of this file relative to AkFileDesc::hFile (described with AkFileDesc::uSector). It is computed by the high-level device as "in_fileDesc.uSector * Block_Size + Stream_Position", where Block_Size is obtained via AK::StreamMgr::IAkLowLevelIOHook::GetBlockSize().
Returns
  • AK_Success: transfer was successful and out_pBuffer is filled with data.
  • AK_Fail: an error occured.
Parameters
in_fileDesc File descriptor.
in_heuristics Heuristics for this data transfer.
out_pBuffer Buffer to be filled with data.
in_transferInfo Synchronous data transfer info.

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