Meta Developers

Xr-audio v68 Reference Guide

Unity

Select your SDK

Overview

MetaXRAudioSettings Class

Class used to manage the saving and loading of global plug-in settings.

MetaXRAudioSettings extends ScriptableObject.

Overview

Data Fields

int	voiceLimit`[Get]` Maximum number of mono or ambisonic sources available for use. [1,+Inf)

Properties

static MetaXRAudioSettings

Instance[Get]

The global plug-in settings as loaded from disk.

Details

Fields

int MetaXRAudioSettings.voiceLimit
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 you should only ever set this value on that static instance, or the object serialized at Assets/Resources/MetaXRAudioSettings.asset.

int MetaXRAudioSettings.voiceLimit

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 you should only ever set this value on that static instance, or the object serialized at Assets/Resources/MetaXRAudioSettings.asset.

Properties

MetaXRAudioSettings MetaXRAudioSettings.Instance
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.

MetaXRAudioSettings MetaXRAudioSettings.Instance

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?