Open 3D Engine AudioEngineWwise Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Protected Attributes | List of all members
Audio::CBlockingDevice_wwise Class Reference

#include <FileIOHandler_wwise.h>

Inherits AK::StreamMgr::IAkIOHookBlocking.

Public Member Functions

bool Init (size_t poolSize)
 
void Destroy ()
 
AkDeviceID GetDeviceID () const
 
bool Open (const char *filename, AkOpenMode openMode, AkFileDesc &fileDesc)
 
AKRESULT Read (AkFileDesc &fileDesc, const AkIoHeuristics &heuristics, void *buffer, AkIOTransferInfo &transferInfo) override
 
AKRESULT Write (AkFileDesc &fileDesc, const AkIoHeuristics &heuristics, void *data, AkIOTransferInfo &transferInfo) override
 
AKRESULT Close (AkFileDesc &fileDesc) override
 
AkUInt32 GetBlockSize (AkFileDesc &fileDesc) override
 
void GetDeviceDesc (AkDeviceDesc &deviceDesc) override
 
AkUInt32 GetDeviceData () override
 

Protected Attributes

AkDeviceID m_deviceID = AK_INVALID_DEVICE_ID
 

Detailed Description

Wwise file IO device that access the Open 3D Engine file system through standard blocking file IO calls. Wwise will still run these in separate threads so it won't be blocking the audio playback, but it will interfere with the internal file IO scheduling of Open 3D Engine. This class can also write, so it's intended use is for one-off file reads and for tools to be able to write files.

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