Other Documentation

Wwise SDK 2022.1.8

◆ PrepareBank() [2/4]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::PrepareBank ( AK::SoundEngine::PreparationType  in_PreparationType,
AkBankID  in_bankID,
AkBankCallbackFunc  in_pfnBankCallback,
void *  in_pCookie,
AK::SoundEngine::AkBankContent  in_uFlags = AkBankContent_All,
AkBankType  in_bankType = AkBankType_User 

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

This function will load the events, structural content, and optionally, the media content from the SoundBank. If the flag AkBankContent_All is specified, PrepareBank() will load the media content from the bank, but as opposed to LoadBank(), the media will be loaded one media item at a time instead of in one contiguous memory block. Using PrepareBank(), alone or in combination with PrepareEvent(), will prevent in-memory duplication of media at the cost of some memory fragmentation. Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank, allowing using PrepareEvent() to load media on demand.

See also
PrepareBank(), when called with the flag AkBankContent_StructureOnly, requires additional calls to PrepareEvent() to load the media for each event. PrepareEvent(), however, is unable to access media content contained within SoundBanks and requires that the media be available as loose files in the file system. This flag may be useful to implement multiple loading configurations; for example, a game may have a tool mode that uses PrepareEvent() to load loose files on-demand and, also, a game mode that uses LoadBank() to load the bank in entirety.
in_PreparationType Preparation type ( Preparation_Load or Preparation_Unload )
in_bankID ID of the bank to Prepare/Unprepare.
in_pfnBankCallback Callback function
in_pCookie Callback cookie (reserved to user, passed to the callback function)
in_uFlags Structures only (including events) or all content.
in_bankType Type of the bank to Prepare/Unprepare.

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