class in UnityEngine
/
Implemented in:UnityEngine.AudioModule
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.
CloseFor 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.
CloseControls the global audio settings from script.
Setup speaker output and format.
| Property | Description |
|---|---|
| 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 | AudioSettings.speakerMode is deprecated. Use AudioSettings.GetConfiguration and AudioSettings.Reset to adjust audio settings instead. |
| 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 deviceWasChanged=false. There's no guarantee that the exact settings specified are used, but Unity automatically uses the closest match that it supports. Note: This can cause main thread stalls if AudioSettings.Reset is called when objects are loading asynchronously. |
| 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. |
| Event | Description |
|---|---|
| OnAudioConfigurationChanged | Unity calls this delegate whenever the global audio settings change. |
| Delegate | Description |
|---|---|
| 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. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.