Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

AudioSettings

class in UnityEngine

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

Controls the global audio settings from script.

Setup speaker output and format.

Static Properties

driverCapabilitiesReturns the speaker mode capability of the current audio driver. (Read Only)
dspTimeReturns the current time of the audio system.
outputSampleRateGet the mixer's current output rate.
speakerModeGets the current speaker mode. Default is 2 channel stereo.

Static Methods

GetConfigurationReturns the current configuration of the audio device and system. The values in the struct may then be modified and reapplied via AudioSettings.Reset.
GetDSPBufferSizeGet the mixer's buffer size in samples.
GetSpatializerPluginNameReturns the name of the spatializer selected on the currently-running platform.
GetSpatializerPluginNamesReturns an array with the names of all the available spatializer plugins.
ResetPerforms a change of the device configuration. In response to this the AudioSettings.OnAudioConfigurationChanged delegate is invoked with the argument deviceWasChanged=false. It cannot be guaranteed that the exact settings specified can be used, but the an attempt is made to use the closest match supported by the system.
SetSpatializerPluginNameSets the spatializer plugin for all platform groups. If a null or empty string is passed in, the existing spatializer plugin will be cleared.

Events

OnAudioConfigurationChangedA delegate called whenever the global audio settings are changed, either by AudioSettings.Reset or by an external factor 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.

Delegates

AudioConfigurationChangeHandlerA 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.