Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

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

UnityWebRequest.GetAudioClip

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

public static function GetAudioClip(uri: string, audioType: AudioType): Networking.UnityWebRequest;
public static Networking.UnityWebRequest GetAudioClip(string uri, AudioType audioType);

Parameters

uri The URI of the audio clip to download.
audioType The type of audio encoding for the downloaded audio clip. See AudioType.

Returns

UnityWebRequest A UnityWebRequest properly configured to download an audio clip and convert it to an AudioClip.

Description

Create a UnityWebRequest intended to download an audio clip via HTTP GET and create an AudioClip based on the retrieved data.

This method creates a UnityWebRequest and sets the target URL to the string uri argument. This method sets no other flags or custom headers.

This method attaches a DownloadHandlerAudioClip object to the UnityWebRequest. DownloadHandlerAudioClip is a specialized DownloadHandler which is optimized for storing data which is to be used as an audio clip in the Unity Engine. Using this class significantly reduces memory reallocation compared to downloading raw bytes and creating an audio clip manually in script.

This method attaches no UploadHandler to the UnityWebRequest.

no example available in JavaScript
using UnityEngine;
using UnityEngine.Networking;
using System.Collections;
 
class MyBehaviour: public MonoBehaviour {
    void Start() {
        StartCoroutine(GetAudioClip());
    }
 
    IEnumerator GetAudioClip() {
        using(UnityWebRequest www = UnityWebRequest.GetAudioClip("http://www.my-server.com/audio.ogg", AudioType.OGGVORBIS)) {
            yield return www.Send();
     
            if(www.isError) {
                Debug.Log(www.error);
            }
            else {
                AudioClip myClip = DownloadHandlerAudioClip.GetContent(www);
            }
        }
    }
}