Version
menu_open

include/AK/SoundEngine/Common/AkStreamMgrModule.h File Reference

Go to the source code of this file.

Classes

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::IAkIOHookDeferred
class   AK::StreamMgr::IAkFileLocationResolver

Namespaces

namespace   AK
 

Audiokinetic namespace.


namespace   AK::StreamMgr

Functions

Audiokinetic implementation-specific Stream Manager factory.

IAkStreamMgr *__cdecl  AK::StreamMgr::Create (const AkStreamMgrSettings &in_settings)
void __cdecl  AK::StreamMgr::GetDefaultSettings (AkStreamMgrSettings &out_settings)
IAkFileLocationResolver *__cdecl  AK::StreamMgr::GetFileLocationResolver ()
void __cdecl  AK::StreamMgr::SetFileLocationResolver (IAkFileLocationResolver *in_pFileLocationResolver)
AkMemPoolId __cdecl  AK::StreamMgr::GetPoolID ()
Stream Manager: High-level I/O devices management.

AkDeviceID __cdecl  AK::StreamMgr::CreateDevice (const AkDeviceSettings &in_settings, IAkLowLevelIOHook *in_pLowLevelHook)
AKRESULT __cdecl  AK::StreamMgr::DestroyDevice (AkDeviceID in_deviceID)
void __cdecl  AK::StreamMgr::GetDefaultDeviceSettings (AkDeviceSettings &out_settings)
Stream Manager: Cache management.

void __cdecl  AK::StreamMgr::FlushAllCaches ()

Scheduler type flags.



#define  AK_SCHEDULER_BLOCKING   (0x01)
#define  AK_SCHEDULER_DEFERRED_LINED_UP   (0x02)
typedef void(*  AkIOCallback )(AkAsyncIOTransferInfo *in_pTransferInfo, AKRESULT in_eResult)

Language management.



typedef void(*  AK::StreamMgr::AkLanguageChangeHandler )(const AkOSChar *const in_pLanguageName, void *in_pCookie)
AKRESULT __cdecl  AK::StreamMgr::SetCurrentLanguage (const AkOSChar *in_pszLanguageName)
const AkOSChar *__cdecl  AK::StreamMgr::GetCurrentLanguage ()
AKRESULT __cdecl  AK::StreamMgr::AddLanguageChangeObserver (AkLanguageChangeHandler in_handler, void *in_pCookie)
void __cdecl  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