Wwise Help

To set up your SoundBanks in Wwise when preparing Events:

1. Create a SoundBank called “Events” and load it into the SoundBank Editor.

2. Add some of the Action Events in your project to the “Event” SoundBank, or simply add the Event Work Units.

3. Disable the Media check box, leaving only the Events and Structures check boxes enabled. When using PrepareEvent(), the media must not reside in a SoundBank, but be loaded directly off disk as a loose file.

   Note

   For the purposes of this example, all the Events and structures are contained in one SoundBank. Although this is acceptable for small projects, you will most likely want to split up your content into several SoundBanks. It is also possible to create a separate “Structures” SoundBank that does not need to be explicitly loaded nor prepared from the SDK command because each Event includes references to the other SoundBanks that need to be loaded.

4. Generate the SoundBanks and copy the generated SoundBank folder to the game application.

   Note

   The structure data contained within a single SoundBank can't be split at runtime. Therefore, if you are using AK::SoundEngine::PrepareEvent(), and the structure data from a separate SoundBank is required, all the structures within that SoundBank will be loaded at once. For this reason, you may want to split the structure content in your project into multiple SoundBanks, to minimize the amount of unnecessary information that is loaded into memory.

To prepare Events in game:

1. In the game, load the Events' SoundBank at the beginning of your game and then prepare the Events when they are required in game. The corresponding structures and media will be loaded automatically.

   The following code sample gives you an idea of how to prepare Events in game.

                 
                 // Initializing the sound engine.
   
                 AkInitSettings initSettings;
                 AkPlatformInitSettings platformInitSettings;
                 AK::SoundEngine::GetDefaultInitSettings( initSettings ):
                 AK::SoundEngine::GetDefaultPlatformInitSettings( platformInitSettings ):
   
                 // Set the required settings.
   
                 ...
   
                 // Set PrepareEvent related settings.
                 initSettings.bEnableGameSyncPreparation = false; // Not used in the current sample.
   
                 // (Optional) Allocate a memory pool into which prepared media will be loaded.
                 // If this is not done, memory will be allocated directly in the default memory pool.
                 {
                   initSettings.uPrepareEventMemoryPoolID = AK.MemoryMgr.CreatePool( NULL, 4*1024*1024, 1024, AkMalloc );
   
                   // (Optional) Give the memory pool a name. This can be very useful for profiling.
                   AK::MemoryMgr::SetPoolName( initSettings.uPrepareEventMemoryPoolID, L"PrepareEventPool" );
                 }
   
                 AKRESULT eResult = AK.SoundEngine.Init( initSettings, platformInitSettings );
                 if( eResult != AK_Success )
                 {
                   // Handle error.
                 }
   
                 // Load Init bank and the event/structure bank.
                 AkBankID    bankID;  // Not used in the sample.
                 AKRESULT eResult = AK::SoundEngine::LoadBank( L"Init.bnk", AK_DEFAULT_POOL_ID, bankID );
                 if( eResult == AK_Success )
                 {
                   eResult = AK::SoundEngine::LoadBank( L"Events.bnk", AK_DEFAULT_POOL_ID, bankID );
                 }
   
                 ...
   
                 // And then, at various points in the code:
   
                 AkLpCtstr pEventsNameArray[1] = { L"My_Event_Name" };
   
                 // Preparing an event:
                 eResult = AK::SoundEngine::PrepareEvent( Preparation_Load, pEventsNameArray, 1 ); // 1 is the array size.
   
                 // Unpreparing an event:
                 eResult = AK::SoundEngine::PrepareEvent( Preparation_Unload, pEventsNameArray, 1 ); // 1 is the array size.