Table of Contents

Wwise SDK 2019.1.6

◆ UnloadBank() [2/4]

AKRESULT __cdecl AK::SoundEngine::UnloadBank ( AkBankID  in_bankID,
const void *  in_pInMemoryBankPtr,
AkMemPoolId out_pMemPoolId = NULL 
)

Unloads a bank synchronously (by ID and memory pointer).

Returns
AK_Success if successful, AK_Fail otherwise. AK_Success is returned when the bank was not loaded.
Remarks
If you provided a pool memory ID when loading this bank, it is returned as well. Otherwise, the function returns AK_DEFAULT_POOL_ID.
  • In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped. This means that streamed sounds or generated sounds will not be stopped.
See also
Parameters
in_bankID ID of the bank to unload
in_pInMemoryBankPtr Memory pointer from where the bank was initially loaded from. (REQUIRED to determine which bank associated to a memory pointer must be unloaded). Pass NULL only if NULL was passed when loading the bank.
out_pMemPoolId Returned memory pool ID used with LoadBank() (can pass NULL)