Version
menu
Wwise SDK 2025.1.0
List of all members | Public Attributes
AkCmd_SA_SetRoom Struct Reference

#include <AkCommandTypes.h>

Public Attributes

AkRoomID roomID
 Unique room ID, chosen by the client. More...
 
struct AkRoomParams params
 Parameter for the room. More...
 

Detailed Description

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.

Warning: The ID (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_OUTDOORS_ROOM_ID (-1) in order to customize its AkRoomParams, to provide a valid auxiliary bus, for example.

Optionally, you can associate a name to the room for profiling purposes. Call AK_CommandBuffer_AddString after adding the command to attach a name to the room: 

auto cmd = (AkCmd_SA_SetRoom*)AK_CommandBuffer_Add(buffer, AkCommand_SA_SetRoom);
// Fill command...
AK_CommandBuffer_AddString(buffer, "Bedroom 1");

This command can fail for the following reasons:

  • AK_InvalidParameter: roomID is outside the valid range
  • AK_InsufficientMemory: Not enough memory to complete the operation.
See also

Definition at line 1119 of file AkCommandTypes.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