Wwise Version
arrow_right Table of Contents
Wwise SDK 2021.1.5

◆ UnloadBank() [3/4]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::UnloadBank ( const char *  in_pszString,
const void *  in_pInMemoryBankPtr 
)

Unloads a bank synchronously.
Refer to General Information for a discussion on using strings and IDs.

Returns
AK_Success if successful, AK_Fail otherwise. AK_Success is returned when the bank was not loaded.
Remarks
  • The sound engine internally calls GetIDFromString(in_pszString) to retrieve the bank ID, then it calls the synchronous version of UnloadBank() by ID. Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally), not the name of the file (if you changed it), nor the full path of the file.
  • 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_pszString Name 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 if NULL was passed when loading the bank or if LoadBankMemoryCopy was used to load the bank.