Prepare or un-prepare events synchronously (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 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)
- 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 |