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.
CloseEnable this property to automatically play the audio source when the component or GameObject becomes active.
If you enable this property and the GameObject isn't active or if the AudioSource component is disabled, the audio won't play until they become active. While this property is enabled, if you disable then enable the GameObject or the audio source, the audio will stop and then play again from the start. If you set this property to false, the audio doesn't play. In this case, you need to use AudioSource.Play to play the audio.
// This script creates and attaches an audio source to the GameObject and disables playOnAwake. // This means the audio won't play on launch, instead you need to press the button this script creates to play the audio. // Make sure to assign an audio clip in the Inspector.
using UnityEngine;
public class PlayOnAwakeExample : MonoBehaviour { AudioSource audioSource; public AudioClip audioClip;
void Awake() { audioSource = gameObject.AddComponent<AudioSource>(); audioSource.playOnAwake = false; audioSource.clip = audioClip; }
void OnGUI() { if(GUI.Button(new Rect(10, 70, 150, 30), "Play")) { audioSource.Play(); } } }
// This script creates 2 toggles - 1 changes the status of AudioSource.playOnAwake, the other activates or deactivates the audio source component. // If you deactivate Enable audio source, any audio that is currently playing will stop. // If you enable Play on Awake and activate Enable audio source, the audio will play from the start. // If you disable Play on Awake, the audio will not play when you activate the audio source.
// For this script to work, attach the script and an AudioSource component to a GameObject in your Scene. // Also assign an audio resource to the AudioSource so it has audio to play.
using UnityEngine;
[RequireComponent(typeof(AudioSource))] public class PlayOnAwakeExample : MonoBehaviour { AudioSource audioSource;
void Awake() { audioSource = GetComponent<AudioSource>(); }
void OnGUI() { // Toggles that change the status of AudioSource.playOnAwake and AudioSource.enabled. audioSource.playOnAwake = GUI.Toggle(new Rect(10, 0, 150, 30), audioSource.playOnAwake, "Play on Awake"); audioSource.enabled = GUI.Toggle(new Rect(10, 70, 150, 30), audioSource.enabled, "Enable audio source"); } }
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.