AkCmd_SA_SetPortal

Wwise SDK 2025.1.0

#include <AkCommandTypes.h>

Public Attributes
AkPortalID	portalID
	Unique portal ID, chosen by the client. More...

struct AkPortalParams	params
	Parameter for the portal. More...

Detailed Description

Add or update an acoustic portal. A portal is an opening that connects two or more rooms to simulate the transmission of reverberated (indirect) sound between the rooms. This function may be called multiple times with the same ID to update the parameters of the portal. The ID (portalID) 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 portals that use these IDs, and therefore must not collide.

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

auto cmd = (AkCmd_SA_SetPortal*)AK_CommandBuffer_Add(buffer, AkCommand_SA_SetPortal);
// Fill command...
AK_CommandBuffer_AddString(buffer, "Portal 1");

This command can fail for the following reasons:

AK_InvalidParameter: portalID or some portal parameters are not valid.
AK_InsufficientMemory: Not enough memory to complete the operation.

See also

Definition at line 1159 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.

Get started with Wwise

Wwise SDK