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

WitService Class

Meta::WitAi::WitService extends MonoBehaviour.

Meta::WitAi::WitService extends Meta.WitAi.IVoiceEventProvider.

Meta::WitAi::WitService extends Meta.WitAi.IVoiceActivationHandler.

Meta::WitAi::WitService extends Meta.WitAi.ITelemetryEventsProvider.

Meta::WitAi::WitService extends Meta.WitAi.IWitRuntimeConfigProvider.

Meta::WitAi::WitService extends Meta.WitAi.Interfaces.IWitConfigurationProvider.

Overview

Properties

IPubSubAdapter	PubSub`[Get]` Access pub sub
bool	IsRequestActive`[Get]` Active if recording, transmitting, or queued up
IVoiceEventProvider	VoiceEventProvider`[Get]`
ITelemetryEventsProvider	TelemetryEventsProvider`[Get]`
IWitRuntimeConfigProvider	ConfigurationProvider`[Get]`
ITranscriptionProvider	TranscriptionProvider`[Get]` Gets/Sets a custom transcription provider. This can be used to replace any built in asr with an on device model or other provided source
IVoiceServiceRequestProvider	RequestProvider`[Get]` Generic voice service request provider

Data Fields

WitConfiguration	Configuration`[Get]`
bool	Active`[Get]` Returns true if wit is currently active and listening with the mic
WitRuntimeConfiguration	RuntimeConfiguration`[Get]`
VoiceEvents	VoiceEvents`[Get]`
TelemetryEvents	TelemetryEvents`[Get]`
bool	MicActive`[Get]`

Object Data

bool	ShouldSendMicData`[Get]`

Public Member Functions

bool	IsConfigurationValid ( ) Check configuration, client access token & app id
void	HandleWebSocketRequestGeneration ( IWitWebSocketRequest webSocketRequest ) Handle web socket request if possible
void	Activate ( ) Activate the microphone and send data to Wit for NLU processing.
void	Activate ( WitRequestOptions requestOptions )
VoiceServiceRequest	Activate ( WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents ) Activate the microphone and wait for threshold and then send data
void	ActivateImmediately ( ) Activate the microphone and immediately send data to Wit for NLU processing.
void	ActivateImmediately ( WitRequestOptions requestOptions )
VoiceServiceRequest	ActivateImmediately ( WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents ) Activate the microphone and send data for NLU processing with custom request options.
void	ExecuteRequest ( VoiceServiceRequest newRequest ) Execute a wit request immediately
void	Activate ( string text ) Activate the microphone and send data to Wit for NLU processing.
void	Activate ( string text, WitRequestOptions requestOptions )
VoiceServiceRequest	Activate ( string text, WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents ) Send text data for NLU processing with custom request options & events.
void	Deactivate ( ) Stop listening and submit the collected microphone data to wit for processing.
void	DeactivateAndAbortRequest ( VoiceServiceRequest request ) Stop listening and cancel a specific report
void	DeactivateAndAbortRequest ( ) Stop listening and abort any requests that may be active without waiting for a response.

Object Data

void	Awake ( )
void	OnEnable ( )
void	OnDisable ( )
void	RefreshConfigurationSettings ( ) Method called whenever the OnConfigurationUpdated action is invoked to re-init all runtime configuration based setup.
void	OnSceneLoaded ( Scene scene, LoadSceneMode mode )
void	SetMicDelegates ( bool add )
void	SendRecordingRequest ( ) Sends recording request if possible
void	SetupRequest ( VoiceServiceRequest newRequest ) Setup recording request

Details

Properties

IPubSubAdapter Meta.WitAi.WitService.PubSub
Access pub sub

bool Meta.WitAi.WitService.IsRequestActive
Active if recording, transmitting, or queued up

IVoiceEventProvider Meta.WitAi.WitService.VoiceEventProvider
No description available.

ITelemetryEventsProvider Meta.WitAi.WitService.TelemetryEventsProvider
No description available.

IWitRuntimeConfigProvider Meta.WitAi.WitService.ConfigurationProvider
No description available.

ITranscriptionProvider Meta.WitAi.WitService.TranscriptionProvider
Gets/Sets a custom transcription provider. This can be used to replace any built in asr with an on device model or other provided source

IVoiceServiceRequestProvider Meta.WitAi.WitService.RequestProvider
Generic voice service request provider

Fields

WitConfiguration Meta.WitAi.WitService.Configuration
No description available.

bool Meta.WitAi.WitService.Active
Returns true if wit is currently active and listening with the mic

WitRuntimeConfiguration Meta.WitAi.WitService.RuntimeConfiguration
No description available.

VoiceEvents Meta.WitAi.WitService.VoiceEvents
No description available.

TelemetryEvents Meta.WitAi.WitService.TelemetryEvents
No description available.

bool Meta.WitAi.WitService.MicActive
No description available.

Object Data

bool Meta.WitAi.WitService.ShouldSendMicData
No description available.

Member Functions

virtual bool Meta.WitAi.WitService.IsConfigurationValid ( )
Check configuration, client access token & app id

void Meta.WitAi.WitService.HandleWebSocketRequestGeneration ( IWitWebSocketRequest webSocketRequest )
Handle web socket request if possible

void Meta.WitAi.WitService.Activate ( )
Activate the microphone and send data to Wit for NLU processing.

void Meta.WitAi.WitService.Activate ( WitRequestOptions requestOptions )
No description available.

VoiceServiceRequest Meta.WitAi.WitService.Activate ( WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents )
Activate the microphone and wait for threshold and then send data Parameters requestOptions Additional options such as dynamic entities requestEvents Events specific to the request's lifecycle

void Meta.WitAi.WitService.ActivateImmediately ( )
Activate the microphone and immediately send data to Wit for NLU processing.

void Meta.WitAi.WitService.ActivateImmediately ( WitRequestOptions requestOptions )
No description available.

VoiceServiceRequest Meta.WitAi.WitService.ActivateImmediately ( WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents )
Activate the microphone and send data for NLU processing with custom request options. Parameters requestOptions Additional options such as dynamic entities requestEvents Events specific to the request's lifecycle

void Meta.WitAi.WitService.ExecuteRequest ( VoiceServiceRequest newRequest )
Execute a wit request immediately Parameters recordingRequest

void Meta.WitAi.WitService.Activate ( string text )
Activate the microphone and send data to Wit for NLU processing.

void Meta.WitAi.WitService.Activate ( string text, WitRequestOptions requestOptions )
No description available.

VoiceServiceRequest Meta.WitAi.WitService.Activate ( string text, WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents )
Send text data for NLU processing with custom request options & events. Parameters text Text to be used for NLU processing requestOptions Additional options such as dynamic entities requestEvents Events specific to the request's lifecycle

void Meta.WitAi.WitService.Deactivate ( )
Stop listening and submit the collected microphone data to wit for processing.

void Meta.WitAi.WitService.DeactivateAndAbortRequest ( VoiceServiceRequest request )
Stop listening and cancel a specific report

void Meta.WitAi.WitService.DeactivateAndAbortRequest ( )
Stop listening and abort any requests that may be active without waiting for a response.

Object Data

void Meta.WitAi.WitService.Awake ( )
No description available.

void Meta.WitAi.WitService.OnEnable ( )
No description available.

void Meta.WitAi.WitService.OnDisable ( )
No description available.

virtual void Meta.WitAi.WitService.RefreshConfigurationSettings ( )
Method called whenever the OnConfigurationUpdated action is invoked to re-init all runtime configuration based setup.

virtual void Meta.WitAi.WitService.OnSceneLoaded ( Scene scene, LoadSceneMode mode )
No description available.

void Meta.WitAi.WitService.SetMicDelegates ( bool add )
No description available.

virtual void Meta.WitAi.WitService.SendRecordingRequest ( )
Sends recording request if possible

void Meta.WitAi.WitService.SetupRequest ( VoiceServiceRequest newRequest )
Setup recording request Parameters recordingRequest

Did you find this page helpful?