Meta Developers

API reference

API reference

Select your platform

No SDKs available

No versions available

AudioClipAudioSource

SourceCodeMapper

IWitVRequestFactory

WitVRequestFactory

BaseAudioClipInput

IAudioLevelRangeProvider

VoiceLipSyncMic

INLPRequestOptions

INLPRequestResponseDecoder

INLPRequestResults

ITranscriptionRequestOptions

ITranscriptionRequestResults

IVoiceRequestOptions

IVoiceRequestResults

NLPRequestEvents

NLPRequestResponseEvent

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

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

TTSSpeakerClipEvent

TTSSpeakerClipEvents

TTSSpeakerClipMessageEvent

TTSSpeakerEvents

TTSSpeechSplitter

TTSWitVoiceSettingsDrawer

ThreadPerformer

UnityEventExtensions

UnityObjectExtensions

AssetDatabaseUtility

DictationServiceReference

DynamicRangeAttribute

FloatToStringEvent

GameObjectSearchUtility

ReflectionUtils

StringToStringEvent

VoiceServiceReference

WitRuntimeStyles

ValidatePartialIntent

WitAppInfoUtility

DefaultTokenValidatorProvider

ITokenValidationProvider

WitConduitParameterProvider

WitConfigurationEditorUI

WitEditorConstants

WitExportRetriever

WitRequestFactory

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

DictationService Class

Meta::WitAi::Dictation::DictationService extends Meta.WitAi.BaseSpeechService.

Meta::WitAi::Dictation::DictationService extends Meta.WitAi.Dictation.IDictationService.

Meta::WitAi::Dictation::DictationService extends Meta.WitAi.Interfaces.IAudioEventProvider.

Meta::WitAi::Dictation::DictationService extends Meta.WitAi.Interfaces.ITranscriptionEventProvider.

Overview

Object Data

DictationEvents	dictationEvents`[Get]`
TelemetryEvents	telemetryEvents`[Get]`

Data Fields

bool	IsRequestActive`[Get]` Returns true if the service is actively communicating with Wit.ai during an Activation. The mic may or may not still be active while this is true.
IAudioInputEvents	AudioEvents`[Get]` A subset of events around collection of audio data
ITranscriptionEvent	TranscriptionEvents`[Get]` A subset of events around receiving transcriptions

Properties

abstract 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
abstract bool	MicActive`[Get]` Returns true if this voice service is currently reading data from the microphone
DictationEvents	DictationEvents`[Get]`
TelemetryEvents	TelemetryEvents`[Get]`
abstract bool	ShouldSendMicData`[Get]` Returns true if the audio input should be read in an activation

Object Data

override SpeechEvents	GetSpeechEvents ( ) If applicable, get all speech events
void	Awake ( )
void	OnEnable ( )
void	OnDisable ( )

Public Member Functions

void	Activate ( ) Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results.
void	Activate ( WitRequestOptions requestOptions ) Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results.
VoiceServiceRequest	Activate ( VoiceServiceRequestEvents requestEvents ) Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results.
abstract VoiceServiceRequest	Activate ( WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents ) Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results.
void	ActivateImmediately ( ) Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Includes optional additional request parameters like dynamic entities and maximum results.
void	ActivateImmediately ( WitRequestOptions requestOptions ) Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Includes optional additional request parameters like dynamic entities and maximum results.
VoiceServiceRequest	ActivateImmediately ( VoiceServiceRequestEvents requestEvents ) Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Includes optional additional request parameters like dynamic entities and maximum results.
abstract VoiceServiceRequest	ActivateImmediately ( WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents ) Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Includes optional additional request parameters like dynamic entities and maximum results.
abstract void	Cancel ( ) Cancels the current transcription. No FullTranscription event will fire.

Details

Object Data

DictationEvents Meta.WitAi.Dictation.DictationService.dictationEvents
summary> Internal events used to report telemetry. These events are reserved for internal use only and should not be used for any other purpose.

TelemetryEvents Meta.WitAi.Dictation.DictationService.telemetryEvents
No description available.

Fields

virtual bool Meta.WitAi.Dictation.DictationService.IsRequestActive
Returns true if the service is actively communicating with Wit.ai during an Activation. The mic may or may not still be active while this is true.

IAudioInputEvents Meta.WitAi.Dictation.DictationService.AudioEvents
A subset of events around collection of audio data

ITranscriptionEvent Meta.WitAi.Dictation.DictationService.TranscriptionEvents
A subset of events around receiving transcriptions

Properties

abstract ITranscriptionProvider Meta.WitAi.Dictation.DictationService.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

abstract bool Meta.WitAi.Dictation.DictationService.MicActive
Returns true if this voice service is currently reading data from the microphone

virtual DictationEvents Meta.WitAi.Dictation.DictationService.DictationEvents
No description available.

TelemetryEvents Meta.WitAi.Dictation.DictationService.TelemetryEvents
No description available.

abstract bool Meta.WitAi.Dictation.DictationService.ShouldSendMicData
Returns true if the audio input should be read in an activation

Object Data

override SpeechEvents Meta.WitAi.Dictation.DictationService.GetSpeechEvents ( )
If applicable, get all speech events

virtual void Meta.WitAi.Dictation.DictationService.Awake ( )
No description available.

virtual void Meta.WitAi.Dictation.DictationService.OnEnable ( )
No description available.

virtual void Meta.WitAi.Dictation.DictationService.OnDisable ( )
No description available.

Member Functions

void Meta.WitAi.Dictation.DictationService.Activate ( )
Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results.

void Meta.WitAi.Dictation.DictationService.Activate ( WitRequestOptions requestOptions )
Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results. Parameters requestOptions Additional options such as custom request id

VoiceServiceRequest Meta.WitAi.Dictation.DictationService.Activate ( VoiceServiceRequestEvents requestEvents )
Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results. Parameters requestOptions Additional options such as custom request id

abstract VoiceServiceRequest Meta.WitAi.Dictation.DictationService.Activate ( WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents )
Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results. Parameters requestOptions Additional options such as custom request id requestEvents Events specific to the request's lifecycle

void Meta.WitAi.Dictation.DictationService.ActivateImmediately ( )
Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Includes optional additional request parameters like dynamic entities and maximum results.

void Meta.WitAi.Dictation.DictationService.ActivateImmediately ( WitRequestOptions requestOptions )
Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Includes optional additional request parameters like dynamic entities and maximum results. Parameters requestOptions Additional options such as custom request id

VoiceServiceRequest Meta.WitAi.Dictation.DictationService.ActivateImmediately ( VoiceServiceRequestEvents requestEvents )
Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Includes optional additional request parameters like dynamic entities and maximum results. Parameters requestOptions Additional options such as custom request id

abstract VoiceServiceRequest Meta.WitAi.Dictation.DictationService.ActivateImmediately ( WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents )
Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Includes optional additional request parameters like dynamic entities and maximum results. Parameters requestOptions Additional options such as custom request id requestEvents Events specific to the request's lifecycle

abstract void Meta.WitAi.Dictation.DictationService.Cancel ( )
Cancels the current transcription. No FullTranscription event will fire.

Did you find this page helpful?