API reference
WitSocketRequest Class
Extends VoiceServiceRequest, IAudioUploadHandler, ILogSource
A WitSocketRequest implementation using web sockets
Properties
WitConfiguration Configuration[Get]
The configuration to be used for the request
WitWebSocketAdapter WebSocketAdapter[Get]
The script used to transmit data
AudioBuffer AudioInput[Get]
The audio buffer used for audio based requests
string Endpoint[Get]
Endpoint to be used
WitAudioRequestOption AudioRequestOption[Get]
Whether request is used for transcribing only
AudioEncoding AudioEncoding[Get]
Audio encoding used for audio requests
bool IsInputStreamReady[Get]
Whether or not the audio stream is ready
Action OnInputStreamReady[Get]
Callback when socket connection is ready to send data
WitWebSocketMessageRequest WebSocketRequest[Get]
Web socket request being performed
Protected Fields
override bool DecodeRawResponses[Get]
Web socket client decodes responses prior to raw response callback for request id lookup.
Static Member Functions
static WitSocketRequest GetMessageRequest
( WitConfiguration configuration,
WitWebSocketAdapter webSocketAdapter,
WitRequestOptions options,
VoiceServiceRequestEvents events )
Return web socket message request initialized with required data
Parameters
configuration
Configuration to be used when authenticating web socket client.
webSocketAdapter
Adapter used to communicate with web socket client.
options
Optional parameter for web request options.
events
Optional parameter for request event callbacks.
Returns
static WitSocketRequest GetSpeechRequest
( WitConfiguration configuration,
WitWebSocketAdapter webSocketAdapter,
AudioBuffer audioBuffer,
WitRequestOptions options,
VoiceServiceRequestEvents events )
Return web socket speech request initialized with required data to generate an audio request.
Parameters
configuration
Configuration to be used when authenticating web socket client.
webSocketAdapter
Adapter used to communicate with web socket client.
audioBuffer
Audio input buffer used to obtain audio data
options
Optional parameter for web request options.
events
Optional parameter for request event callbacks.
Returns
static WitSocketRequest GetExternalRequest
( WitWebSocketMessageRequest webSocketRequest,
WitConfiguration configuration,
WitWebSocketAdapter webSocketAdapter,
WitRequestOptions options,
VoiceServiceRequestEvents events )
Return web socket request initialized on an external client but handled locally.
Parameters
webSocketRequest
The externally generated web socket request.
configuration
Configuration to be used when authenticating web socket client.
webSocketAdapter
Adapter used to communicate with web socket client.
audioBuffer
Audio input buffer used to obtain audio data
options
Optional parameter for web request options.
events
Optional parameter for request event callbacks.
static WitSocketRequest GetTranscribeRequest
( WitConfiguration configuration,
WitWebSocketAdapter webSocketAdapter,
AudioBuffer audioBuffer,
WitRequestOptions options,
VoiceServiceRequestEvents events )
Return web socket transcribe request initialized with required data to generate a short audio request.
Parameters
configuration
Configuration to be used when authenticating web socket client.
webSocketAdapter
Adapter used to communicate with web socket client.
audioBuffer
Audio input buffer used to obtain audio data
options
Optional parameter for web request options.
events
Optional parameter for request event callbacks.
static WitSocketRequest GetDictationRequest
( WitConfiguration configuration,
WitWebSocketAdapter webSocketAdapter,
AudioBuffer audioBuffer,
WitRequestOptions options,
VoiceServiceRequestEvents events )
Return web socket dictation request initialized with required data to generate a long form audio request.
Parameters
configuration
Configuration to be used when authenticating web socket client.
webSocketAdapter
Adapter used to communicate with web socket client.
audioBuffer
Audio input buffer used to obtain audio data
options
Optional parameter for web request options.
events
Optional parameter for request event callbacks.
Protected Functions
override void SetState
( VoiceRequestState newState )
Ignore state changes unless setup
override string GetSendError ( )
Get send error options
override void HandleSend ( )
Begins uploading data
Parameters
onSendComplete
Callback that handles send completion
override void HandleCancel ( )
Handle cancellation
override string GetActivateAudioError ( )
Error returned if audio cannot be activated
override void HandleAudioActivation ( )
Activates audio and calls activated callback once complete
override void HandleAudioDeactivation ( )
Deactivates audio asap and calls deactivated callback once complete
Member Functions
void Write
( byte [] buffer,
int offset,
int length )
Public method for sending binary audio data
Parameters
buffer
The buffer used for uploading data
offset
The starting offset of the buffer selection
length
The length of the buffer to be used
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)
© 2025 Meta