Version: 2019.1 (switch to 2018.4
LanguageEnglish
  • C#

DownloadHandlerAudioClip

class in UnityEngine.Networking

/

Inherits from:Networking.DownloadHandler

/

Implemented in:UnityEngine.UnityWebRequestAudioModule

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

Description

A DownloadHandler subclass specialized for downloading audio data for use as AudioClip objects.

DownloadHandlerAudioClip stores received data in a pre-allocated Unity AudioClip object. It is optimized for downloading audio data from Web servers, and may perform audio data decompression and decoding on a worker thread.

For use cases where you wish to download an audio clip via HTTP and use it as an AudioClip within Unity, usage of this class is strongly recommended.

Properties

audioClipReturns the downloaded AudioClip, or null. (Read Only)
compressedCreate AudioClip that is compressed in memory.
streamAudioCreate streaming AudioClip.

Constructors

DownloadHandlerAudioClipConstructor, specifies what kind of audio data is going to be downloaded.

Protected Methods

GetDataCalled by DownloadHandler.data. Returns a copy of the downloaded clip data as raw bytes.

Static Methods

GetContentReturns the downloaded AudioClip, or null.

Inherited Members

Properties

dataReturns the raw bytes downloaded from the remote server, or null. (Read Only)
isDoneReturns true if this DownloadHandler has been informed by its parent UnityWebRequest that all data has been received, and this DownloadHandler has completed any necessary post-download processing. (Read Only)
textConvenience property. Returns the bytes from data interpreted as a UTF8 string. (Read Only)

Public Methods

DisposeSignals that this DownloadHandler is no longer being used, and should clean up any resources it is using.

Protected Methods

CompleteContentCallback, invoked when all data has been received from the remote server.
GetProgressCallback, invoked when UnityWebRequest.downloadProgress is accessed.
GetTextCallback, invoked when the text property is accessed.
ReceiveContentLengthHeaderCallback, invoked with a Content-Length header is received.
ReceiveDataCallback, invoked as data is received from the remote server.

Did you find this page useful? Please give it a rating: