API reference

WitSocketRequest Class

Extends Meta.WitAi.Requests.VoiceServiceRequest
Implements Meta.WitAi.Interfaces.IAudioUploadHandler, Lib.Wit.Runtime.Utilities.Logging.ILogSource
A WitSocketRequest implementation using web sockets

Protected Fields

DecodeRawResponses : override bool
Web socket client decodes responses prior to raw response callback for request id lookup.
Signature 
override bool Meta.WitAi.Requests.WitSocketRequest.DecodeRawResponses

Internal Fields

_simulatedErrorType : VoiceErrorSimulationType
The simulated error to be used for this request
Signature 
VoiceErrorSimulationType Meta.WitAi.Requests.WitSocketRequest._simulatedErrorType

Properties

AudioEncoding : AudioEncoding
[Get][Set]
Audio encoding used for audio requests
Signature 
AudioEncoding Meta.WitAi.Requests.WitSocketRequest.AudioEncoding
AudioInput : AudioBuffer
[Get]
The audio buffer used for audio based requests
Signature 
AudioBuffer Meta.WitAi.Requests.WitSocketRequest.AudioInput
AudioRequestOption : WitAudioRequestOption
[Get]
Whether request is used for transcribing only
Signature 
WitAudioRequestOption Meta.WitAi.Requests.WitSocketRequest.AudioRequestOption
Configuration : WitConfiguration
[Get]
The configuration to be used for the request
Signature 
WitConfiguration Meta.WitAi.Requests.WitSocketRequest.Configuration
Endpoint : string
[Get][Set]
Endpoint to be used
Signature 
string Meta.WitAi.Requests.WitSocketRequest.Endpoint
IsInputStreamReady : bool
[Get]
Whether or not the audio stream is ready
Signature 
bool Meta.WitAi.Requests.WitSocketRequest.IsInputStreamReady
OnInputStreamReady : Action
[Get][Set]
Callback when socket connection is ready to send data
Signature 
Action Meta.WitAi.Requests.WitSocketRequest.OnInputStreamReady
WebSocketAdapter : WitWebSocketAdapter
[Get]
The script used to transmit data
Signature 
WitWebSocketAdapter Meta.WitAi.Requests.WitSocketRequest.WebSocketAdapter
WebSocketRequest : WitWebSocketMessageRequest
[Get]
Web socket request being performed
Signature 
WitWebSocketMessageRequest Meta.WitAi.Requests.WitSocketRequest.WebSocketRequest

Protected Methods

GetActivateAudioError ()
Error returned if audio cannot be activated
Signature 
override string Meta.WitAi.Requests.WitSocketRequest.GetActivateAudioError()
Returns
override string
GetSendError ()
Get send error options
Signature 
override string Meta.WitAi.Requests.WitSocketRequest.GetSendError()
Returns
override string
HandleAudioActivation ()
Activates audio and calls activated callback once complete
Signature 
override void Meta.WitAi.Requests.WitSocketRequest.HandleAudioActivation()
Returns
override void
HandleAudioDeactivation ()
Deactivates audio asap and calls deactivated callback once complete
Signature 
override void Meta.WitAi.Requests.WitSocketRequest.HandleAudioDeactivation()
Returns
override void
HandleCancel ()
Handle cancellation
Signature 
override void Meta.WitAi.Requests.WitSocketRequest.HandleCancel()
Returns
override void
HandleSend ()
Begins uploading data
Signature 
override void Meta.WitAi.Requests.WitSocketRequest.HandleSend()
Returns
override void
SetState ( newState )
Ignore state changes unless setup
Signature 
override void Meta.WitAi.Requests.WitSocketRequest.SetState(VoiceRequestState newState)
Parameters
newState: VoiceRequestState
Returns
override void

Methods

Write ( buffer , offset , length )
Public method for sending binary audio data
Signature 
void Meta.WitAi.Requests.WitSocketRequest.Write(byte[] buffer, int offset, int length)
Parameters
buffer: byte []  The buffer used for uploading data
offset: int  The starting offset of the buffer selection
length: int  The length of the buffer to be used
Returns
void

Static Methods

