AudioSettings
Controls the global audio settings from script.
Read time 2 minutesLast updated 4 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.AudioModule
public sealed class AudioSettings
Remarks
Setup speaker output and format.
Static Properties
Property | Description |
|---|---|
| audioSpatialExperience | Determines if the Unity app's final mixed audio stream is spatialized. |
| driverCapabilities | Returns the speaker mode capability of the current audio driver. (Read Only) |
| dspTime | Returns the current time of the audio system. |
| outputSampleRate | Get the mixer's current output rate. |
| speakerMode | |
Static Methods
Method | Description |
|---|---|
| GetConfiguration | Returns the current configuration of the audio device and system. The values in the struct may then be modified and reapplied via AudioSettings.Reset. |
| GetDSPBufferSize | Get the mixer's buffer size in samples. |
| GetSpatializerPluginName | Returns the name of the spatializer selected on the currently-running platform. |
| GetSpatializerPluginNames | Returns an array with the names of all the available spatializer plugins. |
| Reset | Changes the device configuration and invokes the AudioSettings.OnAudioConfigurationChanged delegate with the argument |
| SetSpatializerPluginName | Sets the spatializer plugin for all platform groups. If a null or empty string is passed in, the existing spatializer plugin will be cleared. |
Static Events
Member | Description |
|---|---|
| OnAudioConfigurationChanged | Unity calls this event whenever the global audio settings change. |
Classes
Class | Description |
|---|---|
| AudioSettings.Mobile | This class encapsulates properties and methods to handle audio output thread on iOS/Android. |
Delegates
Delegate | Description |
|---|---|
| AudioSettings.AudioConfigurationChangeHandler | A delegate called whenever the global audio settings are changed, either by AudioSettings.Reset or by an external device change such as the OS control panel changing the sample rate or because the default output device was changed, for example when plugging in an HDMI monitor or a USB headset. |