Table of Contents

Wwise Unity Integration Documentation
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
 NAK
 NWwise
 CAcousticTexture This type represents an Acoustic Texture
 CAuxBus This type represents an auxiliary send in the Master-Mixer Hierarchy
 CBank This type can be used to load/unload SoundBanks
 CBaseGroupType This type represents the base for all Wwise Types that also require a group GUID, such as State and Switch
 CBaseType This type represents the base for all Wwise Types that require a GUID
 CCallbackFlags This type represents the values of the flags used when posting an Event with a callback
 CEvent This type can be used to post Events to the sound engine
 CRTPC This type can be used to set game parameter values to the sound engine
 CState This type can be used to set Wwise States
 CSwitch This type can be used to set Switch values on gameobjects
 CTrigger This type can be used to post triggers to the sound engine
 Cak URI strings to use in WAAPI calls. For a complete description, refer to the official Wwise SDK documentation
 CAkAmbient 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
 CAkAmbientLargeModePositioner Use this component to add a Large Mode position to any AkAmbient in a Scene
 CAkAudioListener 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
 CAkBank 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
 CAkEarlyReflections Set an early reflections auxiliary bus and send volume for a particular game object
 CAkEmitterObstructionOcclusion Completely obstructs/occludes the emitter of the current game object from its listeners if at least one object is between them
 CAkEnvironment Use this component to define a reverb zone. This needs to be added to a collider object to work properly. See Using AkEnvironment and AkEnvironmentPortal from the Inspector (Reverb Zones)
 CAkEnvironment_CompareByPriority Sorts AkEnvironments based on their priorities
 CAkEnvironment_CompareBySelectionAlgorithm Sorts AkEnvironments based on the selection algorithm. The selection algorithm is as follows:
 CAkEnvironmentPortal Use this component to define an area that straddles two different AkEnvironment's zones and allow mixing between both zones. Using AkEnvironment and AkEnvironmentPortal from the Inspector (Reverb Zones)
 CEnvListWrapper This enables us to detect intersections between portals and environments in the editor
 CAkEvent 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
 CAkEventCallbackMsg Event callback information. Event callback functions can receive this structure as a parameter
 CAkGameObj 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
 CAkInitializer This script deals with initialization, and frame updates of the Wwise audio engine.
It is marked as DontDestroyOnLoad so it stays active for the life of the game, not only one scene. Double-click the Initialization Settings entry, AkWwiseInitializationSettings, to review and edit Wwise initialization settings
 CAkMemBankLoader This class is an example of how to load banks in Wwise, if the bank data was preloaded in memory.