GetDictationRequest ( configuration , webSocketAdapter , audioBuffer , options , events )
Return web socket dictation request initialized with required data to generate a long form audio request.
Signature 
static WitSocketRequest Meta.WitAi.Requests.WitSocketRequest.GetDictationRequest(WitConfiguration configuration, WitWebSocketAdapter webSocketAdapter, AudioBuffer audioBuffer, WitRequestOptions options=null, VoiceServiceRequestEvents events=null)
Parameters
configuration: WitConfiguration Configuration to be used when authenticating web socket client.
webSocketAdapter: WitWebSocketAdapter  Adapter used to communicate with web socket client.
audioBuffer: AudioBuffer  Audio input buffer used to obtain audio data
options: WitRequestOptions  Optional parameter for web request options.
events: VoiceServiceRequestEvents  Optional parameter for request event callbacks.
Returns
WitSocketRequest
GetExternalRequest ( webSocketRequest , configuration , webSocketAdapter , options , events )
Return web socket request initialized on an external client but handled locally.
Signature 
static WitSocketRequest Meta.WitAi.Requests.WitSocketRequest.GetExternalRequest(WitWebSocketMessageRequest webSocketRequest, WitConfiguration configuration, WitWebSocketAdapter webSocketAdapter, WitRequestOptions options=null, VoiceServiceRequestEvents events=null)
Parameters
webSocketRequest: WitWebSocketMessageRequest  The externally generated web socket request.
configuration: WitConfiguration Configuration to be used when authenticating web socket client.
webSocketAdapter: WitWebSocketAdapter  Adapter used to communicate with web socket client.
options: WitRequestOptions  Optional parameter for web request options.
events: VoiceServiceRequestEvents  Optional parameter for request event callbacks.
Returns
WitSocketRequest
GetMessageRequest ( configuration , webSocketAdapter , options , events )
Return web socket message request initialized with required data
Signature 
static WitSocketRequest Meta.WitAi.Requests.WitSocketRequest.GetMessageRequest(WitConfiguration configuration, WitWebSocketAdapter webSocketAdapter, WitRequestOptions options=null, VoiceServiceRequestEvents events=null)
Parameters
configuration: WitConfiguration Configuration to be used when authenticating web socket client.
webSocketAdapter: WitWebSocketAdapter  Adapter used to communicate with web socket client.
options: WitRequestOptions  Optional parameter for web request options.
events: VoiceServiceRequestEvents  Optional parameter for request event callbacks.
Returns
WitSocketRequest
GetSpeechRequest ( configuration , webSocketAdapter , audioBuffer , options , events )
Return web socket speech request initialized with required data to generate an audio request.
Signature 
static WitSocketRequest Meta.WitAi.Requests.WitSocketRequest.GetSpeechRequest(WitConfiguration configuration, WitWebSocketAdapter webSocketAdapter, AudioBuffer audioBuffer, WitRequestOptions options=null, VoiceServiceRequestEvents events=null)
Parameters
configuration: WitConfiguration Configuration to be used when authenticating web socket client.
webSocketAdapter: WitWebSocketAdapter  Adapter used to communicate with web socket client.
audioBuffer: AudioBuffer  Audio input buffer used to obtain audio data
options: WitRequestOptions  Optional parameter for web request options.
events: VoiceServiceRequestEvents  Optional parameter for request event callbacks.
Returns
WitSocketRequest
GetTranscribeRequest ( configuration , webSocketAdapter , audioBuffer , options , events )
Return web socket transcribe request initialized with required data to generate a short audio request.
Signature 
static WitSocketRequest Meta.WitAi.Requests.WitSocketRequest.GetTranscribeRequest(WitConfiguration configuration, WitWebSocketAdapter webSocketAdapter, AudioBuffer audioBuffer, WitRequestOptions options=null, VoiceServiceRequestEvents events=null)
Parameters
configuration: WitConfiguration Configuration to be used when authenticating web socket client.
webSocketAdapter: WitWebSocketAdapter  Adapter used to communicate with web socket client.
audioBuffer: AudioBuffer  Audio input buffer used to obtain audio data
options: WitRequestOptions  Optional parameter for web request options.
events: VoiceServiceRequestEvents  Optional parameter for request event callbacks.
Returns
WitSocketRequest

Internal Methods

SimulateError ( errorType )
Simulates a specific error
Signature 
override void Meta.WitAi.Requests.WitSocketRequest.SimulateError(VoiceErrorSimulationType errorType)
Parameters
errorType: VoiceErrorSimulationType
Returns
override void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta