Version

menu_open
Wwise SDK 2022.1.12

◆ SetMultipleObstructionAndOcclusion()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::SetMultipleObstructionAndOcclusion ( AkGameObjectID  in_EmitterID,
AkGameObjectID  in_uListenerID,
AkObstructionOcclusionValues in_fObstructionOcclusionValues,
AkUInt32  in_uNumOcclusionObstruction 
)

Sets a game object's obstruction and occlusion value for each position defined by AK::SoundEngine::SetMultiplePositions. This function differs from AK::SoundEngine::SetObjectObstructionAndOcclusion as a list of obstruction/occlusion pair is provided and each obstruction/occlusion pair will affect the corresponding position defined at the same index.

Note: In the case the number of obstruction/occlusion pairs is smaller than the number of positions, remaining positions' obstrucion/occlusion values are set to 0.0.
Returns
  • AK_Success if successful
  • AK_CommandTooLarge if the number of obstruction values is too large for the command queue.
  • AK_InvalidParameter if one of the parameter is out of range (check the debug console)
  • AK_InvalidFloatValue if one of the occlusion/obstruction values is NaN or Inf.
See also
Returns
AK_Success if occlusion/obstruction values are successfully stored for this emitter
Parameters
in_EmitterIDEmitter game object ID
in_uListenerIDListener game object ID
in_fObstructionOcclusionValuesArray of obstruction/occlusion pairs to apply ObstructionLevel: [0.0f..1.0f] OcclusionLevel: [0.0f..1.0f]
in_uNumOcclusionObstructionNumber of obstruction/occlusion pairs specified in the provided array

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