Table of Contents

Wwise SDK 2019.1.5

◆ PrepareGameSyncs() [4/4]

AKRESULT __cdecl AK::SoundEngine::PrepareGameSyncs ( PreparationType  in_PreparationType,
AkGroupType  in_eGameSyncType,
AkUInt32  in_GroupID,
AkUInt32 in_paGameSyncID,
AkUInt32  in_uNumGameSyncs,
AkBankCallbackFunc  in_pfnBankCallback,
void *  in_pCookie 
)

Prepares or un-prepare game syncs asynchronously (by ID).
The group and game syncs are specified by ID (refer to General Information for a discussion on using strings and IDs). The game syncs 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 set this game sync group to one of the game sync values 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
You need to call PrepareGameSyncs() if the sound engine was initialized with AkInitSettings::bEnableGameSyncPreparation set to true. When set to false, the sound engine automatically prepares all Game Syncs when preparing Events, so you never need to call this function.
See also
Parameters
in_PreparationType Preparation type ( Preparation_Load or Preparation_Unload )
in_eGameSyncType The type of game sync.
in_GroupID The State Group ID or the Switch Group ID.
in_paGameSyncID Array of ID of the Game Syncs to either support or not support.
in_uNumGameSyncs The number of game sync ID in the array.
in_pfnBankCallback Callback function
in_pCookie Callback cookie (reserved to user, passed to the callback function)