Wwise Help

Available built-in parameters:

• Distance

  The distance between the game object and the listener. In the case that multiple listeners and/or multiple positions are assigned to the game object, the value is taken to be the shortest distance between all listener and sound position combinations.

• Azimuth

  The angle, in degrees, between the listener and the game object projected on to the horizontal plane. A value of 0 degrees indicates that the sound is directly in front of the listener, -90 degrees the sound is to the left, 90 degrees to the right, and +/- 180 degrees the sound is directly behind the listener.

  In the case that the game object has been assigned multiple listeners and/or sound positions, the value taken is the angle between the listener and sound position that are closest together.

• Elevation

  The vertical angle with respect to the horizon in degrees, between the listener and the game object. A value of 0 degrees indicates that the sound is on the same horizontal plane as the listener; a value of 90 degrees indicates that the sound is directly above and -90 degrees indicates the sound is directly below.

  In the case that the game object has been assigned multiple listeners and/or sound positions, the value taken is the angle between the listener and sound position that are closest together.

• Emitter Cone

  The Emitter Cone represents the 3D angle between the orientation vector of the emitter and the vector formed by the line between the emitter and the listener. A value of 0 degrees indicates that the emitter is directly facing the listener, and a value of 180 degrees indicates that the emitter is facing directly away from the listener.

  In the case that the game object has been assigned multiple listeners and/or sound positions, the value taken is the angle between the listener and sound position that are closest together.

• Obstruction

  Obstruction provides access to the value set on the game object via the SetObjectObstructionAndOcclusion API.

  In the case that the game object has been assigned multiple listeners, the obstruction value taken is the one that has been assigned to the listener with the closest current sound position.

• Occlusion

  Occlusion provides access to the value set on the game object via the SetObjectObstructionAndOcclusion API.

  In the case that the game object has been assigned multiple listeners, the occlusion value taken is the one that has been assigned to the listener with the closest current sound position.

• Listener Cone

  The Listener Cone represents the 3D angle between the orientation vector of the listener and the vector formed by the line between the emitter and the listener. A value of 0 degrees indicates that the listener is directly facing the emitter, and a value of 180 degrees indicates that the listener is facing directly away from the emitter.

  In the case that the game object has been assigned multiple listeners and/or sound positions, the value taken is the angle between the listener and sound position that are closest together.

• Diffraction

  Diffraction provides access to the diffraction angle calculated by Wwise Spatial Audio when using sound propagation with rooms and portals or with geometry.

  In order to receive this built-in parameter, the Diffraction and Transmission check box of the Positioning tab of the Property Editor must be selected, and the emitter and listener must be either in separate Rooms connected by one or more Portals, or obstructed by geometry that was passed to Wwise Spatial Audio.

  With rooms and portals, emitter game objects receive a value relating to their 'dry' diffraction; the divergence angle, in degrees, away from a straight-line path between the emitter and the listener. Room game objects that have been registered internally by Spatial Audio also receive a diffraction value, but relating instead to their 'wet' diffraction - the diffraction of the diffuse reservation field of sounds that are inside the Room. Wet diffraction is the divergence angle, in degrees, from the perpendicular to a Portal opening.

  In the case that there are multiple Portals, or multiple paths the sound can take to reach the listener, the smallest diffraction angle amongst the various paths is chosen. The diffraction value can have a range from 0 - 100, which represents a percentage of diffraction, rather than a degree.

• Transmission Loss

  Transmission Loss provides access to the transmission loss calculated by Wwise Spatial Audio when using sound propagation with rooms and portals or with geometry.

  In order to receive this built-in parameter, the Diffraction and Transmission check box of the Positioning tab of the Property Editor must be selected, and the emitter and listener must be either in separate Rooms connected by one or more Portals (enabled or not), or obstructed by geometry that was passed to Wwise Spatial Audio.

  Transmission Loss is computed for the ray that connects the emitter and listener directly. The Transmission Loss of geometry is defined on geometry (AkAcousticSurface::transmissionLoss), while the Transmission Loss of rooms is defined on Rooms (AkRoomParams::TransmissionLoss). It has a range from 0 to 100.

  The highest value is used across the emitter's and listener's rooms, and all geometry surfaces crossed.

  Note

  Although the Transmission Loss is taken from the ray corresponding to the direct path, Wwise does not allow signal processing of rays independently, except when using Attenuation curves or project-wide Obstruction and Occlusion. For example, if there is a diffraction path in parallel with the transmission path, and you want to control a property on the sound or on an Effect using the built-in Transmission Loss RTPC, this property will be applied to the signal that is the result of the sum of the transmission and diffraction paths, which is probably not the desired effect. This has to be taken into consideration. For this reason, it is better to rely on Attenuation Curves to handle volume and filtering due to Transmission Loss.

Related Topics

• Creating a Game Parameter

• Defining the Range of Values for a Game Parameter

• Deleting a Game Parameter