Version

menu_open
Wwise SDK 2022.1.11

◆ UnloadBank() [1/4]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::UnloadBank ( AkBankID  in_bankID,
const void *  in_pInMemoryBankPtr,
AkBankCallbackFunc  in_pfnBankCallback,
void *  in_pCookie,
AkBankType  in_bankType = AkBankType_User 
)

Unloads a bank asynchronously (by ID and memory pointer).
Refer to General Information for a discussion on using strings and IDs.

Returns
AK_Success if scheduling successful (use a callback to be notified when completed)
Remarks
  • 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_bankIDID 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_pfnBankCallbackCallback function
in_pCookieCallback cookie (reserved to user, passed to the callback function)
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