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

◆ PrepareEvent() [3/4]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::PrepareEvent ( PreparationType  in_PreparationType,
const char **  in_ppszString,
AkUInt32  in_uNumEvent 
)

Prepares or unprepares events synchronously.
The Events are identified by strings and converted to IDs internally (refer to General Information for a discussion on using strings and IDs). Before invoking PrepareEvent(), use LoadBank() to explicitly load the SoundBank(s) that contain the Events and structures. When a request is posted to the Bank Manager consumer thread, it will resolve all dependencies needed to successfully post the specified Events and load the required loose media files.

Note: Before version 2015.1, the required media files could be included in a separate media SoundBank. As described in Important Migration Notes 2015.1, however, PrepareEvent() now only looks for loose media files.

The function returns when the request is completely processed.

Returns
  • AK_Success: Prepare/un-prepare successful.
  • AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareEvent() does not exist.
  • AK_InsufficientMemory: Insufficient memory to store bank data.
  • AK_BankReadError: I/O error.
  • 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_InvalidParameter: Invalid parameter, invalid memory alignment.
  • AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
Remarks
Whenever at least one event fails to be resolved, the actions performed for all other events are cancelled.
Note: The use of PrepareEvent is incompatible with LoadBank, using in-memory data.
See also
Parameters
in_PreparationTypePreparation type ( Preparation_Load or Preparation_Unload )
in_ppszStringArray of event names
in_uNumEventNumber of events in the array

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