Wwise SDK 2023.1.5

◆ SetPortalObstructionAndOcclusion()

AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetPortalObstructionAndOcclusion ( AkPortalID  in_PortalID,
AkReal32  in_fObstruction,
AkReal32  in_fOcclusion 

Set the obstruction and occlusion value for a portal that has been registered with Spatial Audio. Portal obstruction simulates objects that block the direct sound path between the portal and the listener, but allows indirect sound to pass around the obstacle. For example, use portal obstruction when a piece of furniture is blocking the line of sight of the portal opening. Portal obstruction is applied on the connection between the emitter and the listener, and only affects the dry signal path. Portal occlusion simulates a complete blockage of both the direct and indirect sound through a portal. For example, use portal occlusion for opening or closing a door or window. Portal occlusion is applied on the connection between the emitter and the first room in the chain, as well as the connection between the emitter and listener. Portal occlusion affects both the dry and wet (reverberant) signal paths. To apply detailed obstruction to specific sound paths but not others, use AK::SpatialAudio::SetGameObjectToPortalObstruction and AK::SpatialAudio::SetPortalToPortalObstruction. To apply occlusion and obstruction to the direct line of sight between the emitter and listener use AK::SoundEngine::SetObjectObstructionAndOcclusion.

See also
in_PortalIDPortal ID.
in_fObstructionObstruction value. Valid range 0.f-1.f
in_fOcclusionOcclusion value. Valid range 0.f-1.f

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