Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

WWW.GetAudioClip

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

Parameters

threeDUse this to specify whether the clip should be a 2D or 3D clip the .audioClip property defaults to 3D.
streamSets 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).
setThe 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.