Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

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

AudioSource.spread

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
public var spread: float;
public float spread;

Description

Sets the spread angle (in degrees) of a 3d stereo or multichannel sound in speaker space.

0 = all sound channels are located at the same speaker location and is 'mono'. 360 = all subchannels are located at the opposite speaker location to the speaker location that it should be according to 3D position. Default = 0.

    // when any AudioSource goes trough this transform, it will set it as 'mono'
    // and will restore the value to 3D effect after exiting
    // Make sure the audio source has a collider.
    function OnTriggerEnter(other : Collider) {
        var audio = other.GetComponent.<AudioSource>();

if(audio) audio.spread = 0; }

function OnTriggerExit(other : Collider) { var audio = other.GetComponent.<AudioSource>();

if(audio) audio.spread = 360; }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void OnTriggerEnter(Collider other) { AudioSource audio = other.GetComponent<AudioSource>(); if (audio) audio.spread = 0; } void OnTriggerExit(Collider other) { AudioSource audio = other.GetComponent<AudioSource>(); if (audio) audio.spread = 360; } }

Did you find this page useful? Please give it a rating: