API reference
VRequest Class
Class for performing web requests using UnityWebRequest
Public Statics
static int MaxConcurrentRequests[Get]
Will only start new requests if there are less than this number If <= 0, then all requests will run immediately
Protected Fields
Uri uri[Get]
The URI of the current/last request.
string payload[Get]
The data for PUT and POST requests. This will usually be set by child classes that have unencoded payloads.
Properties
int Timeout[Get]
Timeout in seconds
bool IsPerforming[Get]
If request is currently being performed
bool HasFirstResponse[Get]
If first response has been received
bool IsStreamReady[Get]
If the download handler incorporates IVRequestStreamable & IsStreamReady
bool IsComplete[Get]
Whether or not the completion delegate has been called
int ResponseCode[Get]
Response Code if applicable
string ResponseError[Get]
Response error
float UploadProgress[Get]
Current progress for get requests
float DownloadProgress[Get]
Current progress for download
Member Functions
delegate void RequestProgressDelegate
( float progress )
delegate void RequestFirstResponseDelegate ( )
delegate void RequestCompleteDelegate< TResult >
( TResult result,
string error )
VRequest
( RequestProgressDelegate onDownloadProgress,
RequestFirstResponseDelegate onFirstResponse )
A constructor that takes in download progress delegate & first response delegate
Parameters
onDownloadProgress
The callback for progress related to downloading
onFirstResponse
The callback for the first response of data from a request
virtual string CleanUrl
( string url )
Adds 'file://' to url if no prefix is found
virtual void Cancel ( )
virtual bool Request
( UnityWebRequest unityRequest,
RequestCompleteDelegate< UnityWebRequest > onComplete )
Initialize with a request and an on completion callback
Parameters
unityRequest
The unity request to be performed
onComplete
The callback on completion, returns the request & error string
Returns
False if the request cannot be performed
virtual async Task< RequestCompleteResponse< TData > > RequestAsync< TData >
( UnityWebRequest unityRequest,
Func< UnityWebRequest, TData > onDecode )
Initialize with a request and an on completion callback
Parameters
unityRequest
The unity request to be performed
onDecode
A function to be performed to async decode all request data
Returns
Any errors encountered during the request
bool RequestFileHeaders
( Uri uri,
RequestCompleteDelegate< Dictionary< string, string >> onComplete )
Performs a header request on a uri
Parameters
uri
The uri to perform the request on
onComplete
A completion callback that includes the headers
Returns
async Task< RequestCompleteResponse< Dictionary< string, string > > > RequestFileHeadersAsync
( Uri uri )
Performs a header request on a uri asynchronously
Parameters
uri
The uri to perform the request on
Returns
Returns the header
bool RequestFile
( Uri uri,
RequestCompleteDelegate< byte[]> onComplete )
Performs a simple http header request
Parameters
uri
Uri to get a file
onComplete
Called once file data has been loaded
Returns
False if cannot begin request
async Task< RequestCompleteResponse< byte[]> > RequestFileAsync
( Uri uri )
Performs a simple http header request
Parameters
uri
Uri to get a file
Returns
False if cannot begin request
async Task< RequestCompleteResponse< bool > > RequestFileExistsAsync
( string checkPath )
Checks if a file exists at a specified location using async calls
Parameters
checkPath
The local file path to be checked
Returns
An error if found
bool RequestFileExists
( string checkPath,
RequestCompleteDelegate< bool > onComplete )
Uses async method to check if file exists & return via the oncomplete method
Parameters
checkPath
The local file path to be checked
bool RequestFileDownload
( string downloadPath,
UnityWebRequest unityRequest,
RequestCompleteDelegate< bool > onComplete )
Download a file using a unityrequest
Parameters
unityRequest
The unity request to add a download handler to
onComplete
Called once download has completed
async Task< string > RequestFileDownloadAsync
( string downloadPath,
UnityWebRequest unityRequest )
Download a file using a unityrequest
Parameters
unityRequest
The unity request to add a download handler to
bool RequestText
( UnityWebRequest unityRequest,
RequestCompleteDelegate< string > onComplete,
TextStreamHandler
Performs a text request & handles the resultant text
Parameters
unityRequest
The unity request performing the post or get
onComplete
The delegate upon completion
async Task< RequestCompleteResponse< string > > RequestTextAsync
( UnityWebRequest unityRequest,
TextStreamHandler
Performs a text request async & returns the text along with any errors
Parameters
unityRequest
The unity request performing the post or get
bool RequestJson< TData >
( UnityWebRequest unityRequest,
RequestCompleteDelegate< TData > onComplete,
RequestCompleteDelegate< TData > onPartial )
Performs a request for text & decodes it into json
Parameters
unityRequest
The unity request performing the post or get
onComplete
The delegate upon completion
Others
TData
The struct or class to be deserialized to
Returns
False if the request cannot be performed
async Task< RequestCompleteResponse< TData > > RequestJsonAsync< TData >
( UnityWebRequest unityRequest,
RequestCompleteDelegate< TData > onPartial )
Performs a request for text and decodes it into json asynchronously
Parameters
unityRequest
The unity request performing the post or get
Others
TData
The struct or class to be deserialized to
Returns
RequestCompleteResponse with parsed data & error if applicable
bool RequestJsonGet< TData >
( Uri uri,
RequestCompleteDelegate< TData > onComplete,
RequestCompleteDelegate< TData > onPartial )
Perform a json get request with a specified uri
Parameters
uri
The uri to be requested
onComplete
The delegate upon completion
Others
TData
The struct or class to be deserialized to
Returns
False if the request cannot be performed
async Task< RequestCompleteResponse< TData > > RequestJsonGetAsync< TData >
( Uri uri,
RequestCompleteDelegate< TData > onPartial )
Perform a json get request with a specified uri asynchronously
Parameters
uri
The uri to be requested
Others
TData
The struct or class to be deserialized to
Returns
RequestCompleteResponse with parsed data & error if applicable
bool RequestJsonPost< TData >
( Uri uri,
byte [] postData,
RequestCompleteDelegate< TData > onComplete,
RequestCompleteDelegate< TData > onPartial )
Performs a json request by posting byte data
Parameters
uri
The uri to be requested
postData
The data to be uploaded
onComplete
The delegate upon completion
Others
TData
The struct or class to be deserialized to
Returns
False if the request cannot be performed
async Task< RequestCompleteResponse< TData > > RequestJsonPostAsync< TData >
( Uri uri,
byte [] postData,
RequestCompleteDelegate< TData > onPartial )
Performs a json request by posting byte data asynchronously
Parameters
uri
The uri to be requested
postData
The data to be uploaded
Others
TData
The struct or class to be deserialized to
Returns
RequestCompleteResponse with parsed data & error if applicable
bool RequestJsonPost< TData >
( Uri uri,
string postText,
RequestCompleteDelegate< TData > onComplete,
RequestCompleteDelegate< TData > onPartial )
Performs a json request by posting a string
Parameters
uri
The uri to be requested
postText
The string to be uploaded
onComplete
The delegate upon completion
Others
TData
The struct or class to be deserialized to
Returns
False if the request cannot be performed
async Task< RequestCompleteResponse< TData > > RequestJsonPostAsync< TData >
( Uri uri,
string postText,
RequestCompleteDelegate< TData > onPartial )
Performs a json request by posting a string asynchronously
Parameters
uri
The uri to be requested
postText
The string to be uploaded
Others
TData
The struct or class to be deserialized to
Returns
RequestCompleteResponse with parsed data & error if applicable
bool RequestJsonPut< TData >
( Uri uri,
byte [] putData,
RequestCompleteDelegate< TData > onComplete,
RequestCompleteDelegate< TData > onPartial )
Performs a json put request with byte data
Parameters
uri
The uri to be requested
putData
The data to be uploaded
onComplete
The delegate upon completion
Others
TData
The struct or class to be deserialized to
Returns
False if the request cannot be performed
async Task< RequestCompleteResponse< TData > > RequestJsonPutAsync< TData >
( Uri uri,
byte [] putData,
RequestCompleteDelegate< TData > onPartial )
Performs a json put request with byte data asynchronously
Parameters
uri
The uri to be requested
putData
The data to be uploaded
Others
TData
The struct or class to be deserialized to
Returns
RequestCompleteResponse with parsed data & error if applicable
bool RequestJsonPut< TData >
( Uri uri,
string putText,
RequestCompleteDelegate< TData > onComplete,
RequestCompleteDelegate< TData > onPartial )
Performs a json put request with text
Parameters
uri
The uri to be requested
putText
The text to be uploaded
onComplete
The delegate upon completion
Others
TData
The struct or class to be deserialized to
Returns
False if the request cannot be performed
async Task< RequestCompleteResponse< TData > > RequestJsonPutAsync< TData >
( Uri uri,
string putText,
RequestCompleteDelegate< TData > onPartial )
Performs a json put request with text asynchronously
Parameters
uri
The uri to be requested
putText
The text to be uploaded
Others
TData
The struct or class to be deserialized to
Returns
RequestCompleteResponse with parsed data & error if applicable
virtual IAudioDecoder GetAudioDecoder
( AudioType audioType,
bool includeJson,
AudioJsonDecodeDelegate onJsonDecoded )
Instantiate an audio decoder based on the audio type to allow for complex streaming scenarios
Parameters
audioType
Audio decoder type allowed
includeJson
Whether or not json will be returned within the stream
onJsonDecoded
The json decode callback which will be called multiple times
bool RequestAudioStream
( Uri uri,
AudioType audioType,
bool includesJson,
AudioSampleDecodeDelegate onSamplesDecoded,
AudioJsonDecodeDelegate onJsonDecoded,
RequestCompleteDelegate< bool > onComplete )
Request audio clip with uri, audio type, sample decoded delegate & completion delegate
Parameters
uri
The url to be called
audioType
The audio type requested (Wav, MP3, etc.)
includesJson
Whether or not json will be embedded within the audio stream.
onSamplesDecoded
Called one or more times as audio samples are decoded.
onJsonDecoded
Called one or more times as json data is decoded.
onComplete
Called when the audio request has completed
bool RequestAudioStream
( UnityWebRequest unityRequest,
AudioType audioType,
bool includesJson,
AudioSampleDecodeDelegate onSamplesDecoded,
AudioJsonDecodeDelegate onJsonDecoded,
RequestCompleteDelegate< bool > onComplete )
Request audio clip with web request, audio type, whether audio includes json data, callback delegates & completion delegate
Parameters
unityRequest
The unity request to add a download handler to
audioType
The audio type requested (Wav, MP3, etc.)
includesJson
Whether or not json will be embedded within the audio stream.
onSamplesDecoded
Called one or more times as audio samples are decoded.
onJsonDecoded
Called one or more times as json data is decoded.
onComplete
Called when the audio request has completed
Protected Functions
virtual void Setup
( UnityWebRequest unityRequest )
virtual Dictionary< string, string > GetHeaders ( )
virtual void Begin ( )
virtual bool IsRequestComplete ( )
virtual void Update ( )
virtual void Unload ( )
Static Member Functions
static string GetSpecificRequestError
( UnityWebRequest request )
static string GetAudioExtension
( AudioType audioType )
Get audio extension from audio type
Parameters
audioType
The specified audio type
Returns
Audio extension without period.
static string GetAudioExtension
( AudioType audioType,
bool textStream )
Get audio extension from audio type
Parameters
audioType
The specified audio type
textStream
Whether data includes text
Returns
Audio extension without period.
static Type GetAudioDecoderType
( AudioType audioType )
Returns the IAudioDecoder type that works best with the specified AudioType for the current platform.
static bool CanDecodeAudio
( AudioType audioType )
Whether or not a specific audio type can be decoded
static bool CanStreamAudio
( AudioType audioType )
Whether or not audio can be streamed for a specific audio type
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta