Version

menu_open
Wwise SDK 2023.1.3

◆ SetReverbZone()

AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetReverbZone ( AkRoomID  in_ReverbZone,
AkRoomID  in_ParentRoom,
AkReal32  in_transitionRegionWidth 
)

Use a Room as a Reverb Zone. AK::SpatialAudio::SetReverbZone establishes a parent-child relationship between two Rooms and allows for sound propagation between them as if they were the same Room, without the need for a connecting Portal. Setting a Room as a Reverb Zone is useful in situations where two or more acoustic environments are not easily modeled as closed rooms connected by portals. Possible uses for Reverb Zones include: a covered area with no walls, a forested area within an outdoor space, or any situation where multiple reverb effects are desired within a common space. Reverb Zones have many advantages compared to standard Game-Defined Auxiliary Sends. They are part of the wet path, and form reverb chains with other Rooms; they are spatialized according to their 3D extent;
they are also subject to other acoustic phenomena simulated in Wwise Spatial Audio, such as diffraction and transmission. A parent Room may have multiple Reverb Zones, but a Reverb Zone can only have a single Parent. If a Room is already assigned to a parent Room, it will first be removed from the old parent (exactly as if AK::SpatialAudio::RemoveReverbZone were called) before then being assigned to the new parent Room. A Room can not be its own parent. The Reverb Zone and its parent are both Rooms, and as such, must be specified using AK::SpatialAudio::SetRoom. If AK::SpatialAudio::SetReverbZone is called before AK::SpatialAudio::SetRoom, and either of the two rooms do not yet exist, placeholder Rooms with default parameters are created. They should be subsequently parameteized with AK::SpatialAudio::SetRoom.

To set which Reverb Zone a Game Object is in, use the AK::SpatialAudio::SetGameObjectInRoom API, and pass the Reverb Zone's Room ID. In Wwise Spatial Audio, a Game Object can only ever be inside a single room, and Reverb Zones are no different in this regard.

Note: The automatically created 'outdoors' Room is commonly used as a parent Room for Reverb Zones, since they often model open spaces. To attach a Reverb zone to outdoors, pass AK::SpatialAudio::kOutdoorRoomID as the in_ParentRoom argument. Like all Rooms, the 'outdoors' Room can be parameterized (for example, to assign a reverb bus) by passing AK::SpatialAudio::kOutdoorRoomID to AK::SpatialAudio::SetRoom.
See also

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