GetAudioClip
Create a UnityWebRequest to download an audio clip via HTTP GET and create an AudioClip based on the retrieved data.
Read time 2 minutesLast updated 11 days ago
Definition
- Type: Method
- Namespace: UnityEngine.Networking
- Assembly: UnityEngine.UnityWebRequestAudioModule
GetAudioClip(string, AudioType)
Create a UnityWebRequest to download an audio clip via HTTP GET and create an AudioClip based on the retrieved data.
public static UnityWebRequest GetAudioClip(string uri, AudioType audioType)
Parameters
Returns
Type | Description |
|---|---|
| UnityWebRequest | A UnityWebRequest properly configured to download an audio clip and convert it to an AudioClip. |
Remarks
This method creates a UnityWebRequest and sets the target URL to the string argument. This method sets no other flags or custom headers.
uriThis method attaches a DownloadHandlerAudioClip object to the UnityWebRequest. DownloadHandlerAudioClip is a specialized DownloadHandler. It 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.
Examples
using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehaviour : MonoBehaviour{ void Start() { StartCoroutine(GetAudioClip()); } IEnumerator GetAudioClip() { using (UnityWebRequest www = UnityWebRequestMultimedia.GetAudioClip("https://www.my-server.com/audio.ogg", AudioType.OGGVORBIS)) { yield return www.SendWebRequest(); if (www.result == UnityWebRequest.Result.ConnectionError) { Debug.Log(www.error); } else { AudioClip myClip = DownloadHandlerAudioClip.GetContent(www); } } }}
GetAudioClip(Uri, AudioType)
Create a UnityWebRequest to download an audio clip via HTTP GET and create an AudioClip based on the retrieved data.
public static UnityWebRequest GetAudioClip(Uri uri, AudioType audioType)
Parameters
Returns
Type | Description |
|---|---|
| UnityWebRequest | A UnityWebRequest properly configured to download an audio clip and convert it to an AudioClip. |
Remarks
This method creates a UnityWebRequest and sets the target URL to the string argument. This method sets no other flags or custom headers.
uriThis method attaches a DownloadHandlerAudioClip object to the UnityWebRequest. DownloadHandlerAudioClip is a specialized DownloadHandler. It 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.
Examples
using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehaviour : MonoBehaviour{ void Start() { StartCoroutine(GetAudioClip()); } IEnumerator GetAudioClip() { using (UnityWebRequest www = UnityWebRequestMultimedia.GetAudioClip("https://www.my-server.com/audio.ogg", AudioType.OGGVORBIS)) { yield return www.SendWebRequest(); if (www.result == UnityWebRequest.Result.ConnectionError) { Debug.Log(www.error); } else { AudioClip myClip = DownloadHandlerAudioClip.GetContent(www); } } }}