Meta Developers

API reference

API reference

Select your platform

No SDKs available

No versions available

AudioClipAudioSource

SourceCodeMapper

IWitVRequestFactory

WitVRequestFactory

BaseAudioClipInput

IAudioLevelRangeProvider

VoiceLipSyncMic

NativeWebSocket

NativeWebSocket

WaitForBackgroundThread

MainThreadAwaiter

WebSocketException

WebSocketFactory

WebSocketHelpers

WebSocketInvalidArgumentException

WebSocketInvalidStateException

WebSocketUnexpectedException

INLPRequestOptions

INLPRequestResponseDecoder

INLPRequestResults

ITranscriptionRequestOptions

ITranscriptionRequestResults

IVoiceRequestOptions

IVoiceRequestResults

NLPRequestEvents

NLPRequestResponseEvent

NLPRequestResponseValidatorEvent

TelemetryUtilities

TelemetryUtilities

TelemetryConsentManager

TranscriptionRequest

TranscriptionRequestEvent

TranscriptionRequestEvents

VoiceHubConstants

VoiceRequestEvents

SettingsWindowPage

WitConfigWindowPage

ArrayNodeReference

ButtonAttribute

DropDownAttribute

HiddenTextAttribute

HideIfAttribute

HideWhenSetAttribute

ObjectTypeAttribute

ShowIfAttribute

TooltipBoxAttribute

WitConfigurationAssetRefreshAttribute

AudioDurationTracker

BaseSpeechService

CallbackHandlers

CallbackHandlers

ConfidenceRange

FormattedValueEvents

OutOfScopeUtteranceHandler

SimpleIntentHandler

SimpleIntentHandlerEditor

SimpleStringEntityHandler

SimpleStringEntityHandlerEditor

ValuePathMatcher

ValuePathMatcherPropertyDrawer

WitIntentMatcher

WitIntentMatcherEditor

WitResponseHandler

WitResponseMatcher

WitUtteranceMatcher

ComponentExtensions

ComponentExtensions

ComponentCopyData

WitDictationRuntimeConfiguration

WitEndpointConfig

WitRequestOptions

WitRuntimeConfiguration

CoroutineUtility

CoroutineUtility

CoroutinePerformer

AudioBufferConfiguration

WitConfigurationApplicationTab

WitConfigurationEditorTab

WitConfigurationEntitiesTab

WitConfigurationIntentsTab

WitConfigurationTraitsTab

WitConfigurationVoicesTab

WitConfiguration

WitConfigurationAssetData

WitConfigurationUtility

DynamicEntityDataProvider

DynamicEntityKeywordRegistry

DynamicEntityProvider

RegisteredDynamicEntityKeyword

WitDynamicEntities

WitDynamicEntitiesData

WitDynamicEntity

WitEntityDataBase

WitEntityFloatData

WitEntityIntData

WitSimpleDynamicEntity

WitContextMapInfo

WitEntityKeywordInfo

WitEntityRoleInfo

WitIntentEntityInfo

WitTraitValueInfo

WitVersionTagInfo

SimulatedResponse

SimulatedResponseMessage

ValueReferences

ValueReferences

IStringReference

StringReference

WitDataCreation

DictationSession

DictationService

DictationEvents

IDictationService

MultiRequestTranscription

ButtonAttributeDrawer

DynamicRangeAttributeDrawer

HiddenTextAttributeDrawer

StringReferenceDrawer

TooltipBoxDrawer

EditorUtilities

EditorUtilities

SerializedPropertyExtensions

EnumerableExtensions

IExportParserPlugin

ITelemetryEventsProvider

IVoiceActivationHandler

IVoiceEventProvider

IWitRequestConfiguration

IWitRequestEndpointInfo

IWitRuntimeConfigProvider

IWitRuntimeConfigSetter

CustomTranscriptionProvider

IAudioEventProvider

IAudioInputEvents

IAudioInputSource

IAudioUploadHandler

IDataUploadHandler

IDynamicEntitiesProvider

IPlatformIntegrationOverride

ITranscriptionEvent

ITranscriptionEventProvider

ITranscriptionProvider

IVoiceServiceRequestProvider

IWitConfigurationProvider

IWitConfigurationSetter

IWitInspectorTools

BaseAudioClipInput

IAudioLevelRangeProvider

VoiceLipSyncMic

MatchIntentRegistry

ObjectNodeReference

RegisteredMatchIntent

ServiceReferences

ServiceReferences

AudioInputServiceReference

CombinedAudioEventReference

DictationServiceAudioEventReference

VoiceServiceAudioEventReference

ISpeechEventProvider

VoiceSpeechEvents

TTSDiskCacheSettings

TTSEventContainer

TTSPhonemeEvent

TTSVoiceSettings

TTSDownloadEvents

TTSServiceEvents

TTSStreamEvents

TTSWebRequestEvents

BaseTTSRuntimeCache

TTSEventAnimator

TTSRuntimeLRUCache

TTSRuntimePlaybackCache

TTSWitRequestSettings

TTSWitVoiceSettings

ISpeakerTextPostprocessor

ISpeakerTextPreprocessor

ITTSDiskCacheHandler

ITTSEventPlayer

ITTSRuntimeCacheHandler

ITTSVoiceProvider

BaseTextureFlipLipSync

BaseTextureFlipLipSync

VisemeTextureData

BaseVisemeBlendShapeLipSync

BaseVisemeBlendShapeLipSync

VisemeBlendShapeData

VisemeBlendShapeWeight

ILipsyncAnimator

IVisemeAnimatorProvider

VisemeBlendShapeLipSync

VisemeChangedEvent

VisemeLerpEvent

VisemeLipSyncAnimator

VisemeTextureFlipLipSync

TTSPreloadPhraseData

TTSPreloadSettings

TTSPreloadSettingsInspector

TTSPreloadUtility

TTSPreloadVoiceData

TTSStreamToggle

TTSEditorUtilities

TTSServiceInspector

TTSSpeakerInspector

TTSWitInspector

TTSSpeakerErrorLabel

TTSSpeakerObserver

TTSSpeakerStatusLabel

ITTSPhraseProvider

TTSSpeakerRequestData

TTSSpeakerAutoLoader

TTSSpeakerBodyAnimator

TTSSpeakerClipEvent

TTSSpeakerClipEvents

TTSSpeakerClipMessageEvent

TTSSpeakerEvents

TTSSpeechSplitter

TTSWitVoiceSettingsDrawer

UnityEventExtensions

UnityObjectExtensions

AssetDatabaseUtility

DictationServiceReference

DynamicRangeAttribute

FloatToStringEvent

GameObjectSearchUtility

ReflectionUtils

StringToStringEvent

VoiceServiceReference

WitRuntimeStyles

ValidatePartialIntent

WitAppInfoUtility

DefaultTokenValidatorProvider

ITokenValidationProvider

WitConduitParameterProvider

WitConfigurationEditorUI

WitEditorConstants

WitExportRetriever

WitRequestFactory

WitRequestSettings

WitResponseReference

WitResultUtilities

WitRuntimeRequestConfiguration

WrapHttpWebRequest

ZipArchiveExtensions

AppVoiceExperience

IVCBindingEvents

VoiceSDKBinding

VoiceSDKConfigBinding

VoiceSDKImplRequest

VoiceSDKListenerBinding

VoiceSDKDataCreation

AppVoiceExperienceWitConfigurationEditor

IPlatformVoiceService

TTSServiceLogging

ObjectVoiceExperience

HierarchySimplifier

HierarchySimplifierInspector

InspectorHelper

VoiceSDKVersion

VoiceSDKConstants

UnderstandingViewerWindow

VoiceApplicationDetailProvider

VoiceSDKTokenValidatorProvider

VoiceActivationButton

VoiceTranscriptionLabel

MicPermissionsManager

WitWebSocketJsonRequest Class

Web socket request that encodes a single json request

Meta::Voice::Net::WebSockets::Requests::WitWebSocketJsonRequest extends Meta.Voice.Net.WebSockets.IWitWebSocketRequest.

Overview

Properties

string	RequestId`[Get]` Unique request id generated on init
string	TopicId`[Get]` The specific topic id that is being published to or received via subscription, if applicable.
int	TimeoutMs`[Get]` The timeout in milliseconds from the initial upload to the response from the server. If no response in time, the request will fail.
bool	IsUploading`[Get]` Whether or not uploading has begun
bool	IsDownloading`[Get]` Whether or not downloading has begun
bool	IsComplete`[Get]` Whether or not complete
string	Code`[Get]` A response code if applicable
string	Error`[Get]` An error if applicable
WitResponseNode	PostData`[Get]` Initial json data to be uploaded
WitResponseNode	ResponseData`[Get]` First decoded json response received
Action< string >	OnRawResponse`[Get]` Callback method when raw json response is received
Action< IWitWebSocketRequest >	OnFirstResponse`[Get]` Callback when request receives the first chunk of data from the server
Action< IWitWebSocketRequest >	OnComplete`[Get]` Callback when the request has completed due to a cancellation, error or success

Object Data

UploadChunkDelegate	_uploader`[Get]` The method used to upload chunks
DateTime	_timeoutStart`[Get]` Start of the timeout

Public Member Functions

	WitWebSocketJsonRequest ( WitResponseNode postData, string requestId ) Constructor which accepts a WitResponseNode as post data and applies request id
void	HandleUpload ( UploadChunkDelegate uploadChunk ) Called once from the main thread to begin the upload process. Sends a single post chunk.
void	Cancel ( ) Cancel current request
void	HandleDownload ( string jsonString, WitResponseNode jsonData, byte [] binaryData ) Called one or more times from the background thread when a chunk has returned. Stores the json data from the first response.
override string	ToString ( ) Override ToString for more request specific info

Object Data

void	BeginTimeout ( ) Generates a task to watch for timeout
void	SendAbort ( string reason ) Method to perform an abort call
void	ReturnRawResponse ( string jsonString ) If raw response callback is implemented, calls on main thread
void	SetResponseData ( WitResponseNode newResponseData ) Apply response data
void	HandleDownloadBegin ( ) Method called for first response handling to mark download begin and perform first response callback on main thread.
void	RaiseFirstResponse ( ) Method called on main thread when first response callback should occur
void	HandleComplete ( ) Resets the state of the request and marks request as complete.
void	RaiseComplete ( ) Method called on main thread when first response callback should occur

Details

Properties

string Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.RequestId
Unique request id generated on init

string Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.TopicId
The specific topic id that is being published to or received via subscription, if applicable.

int Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.TimeoutMs
The timeout in milliseconds from the initial upload to the response from the server. If no response in time, the request will fail.

bool Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.IsUploading
Whether or not uploading has begun

bool Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.IsDownloading
Whether or not downloading has begun

bool Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.IsComplete
Whether or not complete

string Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.Code
A response code if applicable

string Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.Error
An error if applicable

WitResponseNode Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.PostData
Initial json data to be uploaded

WitResponseNode Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.ResponseData
First decoded json response received

Action<string> Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.OnRawResponse
Callback method when raw json response is received

Action<IWitWebSocketRequest> Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.OnFirstResponse
Callback when request receives the first chunk of data from the server

Action<IWitWebSocketRequest> Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.OnComplete
Callback when the request has completed due to a cancellation, error or success

Object Data

UploadChunkDelegate Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest._uploader
The method used to upload chunks

DateTime Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest._timeoutStart
Start of the timeout

Member Functions

Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.WitWebSocketJsonRequest ( WitResponseNode postData, string requestId )
Constructor which accepts a WitResponseNode as post data and applies request id

virtual void Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.HandleUpload ( UploadChunkDelegate uploadChunk )
Called once from the main thread to begin the upload process. Sends a single post chunk. Parameters uploadChunk The method to be called as each json and/or binary chunk is ready to be uploaded

virtual void Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.Cancel ( )
Cancel current request

virtual void Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.HandleDownload ( string jsonString, WitResponseNode jsonData, byte [] binaryData )
Called one or more times from the background thread when a chunk has returned. Stores the json data from the first response. Parameters jsonString Raw json string. jsonData Decoded json data object. binaryData Decoded binary data chunk which may be null or empty.

override string Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.ToString ( )
Override ToString for more request specific info

Object Data

void Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.BeginTimeout ( )
Generates a task to watch for timeout

void Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.SendAbort ( string reason )
Method to perform an abort call

virtual void Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.ReturnRawResponse ( string jsonString )
If raw response callback is implemented, calls on main thread

virtual void Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.SetResponseData ( WitResponseNode newResponseData )
Apply response data Parameters newResponseData New response data received

virtual void Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.HandleDownloadBegin ( )
Method called for first response handling to mark download begin and perform first response callback on main thread.

virtual void Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.RaiseFirstResponse ( )
Method called on main thread when first response callback should occur

virtual void Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.HandleComplete ( )
Resets the state of the request and marks request as complete.

virtual void Meta.Voice.Net.WebSockets.Requests.WitWebSocketJsonRequest.RaiseComplete ( )
Method called on main thread when first response callback should occur

Did you find this page helpful?