Table of Contents

AKRESULT __cdecl AK::SoundEngine::PrepareEvent ( PreparationType  in_PreparationType,
AkUniqueID in_pEventID,
AkUInt32  in_uNumEvent,
AkBankCallbackFunc  in_pfnBankCallback,
void *  in_pCookie  
)

Prepare or un-prepare events asynchronously (by ID).
The events are identified by their ID (refer to General Information for a discussion on using strings and IDs). The event definitions must already exist in the sound engine by having explicitly loaded the bank(s) that contain them (with LoadBank()). A request is posted to the Bank Manager consumer thread. It will resolve all dependencies needed to successfully post the events specified, and load the required banks, if applicable. 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_pEventID  Array of event IDs
in_uNumEvent  Number of event IDs in the array
in_pfnBankCallback  Callback function
in_pCookie  Callback cookie (reserved to user, passed to the callback function)