Version

menu_open
Wwise SDK 2021.1.14
AK::StreamMgr::IAkIOHookDeferredBatch Class Referenceabstract

#include <AkStreamMgrModule.h>

Inheritance diagram for AK::StreamMgr::IAkIOHookDeferredBatch:
AK::StreamMgr::IAkLowLevelIOHook AK::StreamMgr::IAkIOHookDeferred

Classes

struct   BatchIoTransferItem
 

Public Member Functions

virtual AKRESULT  BatchRead (AkUInt32 in_uNumTransfers, BatchIoTransferItem *in_pTransferItems, AkBatchIOCallback in_pBatchIoCallback, AKRESULT *io_pDispatchResults)=0
 
virtual AKRESULT  BatchWrite (AkUInt32 in_uNumTransfers, BatchIoTransferItem *in_pTransferItems, AkBatchIOCallback in_pBatchIoCallback, AKRESULT *io_pDispatchResults)=0
 
virtual void  BatchCancel (AkUInt32 in_uNumTransfers, BatchIoTransferItem *in_pTransferItems, bool **io_ppbCancelAllTransfersForThisFile)=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  ~IAkIOHookDeferredBatch ()
  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 batched 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, and you want to submit multiple I/O requests in one call, so as to allow for better opportunities for CPU and I/O performance. 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 BatchRead()/BatchWrite() should return as soon as possible. You need to call AkAsyncIOTransferInfo::pCallback for an individual item, or AkBatchIOCallback for a collection of items 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 305 of file AkStreamMgrModule.h.


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