Table of Contents

Wwise SDK 2019.1.5
AK::StreamMgr::IAkIOHookDeferred Class Referenceabstract
Inheritance diagram for AK::StreamMgr::IAkIOHookDeferred:
AK::StreamMgr::IAkLowLevelIOHook

Public Member Functions

virtual AKRESULT  Read (AkFileDesc &in_fileDesc, const AkIoHeuristics &in_heuristics, AkAsyncIOTransferInfo &io_transferInfo)=0
 
virtual AKRESULT  Write (AkFileDesc &in_fileDesc, const AkIoHeuristics &in_heuristics, AkAsyncIOTransferInfo &io_transferInfo)=0
 
virtual void  Cancel (AkFileDesc &in_fileDesc, AkAsyncIOTransferInfo &io_transferInfo, bool &io_bCancelAllTransfersForThisFile)=0
 
- Public Member Functions inherited from AK::StreamMgr::IAkLowLevelIOHook
virtual AKRESULT  Close (AkFileDesc &in_fileDesc)=0
 
virtual AkUInt32  GetBlockSize (AkFileDesc &in_fileDesc)=0
 
virtual void  GetDeviceDesc (AkDeviceDesc &out_deviceDesc)=0
 
virtual AkUInt32  GetDeviceData ()=0
 

Protected Member Functions

virtual  ~IAkIOHookDeferred ()
  Virtual destructor on interface to avoid warnings. More...
 
- Protected Member Functions inherited from AK::StreamMgr::IAkLowLevelIOHook
virtual  ~IAkLowLevelIOHook ()
  Virtual destructor on interface to avoid warnings. More...
 

Detailed Description

Interface for deferred low-level I/O transfers. Used by streaming devices created with the AK_SCHEDULER_DEFERRED_LINED_UP flag. This I/O transfer handshaking method is preferred when you want to hook I/O to your own I/O streaming technology. You will receive up to AkDeviceSettings::uMaxConcurrentIO requests at the same time. You may queue them into your own system, and even use the heuristics passed down to this level for your convenience. Note that the requests are always sent in the order that the Stream Manager considers to be the most appropriate. You may receive less than AkDeviceSettings::uMaxConcurrentIO at any given time. The number of concurrent transfers depends on the number of streams running in the high-level streaming device, and on its target buffering length and granularity. Your advantage at this level is to be aware of file placement, so you may try to re-order requests in order to minimize seeking on disk. Calls to Read()/Write() should return as soon as possible. You need to call AkAsyncIOTransferInfo::pCallback as soon as a transfer is completed. Cancel() is provided in order to inform you that the streaming device will flush this transfer upon completion. You may implement it or not. In all cases, you must call the callback.

Definition at line 290 of file AkStreamMgrModule.h.


The documentation for this class was generated from the following file: