Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.9.8628 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise Unity Integration Documentation
Using AkGameObj from the Inspector

The AkGameObj component acts as a bridge between Unity game objects and Wwise objects. You can use an AkGameObj to track the position of a sound object in Unity and use it for game syncs such as Switches, RTPCs, and environmental values.

Any object that is passed to Wwise, including any object with an AkAudioListener, requires an AkGameObj. When you add such a component to a Unity Game Object in the Inspector, an AkGameObj is automatically added as well. All objects that have AkGameObj components are registered in Wwise and then unregistered according to the lifetime of the Unity object.

When using game-defined auxiliary sends, ensure that both the emitter (which has both AkGameObj and AkEvent components) and the AkEnvironment components have colliders. The colliders are necessary for the AkEnvironment component to detect the emitter game object and for its signal to be sent to the corresponding Auxiliary Bus.

  • Apply Position Offset: Applies a second Transform to the game object, to specify an audio calculation position different from the game object's actual position.
    • Position Offset: Moves the position of the game object's second Transform according to game units entered in each of the X (left-right), Y (up-down), and Z (front-back) fields.
    • Hide Main Transform: Removes the original Transform from view, so only the offset one is visible.
  • Environment Aware: Determines whether the audio of the game object is affected by the environment, rooms, and portals. When enabled, the AkGameObj must have a Rigidbody. This option only has an effect if selected before the scene plays.
    • Add Rigidbody: Creates a Rigidbody component on the GameObject.
  • Use Default Listeners: Default Listeners are typically applied to central objects, such as a camera. It listens to everything.
    • Add Listener: Specifies another listener entry. Click to open the Select AkAudioListener dialog, then select a game object that has an AkAudioListener.
      Note:You must have a listener. If you do not use the default listeners or specify another one, ensure that Automatically add Listener to Main Camera is selected in the the Wwise Editor settings (see Adjusting Unity Editor Settings).
  • Attenuation Scaling Factor: The Attenuation Scaling Factor of the game object.
    See also
  • Using AkEnvironment and AkEnvironmentPortal from the Inspector
  • Integrating Listeners (SDK documentation)

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