Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2022.1.17.8543 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2022.1.17

◆ UnloadBank() [2/4]

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

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
  • 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_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