Meta Developers

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

Object Data

override bool

DecodeRawResponses[Get]

Web socket client decodes responses prior to raw response callback for request id lookup.

Static Public Member Functions

static WitSocketRequest	GetMessageRequest ( WitConfiguration configuration, WitWebSocketAdapter webSocketAdapter, WitRequestOptions options, VoiceServiceRequestEvents events ) Return web socket message request initialized with required data
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.
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.
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.
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.

Object Data

override void	SetState ( VoiceRequestState newState ) Ignore state changes unless setup
override string	GetSendError ( ) Get send error options
override void	HandleSend ( ) Begins uploading data
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

Public Member Functions

void	Write ( byte [] buffer, int offset, int length ) Public method for sending binary audio data

Details

Properties

WitConfiguration Meta.WitAi.Requests.WitSocketRequest.Configuration
The configuration to be used for the request

WitWebSocketAdapter Meta.WitAi.Requests.WitSocketRequest.WebSocketAdapter
The script used to transmit data

AudioBuffer Meta.WitAi.Requests.WitSocketRequest.AudioInput
The audio buffer used for audio based requests

string Meta.WitAi.Requests.WitSocketRequest.Endpoint
Endpoint to be used

WitAudioRequestOption Meta.WitAi.Requests.WitSocketRequest.AudioRequestOption
Whether request is used for transcribing only

AudioEncoding Meta.WitAi.Requests.WitSocketRequest.AudioEncoding
Audio encoding used for audio requests

bool Meta.WitAi.Requests.WitSocketRequest.IsInputStreamReady
Whether or not the audio stream is ready

Action Meta.WitAi.Requests.WitSocketRequest.OnInputStreamReady
Callback when socket connection is ready to send data

WitWebSocketMessageRequest Meta.WitAi.Requests.WitSocketRequest.WebSocketRequest
Web socket request being performed

Object Data

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

Static Member Functions

static WitSocketRequest Meta.WitAi.Requests.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 Meta.WitAi.Requests.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 Meta.WitAi.Requests.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 Meta.WitAi.Requests.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 Meta.WitAi.Requests.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 Meta.WitAi.Requests.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 Meta.WitAi.Requests.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 Meta.WitAi.Requests.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.

static WitSocketRequest Meta.WitAi.Requests.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.

Object Data

override void Meta.WitAi.Requests.WitSocketRequest.SetState ( VoiceRequestState newState )
Ignore state changes unless setup

override string Meta.WitAi.Requests.WitSocketRequest.GetSendError ( )
Get send error options

override void Meta.WitAi.Requests.WitSocketRequest.HandleSend ( )
Begins uploading data Parameters onSendComplete Callback that handles send completion

override void Meta.WitAi.Requests.WitSocketRequest.HandleCancel ( )
Handle cancellation

override string Meta.WitAi.Requests.WitSocketRequest.GetActivateAudioError ( )
Error returned if audio cannot be activated

override void Meta.WitAi.Requests.WitSocketRequest.HandleAudioActivation ( )
Activates audio and calls activated callback once complete

override void Meta.WitAi.Requests.WitSocketRequest.HandleAudioDeactivation ( )
Deactivates audio asap and calls deactivated callback once complete

Member Functions

void Meta.WitAi.Requests.WitSocketRequest.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?