ドキュメント

Unity Engine

Unity Engine

ウェブ リクエスト低レベル API リファレンス

低レベルのリクエストI を使用して、より上級者向けな HTTP 操作を実行します。
読み終わるまでの所要時間 10 分最終更新 5日前

高レベルのウェブリクエスト API は定型コードの必要性を最小限に抑えますが、低レベルのウェブリクエスト API は柔軟性とコントロールを提供します。
このセクションでは、低レベル API のキーメンバーと、それらが意図するシナリオを列挙します。一般に、低レベル API を使用するには、特定のダウンロードおよびアップロードのケース用に特殊な
DownloadHandler
または
UploadHandler
オブジェクトをアタッチする
UnityWebRequest
を作成する必要があります。
高レベル API と低レベル API は相互に排他的ではありません。一般的な操作をより細かくコントロールする必要がある場合は、高レベル API で作成された
UnityWebRequest
オブジェクトをいつでもカスタマイズできます。

UnityWebRequest オブジェクトのインスタンス化

UnityWebRequest
は、ほかのオブジェクトと同様にコンストラクタを通じてインスタンス化できます。アップロードハンドラーまたはダウンロードハンドラーの有無にかかわらず、
UnityWebRequest
を作成するためにいくつかのコンストラクター署名を使用できます。
UnityWebRequest
には、リクエストの設定、状態の追跡、結果の確認のためのプロパティーもあります。
詳細については、
UnityWebRequest
API リファレンス を参照してください。

ダウンロードハンドラー

専門的なダウンロードハンドラーを使用すると、特定のダウンロードケースを処理し、受信データの処理をコントロールできます。以下のダウンロードハンドラは、すべて基本
DownloadHandler
クラス専用です。

ハンドラータイプ

説明

DownloadHandlerBuffer
シンプル データ ストレージに使用されます。このダウンロードハンドラーは最も簡単で、ほとんどのユースケースを処理します。受信したデータをネイティブ コード バッファに保存します。ダウンロードが完了すると、バイト配列またはテキスト文字列としてバッファされたデータにアクセスできます。
DownloadHandlerFile
特殊なダウンロードハンドラー。大容量ファイルをダウンロードし、メモリ使用量を抑えながらディスクに保存します。ダウンロードされたバイトを直接ファイルに書き込むため、ダウンロードするファイルのサイズに関係なくメモリ使用量が少なくなります。他のダウンロードハンドラーとの違いは、ハンドラー自体からではなく、保存されたファイルからデータを取得することです。
DownloadHandlerTexture
Unity テクスチャオブジェクトとして使用する画像をダウンロードするために最適化された特別なダウンロードハンドラー。これは、
DownloadHandlerBuffer
を使用して画像ファイルをダウンロードし、
Texture.LoadImage
を使用して Raw バイトからテクスチャを作成するよりも効率的な方法です。
DownloadHandlerAssetBundle
Unity アセットバンドルをダウンロードするために最適化された特別なダウンロードハンドラー。Unityのアセット システムに直接データをストリームし、結果として
AssetBundle
オブジェクトを生成することができます。
DownloadHandlerAudioClip
オーディオファイルのダウンロード用に最適化された特別なダウンロードハンドラー。これは、
DownloadHandlerBuffer
を使用して Raw バイトをダウンロードし、そこから
AudioClip
を作成するより効率的な方法です。
DownloadHandlerScript
カスタムのスクリプト可能な
DownloadHandler
の実装のための抽象基本クラスです。このクラスから継承して、
UnityWebRequest
システムからコールバックを受信します。ネットワークから受信したデータのカスタム処理を実行するために使用できます。
UnityWebRequest
には
UnityWebRequest.disposeDownloadHandlerOnDispose
プロパティがあり、デフォルトは true です。このプロパティが true の場合、
UnityWebRequest.Dispose
への呼び出しは、アタッチされたダウンロードハンドラーの
DownloadHandler.Dispose
も実行します。ダウンロードハンドラーへのリファレンスを、関連する
UnityWebRequest
へのリファレンスよりも長く保持する場合は、
disposeDownloadHandlerOnDispose
を false に設定します。

アップロードハンドラー

アップロードハンドラーを使用すると、アップロードプロセスのさまざまな側面をより詳細にコントロールできます。以下のアップロードハンドラーは使用できます。これらはすべて基本
UploadHandler
クラス専用です。

ハンドラータイプ

説明

UploadHandlerRaw
構築時にデータ バッファを受け入れます。このバッファがバイト配列の場合、内部的にネイティブコードメモリにコピーされます。リモートサーバーがリクエストボディデータを受信する準備ができたとき、
UnityWebRequest
システムはこのバッファを使用します。バッファが
NativeArray
として提供される場合、コピーは実行されません。
UploadHandlerFile
ファイルのコンテンツをリクエストボディとして送信できます。このハンドラーを使用すると、メモリーを多く使用せずに大きなファイルをサーバーに送信できます。ハンドラーは継続的にファイルからデータを読み取り、送信するため、メモリに保持されるのは常にファイルのほんの一部のみです。
UploadHandler.contentType
プロパティの値は、ウェブリクエストの
Content-Type
ヘッダーの値を、
UnityWebRequest
自体に直接設定しない場合に使用されます。
UnityWebRequest
オブジェクトに
Content-Type
ヘッダーを設定した場合、アップロード ハンドラー オブジェクトの
Content-Type
は無視されます。
UnityWebRequest
または
UploadHandler
のいずれかに
Content-Type
を設定しない場合、システムはデフォルトで
application/octet-stream``Content-Type
を設定します。
UnityWebRequest
には
disposeUploadHandlerOnDispose
があり、デフォルトは true です。このプロパティが true の場合、
UnityWebRequest.Dispose
への呼び出しは、アタッチされたアップロードハンドラーの
UploadHandler.Dispose
も実行します。アップロードハンドラーへのリファレンスを
UnityWebRequest
へのリファレンスよりも長く保持する場合は、
disposeUploadHandlerOnDispose
を false に設定します。

追加リソース