Language: English
  • C#
  • JS
  • Boo

Script language

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

AudioSettings.speakerMode

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

Sumbission failed

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

Close

Cancel

public static var speakerMode: AudioSpeakerMode;
public static AudioSpeakerMode speakerMode;
public static speakerMode as AudioSpeakerMode

Description

Sets or gets the current speaker mode. Default is 2 channel stereo.

Be aware that the audio system is restarted when a new speaker mode is set. This means that playback on all AudioSources is stopped; any sounds that should be continuous (such as music) will need to be started again after the speaker mode is changed. If a speaker mode is set beyond the drivers capability, the audio behaviour is undefined. Use AudioSettings.driverCaps to get the capabilities of the current driver.

	// To set the speaker mode to that of the system settings.

AudioSettings.speakerMode = AudioSettings.driverCaps;
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Example() {
        AudioSettings.speakerMode = AudioSettings.driverCaps;
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Example() as void:
		AudioSettings.speakerMode = AudioSettings.driverCaps