API reference

MetaXRAudioSettings Class

Extends ScriptableObject
This class exposes controls for the Meta XR Audio plugin at a project level You can use this class to programmatically control the acoustics settings for the entire project at runtime. Note any changes made to this data struct will not be written do disk and thus not persist across game loads. Any settings that intended to persist across game loads should be done in the project settings window under the "Meta XR Acoustics" panel. Use MetaXRAudioSettings.Instance to gain access to the singleton instance of the global project settings.

Fields

Maximum number of mono or ambisonic sources available for use. [1,+Inf)
If the application creates more objects than are available, the oldest voice (i.e. the one that has been playing the longest) is silenced and the channel is reused for the next voice.This values is used in MetaXRAudioSource::OnBeforeSceneLoadRuntimeMethod via the MetaXRAudioSettings::Instance field. As such, in order that the value you set persists across game sessions, you should only ever set this value on that static instance, or the object serialized at Assets/Resources/MetaXRAudioSettings.asset.

Properties

The global plug-in settings as loaded from disk.
This value is null until first access. On first access, it is read from Assets/Resources/MetaXRAudioSettings.asset.If that file doesn't exist, it will be created and populated with defaults.You can create the asset in the content browser manually and as long as it is named correctly and at the correct path, the settings in that asset are the ones used/applied.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon