Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

WWW.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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public function GetAudioClip(threeD: bool): AudioClip;
public AudioClip GetAudioClip(bool threeD);
public def GetAudioClip(threeD as bool) as AudioClip
public function GetAudioClip(threeD: bool, stream: bool): AudioClip;
public AudioClip GetAudioClip(bool threeD, bool stream);
public def GetAudioClip(threeD as bool, stream as bool) as AudioClip
public function GetAudioClip(threeD: bool, stream: bool, audioType: AudioType): AudioClip;
public AudioClip GetAudioClip(bool threeD, bool stream, AudioType audioType);
public def GetAudioClip(threeD as bool, stream as bool, audioType as AudioType) as AudioClip

Parameters

threeD Use this to specify whether the clip should be a 2D or 3D clip the .audioClip property defaults to 3D.
stream Sets whether the clip should be completely downloaded before it's ready to play (false) or the stream can be played even if only part of the clip is downloaded (true). The latter will disable seeking on the clip (with .time and/or .timeSamples). Note that streaming variable bit rate (VBR) audio is not supported and the playback might finish untimely.
audioType The AudioType of the content your downloading. If this is not set Unity will try to determine the type from URL.

Description

Returns an AudioClip generated from the downloaded data (Read Only).

The data must be an audio clip in Ogg(Web/Standalones), MP3(phones) or WAV. Note that the XM, IT, MOD or S3M format can also be streamed in, but realtime playback of these is not supported, because all the data must be present before playback can begin, so for these tracker formats AudioClip.isReadyToPlay must switch to true before the clip may be assigned to and AudioSource and played back.

Copyright © 2014 Unity Technologies
LearnCommunityAsset StoreBuyDownload