◆ Read()

virtual AKRESULT AK::StreamMgr::IAkIOHookDeferred::Read	(	AkFileDesc &	in_fileDesc,
		const AkIoHeuristics &	in_heuristics,
		AkAsyncIOTransferInfo &	io_transferInfo
	)

pure virtual

Reads data from a file (asynchronous).

Remarks

Queue up your read request with address, size and file position specified in io_transferInfo.
When transfer is complete (whether it was successful, cancelled or failed), call AkAsyncIOTransferInfo::pCallback. However, if you return AK_Fail() from Read(), do not call AkAsyncIOTransferInfo::pCallback.
AkAsyncIOTransferInfo::pCookie must be passed to the callback function as-is. It must not be changed by the Low-Level I/O.
The reference to io_transferInfo will be valid until the high-level device is notified through the callback.
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: An I/O request was successfully dispatched and is pending: AkAsyncIOTransferInfo::pCallback must be called when it completes.
AK_Fail: An error occurred, no I/O request was dispatched

Parameters

in_fileDesc	File descriptor.
in_heuristics	Heuristics for this data transfer.
io_transferInfo	Asynchronous data transfer info.

Referenced by BatchRead().

Wwise SDK