Version
menu_open
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:| AK::Wwise::AcousticTexture | This type represents an Acoustic Texture |
| AK::Wwise::AuxBus | This type represents an auxiliary send in the Master-Mixer Hierarchy |
| AK::Wwise::Bank | This type can be used to load/unload SoundBanks |
| AK::Wwise::BaseGroupType | This type represents the base for all Wwise Types that also require a group GUID, such as State and Switch |
| AK::Wwise::BaseType | This type represents the base for all Wwise Types that require a GUID |
| AK::Wwise::CallbackFlags | This type represents the values of the flags used when posting an Event with a callback |
| AK::Wwise::Event | This type can be used to post Events to the sound engine |
| AK::Wwise::RTPC | This type can be used to set game parameter values to the sound engine |
| AK::Wwise::State | This type can be used to set Wwise States |
| AK::Wwise::Switch | This type can be used to set Switch values on gameobjects |
| AK::Wwise::Trigger | This type can be used to post triggers to the sound engine |
| AkAmbient | Use this component to attach a Wwise Event to any object in a scene. The sound can be started at various moments, dependent on the selected Unity trigger. This component is more useful for ambient sounds (sounds related to scene-bound objects) but could also be used for other purposes. Since AkAmbient has AkEvent as its base class, it features the play/stop, play multiple, stop multiple and stop all buttons for previewing the associated Wwise event |
| AkAudioInputManager | This class represents an example audio input manager and is responsible for managing the audio sample and format callbacks provided to the Wwise Audio Input plug-in |
| AkAudioListener | Add this script on the game object that represent a listener. This is normally added to the Camera object or the Player object, but can be added to any game object when implementing 3D busses. isDefaultListener determines whether the game object will be considered a default listener - a listener that automatically listens to all game objects that do not have listeners attached to their AkGameObjListenerList's |
| AkBank | 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 |
| AkBankManager | Maintains the list of loaded SoundBanks loaded. This is currently used only with AkAmbient objects |
| AkBasePathGetter | This class is responsible for determining the path where sound banks are located. When using custom platforms, this class needs to be extended |
| AkCallbackManager | This class manages the callback queue. All callbacks from the native Wwise SDK go through this queue. The queue needs to be driven by regular calls to PostCallbacks(). This is currently done in AkInitializer.cs, in LateUpdate() |
| AkCallbackManager::BankCallbackPackage | This class holds the data associated with a bank load or unload callback |
| AkCallbackManager::EventCallbackPackage | This class holds the data associated with an event callback |
| AkEmitterObstructionOcclusion | Obstructs/Occludes the emitter of the current game object from its listeners if at least one object is between them |
| AkEnvironment | Use this component to define a reverb zone. This needs to be added to a collider object to work properly. How to use AkEvironment and AkEvironmentPortal with the inspector (Reverb Zones) |
| AkEnvironment::AkEnvironment_CompareByPriority | Sorts AkEnvironment's based on their priorities |
| AkEnvironment::AkEnvironment_CompareBySelectionAlgorithm | |
| AkEnvironmentPortal | Use this component to define an area that straddles two different AkEnvironment's zones and allow mixing between both zones. How to use AkEvironment and AkEvironmentPortal with the inspector (Reverb Zones) |
| AkEvent | Helper class that knows a Wwise Event and when to trigger it in Unity. As of 2017.2.0, the AkEvent inspector has buttons for play/stop, play multiple, stop multiple, and stop all. Play/Stop will play or stop the event such that it can be previewed both in edit mode and play mode. When multiple objects are selected, Play Multiple and Stop Multiple will play or stop the associated AkEvent for each object |
| AkEventCallbackMsg | Event callback information. Event callback functions can receive this structure as a parameter |
| AkGameObj | This component represents a sound object in your scene tracking its position and other game syncs such as Switches, RTPC and environment values. You can add this to any object that will emit sound, and it will be added to any object that an AkAudioListener is attached to. Note that if it is not present, Wwise will add it automatically, with the default values, to any Unity Game Object that is passed to Wwise |
| AkInitializer | |
| AkMemBankLoader | |
| AkRoom | An AkRoom is an enclosed environment that can only communicate to the outside/other rooms with AkRoomPortals |
| AkRoomPortal | An AkRoomPortal can connect two AkRoom components together |
| AkRoomPortalObstruction | Obstructs/Occludes the spatial audio portal of the current game object from the spatial audio listener if at least one object is between them |
| AkSoundEngine | Contains C# functions exposed from the Wwise C++ API |
| AkSpatialAudioBase | Base class for spatial audio emitter and listener components |
| AkSpatialAudioEmitter | Add this script on the GameObject which represents an emitter that uses the Spatial Audio API |
| AkSpatialAudioListener | Add this script on the game object that represent a listener. This is normally added to the Camera object or the Player object, but can be added to any game object when implementing 3D busses. isDefaultListener determines whether the game object will be considered a default listener - a listener that automatically listens to all game objects that do not have listeners attached to their AkGameObjListenerList's |
| AkSpatialAudioListener::SpatialAudioListenerList | This class represents the list of active Unity Game Objects that are designated to be spatial audio listeners. Currently, only one spatial audio listener can be active at a time |
| AkState | This will call AkSoundEngine.SetState() whenever the selected Unity event is triggered. For example this component could be set on a Unity collider to trigger when an object enters it |
| AkSurfaceReflector | This component will convert the triangles of the GameObject's geometry into sound reflective surfaces |
| AkSwitch | This will call AkSoundEngine.SetSwitch() whenever the selected Unity event is triggered. For example this component could be set on a Unity collider to trigger when an object enters it |
| AkTerminator | |
| AkTriggerBase | |
| AkUtilities::ShortIDGenerator | This is based on FNVHash as used by the DataManager to assign short IDs to objects. Be sure to keep them both in sync when making changes! |
Generated on Mon Apr 15 18:03:42 2019 for Wwise Unity Integration by
1.6.3 Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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