VoiceParamOcclusion

class carb.audio.VoiceParamOcclusion

Bases: pybind11_object

The occlusion factors for a voice. This is valid when the `VOICE_PARAM_OCCLUSION_FACTOR` flag is used. These values control automatic low pass filters that get applied to the spatial sounds to simulate object occlusion between the emitter and listener positions.

Methods

__init__(self)

Attributes

direct	The occlusion factor for the direct path of the sound.
reverb	The occlusion factor for the reverb path of the sound.

__init__(

self: carb.audio._audio.VoiceParamOcclusion,

) → None

property direct

The occlusion factor for the direct path of the sound. This is the path directly from the emitter to the listener. This factor describes how occluded the sound’s path actually is. A value of 1.0 means that the sound is fully occluded by an object between the voice and the listener. A value of 0.0 means that the sound is not occluded by any object at all. This defaults to 0.0. This factor multiplies by `EntityCone.low_pass_filter`, if a cone with a non 1.0 `low_pass_filter` value is specified. Setting this to a value outside of [0.0, 1.0] will result in an undefined low pass filter value being used.

property reverb

The occlusion factor for the reverb path of the sound. This is the path taken for sounds reflecting back to the listener after hitting a wall or other object. A value of 1.0 means that the sound is fully occluded by an object between the listener and the object that the sound reflected off of. A value of 0.0 means that the sound is not occluded by any object at all. This defaults to 1.0.