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 SDK 2023.1.9
Rooms and Portals

The Rooms and Portals system is the primary mechanism to model the propagation of reverberation in Wwise Spatial Audio.

With Wwise Spatial Audio, late reverberation is designed using reverb Effects and auxiliary sends. Wwise Spatial Audio supports this workflow by exposing a simple, high-level geometry abstraction called Rooms and Portals, which allows it to efficiently model sound propagation of emitters located in other rooms. The main features of room-driven sound propagation are diffraction, coupling and spatialization of reverbs, as well as smooth transitions between neighboring environments. It does so by leveraging the tools at the disposal of the sound designer in Wwise, giving them full control of the resulting transformations to audio. The sound designer is responsible for designing individual environments. At runtime, Wwise Spatial Audio dynamically combines these environments and modulates parameters according the the position of the listener, sound emitters, as well as the location of rooms and portals in the world to create a rich and realistic experience.

A Spatial Audio Room is a symbolic representation of a distinct acoustic environment within the simulation. Outdoor spaces, for example, are also considered Rooms. Rooms are connected to one another using Portals, which define small, rectangular apertures through which sound can propagate.

Spatial Audio automatically handles various complex interactions between Emitter and Listener Game Objects and Rooms. Spatial Audio assigns each Room to a Game Object, and manages auxiliary send connections between Emitter and Room Game Object. Because each Room is assigned to a separate Game Object from the Emitter and Listener, Room reverb and ambience can be rendered with distinct 3D panning and spatialization parameters, and the Room can also be shared by all sound emitters inside. The reverb of a Room that is adjacent to the listener is rendered as if it were propagating through nearby openings, defined as Portals. Spatial Audio does so by creating sound positions, located at portal openings, to spatialize the reverb. The adjacent Room has an auxiliary send to the listener's room, forming a chain of coupled Rooms. The Room that contains the listener inside is rendered as a 3D sound field that envelops the listener. The orientation of the Room Game Object is distinct from that of the listener. The Room's sound field is rotated relative to the listener's orientation, which anchors the sound in the world instead of being fixed to the listener's head.

If rectangular Portals do not sufficiently describe the interface between Rooms, Reverb Zones can be used to model complex coupling between acoustic environments. Refer to Using Reverb Zones. With the exception of Reverb Zones, which require geometry to define transition regions, Rooms do not require geometry to be sent to Wwise. However, providing geometry in combination with Rooms and Portals provides a more detailed simulation, and permits diffraction around obstacles as well as diffraction through portals. Refer to Using the Geometry API for Simulating Diffraction and Transmission.

Spatial Audio uses the Rooms and Portals network to modulate the distance traveled by the sound, the apparent incident position, and the diffraction angle. The diffraction angle is mapped to a diffraction percentage value on the emitter game object and/or to a built-in game parameter called Diffraction, which designers can bind to properties (such as volume and low-pass filtering) using RTPCs.

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