Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

AudioSettings.speakerMode

static var speakerMode: AudioSpeakerMode;
static AudioSpeakerMode speakerMode;
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