Version
menu

Wwise SDK 2025.1.1
AkCmd_SA_SetPortalToPortalObstruction Struct Reference

#include <AkCommandTypes.h>

Public Attributes

AkPortalID portalID0
 Portal ID. More...
 
AkPortalID portalID1
 Portal ID. More...
 
AkReal32 obstruction
 Obstruction value. Valid range 0.f-1.f. More...
 

Detailed Description

Set the obstruction value of the path between two portals that has been created by Spatial Audio. The obstruction value is applied on one of the path segments of the sound between the emitter and the listener. Diffraction must be enabled on the sound for a diffraction path to be created. Also, there should not be any portals between the two provided ID parameters. The obstruction value is used to simulate objects between the portals that are obstructing the sound. Send an obstruction value of 0 to ensure the value is removed from the internal data structure.

This command can fail for the following reasons:

  • AK_InvalidParameter: portalID0 or portalID1 are not valid IDs, or obstruction is not within the accepted range.
See also

Definition at line 1492 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