Version: 2022.2
LanguageEnglish
  • C#

AudioSettings.Reset

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

Declaration

public static bool Reset(AudioConfiguration config);

Parameters

config The new configuration to be used.

Returns

bool True if all settings could be successfully applied.

Description

Performs 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 an attempt is made to use the closest match supported by the system.

using UnityEngine;
using System.Collections;

public class TestAudioConfiguration : MonoBehaviour { void Start() { AudioSettings.OnAudioConfigurationChanged += OnAudioConfigurationChanged; }

void OnAudioConfigurationChanged(bool deviceWasChanged) { Debug.Log(deviceWasChanged ? "Device was changed" : "Reset was called"); if (deviceWasChanged) { AudioConfiguration config = AudioSettings.GetConfiguration(); config.dspBufferSize = 64; AudioSettings.Reset(config); } GetComponent<AudioSource>().Play(); }

static int[] validSpeakerModes = { (int)AudioSpeakerMode.Mono, (int)AudioSpeakerMode.Stereo, (int)AudioSpeakerMode.Quad, (int)AudioSpeakerMode.Surround, (int)AudioSpeakerMode.Mode5point1, (int)AudioSpeakerMode.Mode7point1 };

static int[] validDSPBufferSizes = { 32, 64, 128, 256, 340, 480, 512, 1024, 2048, 4096, 8192 };

static int[] validSampleRates = { 11025, 22050, 44100, 48000, 88200, 96000, };

static int[] validNumRealVoices = { 1, 2, 4, 8, 16, 32, 50, 64, 100, 128, 256, 512, };

static int[] validNumVirtualVoices = { 1, 2, 4, 8, 16, 32, 50, 64, 100, 128, 256, 512, };

int GUIRow(string name, int[] valid, int value, ref bool modified) { GUILayout.BeginHorizontal(); GUILayout.Button(name + "=" + value); for (int i = 0; i < valid.Length; i++) { string s = valid[i].ToString(); if (valid[i] == value) s = "[" + s + "]"; if (GUILayout.Button(s)) { value = valid[i]; modified = true; } } GUILayout.EndHorizontal(); return value; }

void OnGUI() { AudioSource source = GetComponent<AudioSource>(); bool modified = false;

AudioConfiguration config = AudioSettings.GetConfiguration();

config.speakerMode = (AudioSpeakerMode)GUIRow("speakerMode", validSpeakerModes, (int)config.speakerMode, ref modified); config.dspBufferSize = GUIRow("dspBufferSize", validDSPBufferSizes, config.dspBufferSize, ref modified); config.sampleRate = GUIRow("sampleRate", validSampleRates, config.sampleRate, ref modified); config.numRealVoices = GUIRow("RealVoices", validNumRealVoices, config.numRealVoices, ref modified); config.numVirtualVoices = GUIRow("numVirtualVoices", validNumVirtualVoices, config.numVirtualVoices, ref modified);

if (modified) AudioSettings.Reset(config);

if (GUILayout.Button("Start")) source.Play();

if (GUILayout.Button("Stop")) source.Stop(); } }