Meta Developers

Meta XR Audio SDK Unity v69 Reference Guide

Unity

Select your SDK

MetaXRAudioSourceExperimentalFeatures Class

Extends MonoBehaviour

Member Enumerations

Enumeration DirectivityPatternType

None	No directivity applied. Omnidirectional radiation pattern. Effectively disables any directivity processing.
HumanVoice	Directivity pattern that most closely matches the radiation pattern of the human mouth/head.

Properties

float HrtfIntensity[Get]

HRTF intensity for audio source [0.0, 1.0], Default = 1.0.

HRTF intensity provides a control to fade between rendering the direct sound using a perceptually-guided panning law (when this parameter is 0.0) versus full HRTF convolution (when this parameter is 1.0). This can be useful to reduce what some users perceive as coloration caused by HRTF convolution at the expense of spatial localization accuracy of the listener.Note the interaural time delay (ITD) and interaural level differences (ILD) are the same for any setting of HRTF intensity.

float VolumetricRadius[Get]

Volumetric radius (in meters) of the sound source. [0,+Inf), Default = 0m.

This parameter simulates sound sources that are no just points, but whose radiator occupies a volume of space. Note, if increased too large, users may end up inside the radius if the sound source is too close.

float EarlyReflectionsSendDb[Get]

Additional gain applied to early reflections for this audio source only. [-60dB, 20dB], Default = 0dB.

The direct sound and late reverberation levels are not affected by this setting. This setting only applies if MetaXRAudioSource::EnableAcoustics is enabled.

See Also:

MetaXRAudioSource::EnableAcoustics for enabling/disabling acoustics.

See Also:

MetaXRAudioSource::GainBoostDb for a gain that simultaneously applies to the direct sound, early reflections, and late reverberation.

See Also:

MetaXRAudioSource::ReverbSendDb for a gain that applies only to the late reverberation.

float ReverbReach[Get]

Adjust the affect of distance on the late reverberation level. [0, 1], Default = 0.5.

When 0, moving away from the source will attenuate the late reverberation in the same way as the direct sound is attenuated with distance. When 1, moving away from the source will attenuate the late reverberation to a lesser degree than the direct sound. This means that the direct-to-reverberant ratio of the audio source will change, and moving further away will make the object sound "wetter". 0.5 is the most realistic setting and the default.

float OcclusionIntensity[Get]

Adjust how much occlusion to apply with 1 being complete occlusion and 0 being no occlusion [0, 1], Default = 1.0f.

When 0, the source will sound as if there is no occlusion even if there is an obstruction. When 1, no direct sound will propagate from the source if there is obstruction between the source and listener. 1 is the most realistic setting and the default.

float DirectivityIntensity[Get]

Intensity controller for Directivity, [0, 1], Default = 1.0.

When 0, even if directivity is enabled and a non-omnidirection pattern is selected, the directivity will be that of an omnidirectional radiator. When 1, the directivity pattern selected will be fully applied. Intermediate values allow the user to crossfade between the two (i.e. smoothly transition from an omnidirectional radiator to the chosen directivity pattern).

See Also:

DirectivityPatternType for the available directivity patterns.

See Also:

DirectivityPattern for controlling which pattern is applied to this audio source.

DirectivityPatternType DirectivityPattern[Get]

Select various directivity patterns to apply to this audio source.

See Also:

DirectivityPatternType for the available directivity patterns.

See Also:

DirectivityPattern for controlling which pattern is applied to this audio source.

bool DirectSoundEnabled[Get]

Enable/disable the direct sound and early reflections for an audio source.

When enabled, the audio source will have it's direct sound rendered in addition to early reflections and late reverberations (assuming MetaXRAudioSource::EnableAcoustics is enabled). When disabled, only the late reverberation is rendered (again, assuming MetaXRAudioSource::EnableAcoustics is enabled, otherwise the source will be silent).

Member Functions

void UpdateParameters ( )

Sync all the member variables of this class with the spatializer plug-in instance associated with this sound source.

This function should be called during every call to Update and so there should be no need to call this explicitly unless you want to force sync the spatializer instance's parameters with this component.

Did you find this page helpful?