Version

    Other Documentation

menu_open
Wwise Unity Integration Documentation

Loads and unloads a SoundBank at a specified moment. Vorbis sounds can be decompressed at a specified moment using the decode compressed data option. In that case, the SoundBank will be prepared. More...

Inherits AkTriggerHandler, and AK.Wwise.IMigratable.

Public Member Functions

override void  HandleEvent (UnityEngine.GameObject in_gameObject)
  Loads the SoundBank. More...
 
void  UnloadBank (UnityEngine.GameObject in_gameObject)
  Unloads a SoundBank. More...
 

Public Attributes

bool  decodeBank = false
  Decode this SoundBank upon load. More...
 
bool  loadAsynchronous = false
  Check this to load the SoundBank in the background. Be careful, if Events are triggered and the SoundBank hasn't finished loading, you'll have "Event not found" errors. More...
 
bool  saveDecodedBank = false
  Save the decoded SoundBank to disk for faster loads in the future. More...
 
System.Collections.Generic.List< int >  unloadTriggerList
  Reserved. More...
 
System.Collections.Generic.List< int >  triggerList = new System.Collections.Generic.List<int> { START_TRIGGER_ID }
  List containing the enabled triggers. More...
 
bool  useOtherObject = false
  This property is usefull only when used with colliders. When enabled, the target of the action will be the other colliding object. When disabled, it will be the current object. More...
 

Static Public Attributes

const int  MAX_NB_TRIGGERS = 32
  Since our mask is a 32 bits integer, we can't have more than 32 triggers. More...
 
static System.Collections.Generic.Dictionary< uint, string >  triggerTypes = AkTriggerBase.GetAllDerivedTypes()
  Will contain the types of all the triggers derived from AkTriggerBase at runtime. More...
 

Detailed Description

Loads and unloads a SoundBank at a specified moment. Vorbis sounds can be decompressed at a specified moment using the decode compressed data option. In that case, the SoundBank will be prepared.


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise