Table of Contents

Wwise SDK 2019.1.6

◆ PrepareEvent() [3/4]

AKRESULT __cdecl AK::SoundEngine::PrepareEvent ( PreparationType  in_PreparationType,
const char **  in_ppszString,
AkUInt32  in_uNumEvent,
AkBankCallbackFunc  in_pfnBankCallback,
void *  in_pCookie 
)

Prepares or unprepares an event asynchronously. The Events are identified by string (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 immediately. Use a callback to be notified when the request has finished being processed.

Returns
AK_Success if scheduling is was successful, AK_Fail otherwise.
Remarks
Whenever at least one event fails to be resolved, the actions performed for all other events are cancelled.
See also
Parameters
in_PreparationType Preparation type ( Preparation_Load or Preparation_Unload )
in_ppszString Array of event names
in_uNumEvent Number of events in the array
in_pfnBankCallback Callback function
in_pCookie Callback cookie (reserved to user, passed to the callback function)