Open 3D Engine AudioEngineWwise Gem API Reference  24.09
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::CStreamingDevice_wwise Class Reference

#include <FileIOHandler_wwise.h>

Inherits AK::StreamMgr::IAkIOHookDeferred.

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, AkAsyncIOTransferInfo &transferInfo) override
 
AKRESULT Write (AkFileDesc &fileDesc, const AkIoHeuristics &heuristics, AkAsyncIOTransferInfo &transferInfo) override
 
void Cancel ([[maybe_unused]] AkFileDesc &fileDesc, [[maybe_unused]] AkAsyncIOTransferInfo &transferInfo, [[maybe_unused]] bool &cancelAllTransfersForThisFile) 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 uses AZ::IO::Streamer to asynchronously handle file requests. By using AZ::IO::Streamer file requests can be scheduled along side other file requests for optimal disk usage. This class can't write and is intended to be used as part of a streaming system.

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