This would be useful for situations where you use the WWW class
 CAkRadialEmitter A radial emitter is for sounds that are not point sources, but instead originate from a region of space
 CAkRoom An AkRoom is an enclosed environment that can only communicate to the outside/other rooms with AkRoomPortals
 CAkRoomAwareManager This manager tracks the AkRoomAwareObjects and the AkRooms in which they enter and exit
 CAkRoomAwareObject This component makes a GameObject aware of AkRoom components. When using Spatial Audio rooms, all emitters and the spatial audio listener should have this component
 CAkRoomManager This manager tracks AkRoomPortals and the rooms that they connect (front and back room)
 CAkRoomPortal An AkRoomPortal can connect two AkRoom components together
 CAkRoomPortalObstruction Completely obstructs the spatial audio portal of the current game object from the spatial audio listener if at least one object is between them
 CAkSpatialAudioDebugDraw Add this script on a GameObject to print Spatial Audio paths
 CAkSpatialAudioEmitter (DEPRECATED) This script is deprecated as of 2019.2. Early reflections, Diffraction and Room Reverb can all be enabled per sound in the Sound Property Editor of the Authoring
 CAkSpatialAudioListener 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
 CSpatialAudioListenerList 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
 CAkState 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
 CAkSurfaceReflector This component converts the provided mesh into Spatial Audio Geometry
 CAkSwitch 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
 CAkTriggerBase Base class for the generic triggering mechanism for Wwise Integration. All Wwise components will use this mechanism to drive their behavior. Derive from this class to add your own triggering condition, as described in Adding New Triggers for Wwise Events
 CAkWaapiUtilities This class wraps the client that communicates with the Wwise Authoring application via WAAPI. Given that only one request can be pending on the websocket, a queue is used to consume all calls sequentially. Messages sent to WAAPI use the JSON format and are serialized by Unity Json serialization. Helper classes (WaapiHelper) for serialization, keywords for WAAPI commands (WaapiKeywords), and classes for serializing message arguments and deserializing responses are found in AkWaapiHelper.cs. Uri.cs contains classes with fields containing URI strings for WAAPI calls and error messages
 CSubscriptionInfo Class used to store information about a specific subscription
 CWaapiCommand A simple structure containing an async payload function that will be executed when it is consumed by the command queue
 CAkWwiseTreeWAAPIDataSource This class communicates with Wwise Authoring via AkWaapiUtilities to keep track of the Wwise object hierarchy in the project. This hierarchy information is stored in a tree structure and is used by the Wwise Picker when it is in WAAPI mode. Changes to the project are received via WAAPI subscriptions
 CArgs Abstract base class for WAAPI command arguments
 CArgsCommand WAAPI arguments containing an object identfier and command field. Used by AkWaapiUtilities.SelectObjectInAuthoringAsync()
 CArgsDisplayName WAAPI arguments containing an object identfier and name used when deleting an object
 CArgsObject WAAPI arguments containing an object identfier
 CArgsPlay WAAPI arguments containing an Event identfier and transport ID. Used to toggle Event playback
 CArgsRename WAAPI arguments containing an object identfier and new value used when renaming an object
 CArgsTransport WAAPI arguments containing a transport ID. Used to specify transports in transport-specific commands
 CErrorDetails Used to deserialize details in WAAPI error messages
 CErrorMessage Used to deserialize WAAPI error messages
 CJsonSerializable Base class for Json serializable objects. Implements implicit cast to string using UnityEngine.JsonUtility.ToJson
 COptions Abstract base class for WAAPI command options
 CReturnOptions WAAPI options to specify the names of fields to return in a WAAPI request returning WwiseObjects
 CReturnTransport Used to deserialize the response from an ak.wwise.core.transport.create command. Contains the transport ID
 CReturnWwiseObjects Generic class to deserialize a WAAPI response containing Wwise objects with custom return options
 CReturnWwiseObjects Class used to deserialize a WAAPI response containing Wwise objects
 CSelectedWwiseObjects Class used to deserialize selected Wwise objects published on the ak.wwise.ui.selectionChanged topic
 CTransportOptions WAAPI options used to specify the transport ID when subscribing
 CTransportState Used to deserialize transport-state information receieved from the transport.stateChanged topic
 CWaapiHelper Contains a helper function GetWwiseObjectTypeFromString
 CWaapiKeywords Contains fields for specific WAAPI keywords
 CWamp WAMP protocol implementation using only strings and regular expressions. This implements only a subset of the WAMP feature set and is only compatible with Wwise
 CErrorException Exception thrown during WAMP operations
 CTimeoutException Exception thrown during WAMP operations when the timeout is reached
 CWaqlArgs WAAPI arguments containing a WAQL string
 CWwiseChildModifiedInfo Used to deserialize information published on the ak.ww.nosp@m.ise..nosp@m.core..nosp@m.@obj.nosp@m.ect.c.nosp@m.hild.nosp@m.Added and ak.ww.nosp@m.ise..nosp@m.core..nosp@m.@obj.nosp@m.ect.c.nosp@m.hild.nosp@m.Remov.nosp@m.ed topics
 CWwiseObjectInfo Class containing the information returned by a WAAPI request for an object
 CWwiseObjectInfoJsonObject Used to deserialize information from a request for a Wwise object. Implements an implicit cast to WwiseObjectInfo
 CWwiseObjectInfoParent Contains the GUID of the returned object's parent
 CWwiseRenameInfo Used to deserialize information published on the ak.ww.nosp@m.ise..nosp@m.core..nosp@m.@obj.nosp@m.ect.n.nosp@m.ameC.nosp@m.hange.nosp@m.d topic