enumeration
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.
CloseValue describes the current load state of the audio data associated with an AudioClip.
This enumeration is useful if you want to:
Use AudioClip.LoadAudioData and AudioClip.UnloadAudioData to load and unload the audio data of the AudioClip.
Additional resources: AudioClip.loadState, AudioClip.UnloadAudioData.
// If you click the button, it will load and play the sound you attach to this GameObject. // If you click the button again, the sound will stop and the audio data will unload. // Assign this script to a GameObject and assign a Button and an AudioClip in the Inspector.
using UnityEngine; using System.Collections; using UnityEngine.UI; using TMPro;
public class AudioDataLoadStateExample : MonoBehaviour { public Button playButton; public AudioClip audioClip; TextMeshProUGUI buttonText; AudioSource audioSource;
void Awake() { // Create and attach an AudioSource to the GameObject to play the audio. audioSource = gameObject.AddComponent<AudioSource>();
if (audioClip != null) { audioSource.clip = audioClip;
if (playButton != null) { buttonText = playButton.GetComponentInChildren<TextMeshProUGUI>(); buttonText.text = "Play";
playButton.onClick.AddListener(OnPlayStopButtonClicked); } else Debug.LogError("Button not assigned in Inspector."); } else Debug.LogError("AudioClip not assigned in Inspector."); }
void OnPlayStopButtonClicked() { // Load and play the audio if the audio isn't playing. if (audioSource.isPlaying == false) { if (!audioClip.preloadAudioData) { audioClip.LoadAudioData(); } StartCoroutine(CheckLoadAudioClip()); } // Button clicked in Stop state, so if the audio is playing, stop and unload. else { audioSource.Stop(); audioClip.UnloadAudioData(); // Don't want the audio to be playable again, so remove button. playButton.gameObject.SetActive(false); } }
private IEnumerator CheckLoadAudioClip() { // Check if the audio clip has finished loading. while (audioClip.loadState == AudioDataLoadState.Loading) { Debug.Log($"AudioClip {audioClip.name} is still loading..."); yield return null; }
switch (audioClip.loadState) { case AudioDataLoadState.Unloaded: { Debug.Log($"AudioClip {audioClip.name} is still unloaded."); break; } case AudioDataLoadState.Failed: { Debug.Log($"AudioClip {audioClip.name} failed to load."); break; } case AudioDataLoadState.Loaded: { Debug.Log($"AudioClip {audioClip.name} is fully loaded."); audioSource.Play(); buttonText.text = "Stop"; break; } } } }
Unloaded | Value returned by AudioClip.loadState for an AudioClip that has no audio data loaded and where loading has not been initiated yet. |
Loading | Value returned by AudioClip.loadState for an AudioClip that is currently loading audio data. |
Loaded | Value returned by AudioClip.loadState for an AudioClip that has succeeded loading its audio data. |
Failed | Value returned by AudioClip.loadState for an AudioClip that has failed loading its audio data. |
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.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.