Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2022.1.17.8543 ). 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 2022.1.17

◆ SetPortal()

AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetPortal ( AkPortalID  in_PortalID,
const AkPortalParams &  in_Params,
const char *  in_PortalName = nullptr 
)

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 (in_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.

See also
Parameters
in_PortalIDUnique portal ID, chosen by the client.
in_ParamsParameter for the portal.
in_PortalNameName used to identify portal (optional)

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