Other Documentation

Wwise SDK 2022.1.9
AkStreamMgrModule.h File Reference

Go to the source code of this file.


struct   AkStreamMgrSettings
struct   AkDeviceSettings
struct   AkFileDesc
struct   AkIOTransferInfo
struct   AkAsyncIOTransferInfo
struct   AkIoHeuristics
class   AK::StreamMgr::IAkLowLevelIOHook
  Base interface for Low-Level I/O hooks. Defines common methods across both types of hooks. More...
class   AK::StreamMgr::IAkIOHookBlocking
class   AK::StreamMgr::IAkIOHookDeferredBatch
struct   AK::StreamMgr::IAkIOHookDeferredBatch::BatchIoTransferItem
class   AK::StreamMgr::IAkIOHookDeferred
class   AK::StreamMgr::IAkFileLocationResolver


namespace   AK
  Audiokinetic namespace.
  Audiokinetic Stream Manager's implementation-specific interfaces of the Low-Level IO submodule.


Audiokinetic implementation-specific Stream Manager factory.
AKSOUNDENGINE_API IAkStreamMgr *  AK::StreamMgr::Create (const AkStreamMgrSettings &in_settings)
AKSOUNDENGINE_API void  AK::StreamMgr::GetDefaultSettings (AkStreamMgrSettings &out_settings)
AKSOUNDENGINE_API IAkFileLocationResolver *  AK::StreamMgr::GetFileLocationResolver ()
AKSOUNDENGINE_API void  AK::StreamMgr::SetFileLocationResolver (IAkFileLocationResolver *in_pFileLocationResolver)
Stream Manager: High-level I/O devices management.
AKSOUNDENGINE_API AkDeviceID  AK::StreamMgr::CreateDevice (const AkDeviceSettings &in_settings, IAkLowLevelIOHook *in_pLowLevelHook)
AKSOUNDENGINE_API AKRESULT  AK::StreamMgr::DestroyDevice (AkDeviceID in_deviceID)
AKSOUNDENGINE_API void  AK::StreamMgr::GetDefaultDeviceSettings (AkDeviceSettings &out_settings)
Stream Manager: Cache management.
AKSOUNDENGINE_API void  AK::StreamMgr::FlushAllCaches ()

Scheduler type flags.

#define  AK_SCHEDULER_BLOCKING   (0x01)
typedef void(*  AkIOCallback) (AkAsyncIOTransferInfo *in_pTransferInfo, AKRESULT in_eResult)
typedef void(*  AkBatchIOCallback) (AkUInt32 in_uNumTransfers, AkAsyncIOTransferInfo **in_ppTransferInfo, AKRESULT *in_peResult)

Language management.

typedef void(*  AK::StreamMgr::AkLanguageChangeHandler) (const AkOSChar *const in_pLanguageName, void *in_pCookie)
AKSOUNDENGINE_API AKRESULT  AK::StreamMgr::SetCurrentLanguage (const AkOSChar *in_pszLanguageName)
AKSOUNDENGINE_API const AkOSChar AK::StreamMgr::GetCurrentLanguage ()
AKSOUNDENGINE_API AKRESULT  AK::StreamMgr::AddLanguageChangeObserver (AkLanguageChangeHandler in_handler, void *in_pCookie)
AKSOUNDENGINE_API void  AK::StreamMgr::RemoveLanguageChangeObserver (void *in_pCookie)

Detailed Description

Audiokinetic's implementation-specific definitions and factory of overridable Stream Manager module. Contains the default Stream Manager's implementation-specific interfaces that altogether constitute the Low-Level I/O submodule. This submodule needs to be implemented by the game. All I/O requests generated by the Stream Manager end up to one of the I/O hooks defined herein. Read Low-Level I/O to learn more about the Low-Level I/O.

Definition in 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