Version

menu_open
Wwise SDK 2022.1.12

◆ RoomGameObj_KeepRegistered

bool AkRoomParams::RoomGameObj_KeepRegistered

If set to true, the room game object is registered on calling SetRoom(), and not released until the room is deleted or removed with RemoveRoom(). If set to false, Spatial Audio registers the room object only when it is needed by the sound propagation system for the purposes of reverb, and unregisters the game object when all reverb tails are finished. We recommend that you set RoomGameObj_KeepRegistered to true if you use RTPCs on the room game object, if you call SetScalingFactor(), or call PostEvent() for the purpose of ambience or room tones.

Note: The room game object can be accessed through the ID that is passed to SetRoom() and the AkRoomID::AsGameObjectID() method. Posting an event on the room game object uses automatic room game object placement by Spatial Audio so that when the listener is inside the room, the sound comes from all around the listener, and when the listener is outside the room, the sound comes from the portal(s). Typically, this would be used for surround ambience beds or room tones. For point source sounds, use separate game objects that are registered as Spatial Audio emitters.
See also

Definition at line 406 of file AkSpatialAudio.h.


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