Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). 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 2023.1.8

◆ LoadBank() [2/4]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::LoadBank ( AkBankID  in_bankID,
AkBankType  in_bankType = AkBankType_User 
)

Loads a bank synchronously (by ID).

Note: Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings.

The bank ID is passed to the Stream Manager. Refer to General Information for a discussion on using strings and IDs. A bank load request will be posted, and consumed by the Bank Manager thread. The function returns when the request has been completely processed.

Returns
  • AK_Success: Load or unload successful.
  • AK_BankAlreadyLoaded: This bank is already loaded, nothing done.
  • AK_InsufficientMemory: Insufficient memory to store bank data.
  • AK_BankReadError: I/O error. The bank is either shorter than expected or its data corrupted.
  • AK_WrongBankVersion: Invalid bank version: make sure the version of Wwise that you used to generate the SoundBanks matches that of the SDK you are currently using.
  • AK_InvalidFile: File specified could not be opened.
  • AK_NotInitialized if the sound engine was not correctly initialized
  • AK_InvalidParameter if some parameters are invalid, check the debug console or Wwise Profiler
  • AK_InvalidBankType if the bank type parameter is out of range.
  • AK_FileNotFound if the bank file was not found on disk.
  • AK_FilePermissionError if the file permissions are wrong for the file
  • AK_Fail: Load or unload failed for any other reason. , check the debug console or Wwise Profiler
Remarks
  • The initialization bank must be loaded first.
  • All SoundBanks subsequently loaded must come from the same Wwise project as the initialization bank. If you need to load SoundBanks from a different project, you must first unload ALL banks, including the initialization bank, then load the initialization bank from the other project, and finally load banks from that project.
  • Codecs and plug-ins must be registered before loading banks that use them.
  • Loading a bank referencing an unregistered plug-in or codec will result in a load bank success, but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects, posting the event will fail.
See also
Parameters
in_bankIDBank ID of the bank to load
in_bankTypeType of the bank to load

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