Version

menu_open
Wwise SDK 2023.1.4

◆ UnloadBank() [4/4]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::UnloadBank ( const char *  in_pszString,
const void *  in_pInMemoryBankPtr,
AkBankType  in_bankType = AkBankType_User 
)

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_pszStringName of the bank to unload
in_pInMemoryBankPtrMemory 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.
in_bankTypeType of the bank to unload

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