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

ILoggerRegistry

LogCategoryAttribute

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

IWitConfigurationProvider

IWitInspectorTools

IWitRequestProvider

BaseAudioClipInput

IAudioLevelRangeProvider

VoiceLipSyncMic

MatchIntentRegistry

ObjectNodeReference

RegisteredMatchIntent

ServiceReferences

ServiceReferences

AudioInputServiceReference

CombinedAudioEventReference

DictationServiceAudioEventReference

VoiceServiceAudioEventReference

ISpeechEventProvider

VoiceSpeechEvents

TTSDiskCacheSettings

TTSEventContainer

TTSPhonemeEvent

TTSVoiceSettings

TTSDownloadEvents

TTSServiceEvents

TTSStreamEvents

TTSWebRequestEvents

TTSEventAnimator

TTSRuntimeCache

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

WitSocketRequest Class

A WitSocketRequest implementation using web sockets

Meta::WitAi::Requests::WitSocketRequest extends Meta.WitAi.Requests.VoiceServiceRequest.

Meta::WitAi::Requests::WitSocketRequest extends Meta.WitAi.Interfaces.IAudioUploadHandler.

Overview

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
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 decodes responses automatically

Public Member Functions

	WitSocketRequest ( WitConfiguration configuration, WitWebSocketAdapter webSocketAdapter, AudioBuffer audioBuffer, WitRequestOptions options, VoiceServiceRequestEvents events ) Constructor for audio requests using an audio buffer
	WitSocketRequest ( WitConfiguration configuration, WitWebSocketAdapter webSocketAdapter, WitRequestOptions options, VoiceServiceRequestEvents events ) Constructor for a text request
	WitSocketRequest ( WitConfiguration configuration, WitWebSocketAdapter webSocketAdapter, WitWebSocketMessageRequest webSocketRequest, WitRequestOptions options, VoiceServiceRequestEvents events ) Constructor for json response turned into message response
void	Write ( byte [] buffer, int offset, int length ) Public method for sending binary audio data

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

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

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 decodes responses automatically

Member Functions

Meta.WitAi.Requests.WitSocketRequest.WitSocketRequest ( WitConfiguration configuration, WitWebSocketAdapter webSocketAdapter, AudioBuffer audioBuffer, WitRequestOptions options, VoiceServiceRequestEvents events )
Constructor for audio requests using an audio buffer 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 Options used for request parameters events Event callbacks used for this request

Meta.WitAi.Requests.WitSocketRequest.WitSocketRequest ( WitConfiguration configuration, WitWebSocketAdapter webSocketAdapter, WitRequestOptions options, VoiceServiceRequestEvents events )
Constructor for a text request Parameters configuration Configuration to be used when authenticating web socket client webSocketAdapter Adapter used to communicate with web socket client options Options used for request parameters events Event callbacks used for this request

Meta.WitAi.Requests.WitSocketRequest.WitSocketRequest ( WitConfiguration configuration, WitWebSocketAdapter webSocketAdapter, WitWebSocketMessageRequest webSocketRequest, WitRequestOptions options, VoiceServiceRequestEvents events )
Constructor for json response turned into message response Parameters configuration Configuration to be used when authenticating web socket client webSocketAdapter Adapter used to communicate with web socket client jsonData Initial response from server

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

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

Did you find this page helpful?