DownloadHandler
Manage and process HTTP response body data received from a remote server.
Read time 1 minuteLast updated 4 days ago
Definition
- Type: Class
- Namespace: UnityEngine.Networking
- Assembly: UnityEngine.UnityWebRequestModule
- Implements: IDisposable
public class DownloadHandler : IDisposable
Remarks
DownloadHandler objects are helper objects. When attached to a UnityWebRequest, they define how to handle HTTP response body data received from a remote server. Generally, they are used to buffer, stream and/or process response bodies.
DownloadHandler is a base class. Depending on usage scenario, different specialized classes are available. DownloadHandlerBuffer provides basic buffering, while DownloadHandlerTexture and DownloadHandlerAssetBundle provide more efficient solutions for Texture and AssetBundle downloads.
For custom use cases, see DownloadHandlerScript.
Additional Resources: UnityWebRequest, DownloadHandlerBuffer, DownloadHandlerTexture, DownloadHandlerAudioClip, DownloadHandlerAssetBundle, DownloadHandlerScript.
Properties
Property | Description |
|---|---|
| data | Returns the raw bytes downloaded from the remote server, or |
| error | Error message describing a failure that occurred inside the download handler. |
| isDone | Returns |
| nativeData | Provides direct access to downloaded data. |
| text | Convenience property. Returns the bytes from DownloadHandler.data interpreted as a UTF8 string. (Read Only) |
Methods
Method | Description |
|---|---|
| CompleteContent | Callback, invoked when all data has been received from the remote server. |
| Dispose | Signals that this DownloadHandler is no longer being used, and should clean up any resources it is using. |
| GetData | Callback, invoked when the DownloadHandler.data property is accessed. |
| GetNativeData | Provides allocation-free access to the downloaded data as a NativeArray. |
| GetProgress | Callback, invoked when UnityWebRequest.downloadProgress is accessed. |
| GetText | Callback, invoked when the DownloadHandler.text property is accessed. |
| ReceiveContentLengthHeader | Callback, invoked with a |
| ReceiveData | Callback, invoked as data is received from the remote server. |