Version
|
Wwise Unity Integration Documentation
|
This component 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. More...
Inherits MonoBehaviour.
Public Member Functions | |
| void | SetReverbZone () |
| Calls AkReverbZone::SetReverbZone() with this component's properties More... | |
| void | RemoveReverbZone () |
| Calls AkReverbZone::RemoveReverbZone() with this component's properties More... | |
Static Public Member Functions | |
| static void | SetReverbZone (AkRoom reverbZone, AkRoom parentRoom, float transitionRegionWidth) |
| Establish a parent-child relationship between two Rooms. Sound propagate between a Reverb Zone and its parent as if they were the same Room, without the need for a connecting Portal. Examples of 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. If a Room is already assigned to a parent Room, it is first be removed from the original parent (exactly as if RemoveReverbZone were called) before it is assigned to the new parent Room. The automatically created 'Outdoors' Room is commonly used as a parent Room for Reverb Zones, since they often model open spaces. Calls AkRoom::SetReverbZone() from the Reverb Zone AkRoom component with the Parent Room and transition Region Width parameters. More... | |
| static void | RemoveReverbZone (AkRoom reverbZone) |
| Remove a Reverb Zone from its parent. Sound can no longer propagate between the two Rooms, unless they are explicitly connected with a Portal. Calls AkRoom::RemoveReverbZone() from the Reverb Zone AkRoom component. More... | |
Public Attributes | |
| AkRoom | ReverbZone |
| AkRoom | ParentRoom |
| float | TransitionRegionWidth = 1.0f |
| Width of the transition region between the Reverb Zone and its parent. The transition zone is centered around the Reverb Zone geometry. It only applies where triangle transmission loss is set to 0. More... | |
This component 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 can have multiple Reverb Zones, but a Reverb Zone can only have a single Parent. A Room cannot be its own parent.
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise