◆ SetRoom()

AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetRoom	(	AkRoomID	in_RoomID,
		const AkRoomParams &	in_Params,
		const char *	in_RoomName = `nullptr`
	)

Add or update a room. Rooms are used to connect portals and define an orientation for oriented reverbs. This function may be called multiple times with the same ID to update the parameters of the room.

dangerous Warning: The ID (in_RoomID) must be chosen in the same manner as AkGameObjectID's, as they are in the same ID-space. The spatial audio lib manages the registration/unregistration of internal game objects for rooms that use these IDs and, therefore, must not collide. Also, the room ID must not be in the reserved range (AkUInt64)(-32) to (AkUInt64)(-2) inclusively. You may, however, explicitly add the default room ID AK::SpatialAudio::kOutdoorRoomID (-1) in order to customize its AkRoomParams, to provide a valid auxiliary bus, for example.

See also

Parameters

in_RoomID	Unique room ID, chosen by the client.
in_Params	Parameter for the room.
in_RoomName	Name used to identify room (optional)

Wwise SDK

SetRoom

◆ SetRoom()

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.