Nav Logo
Build with Meta
Social Technologies
Meta Horizon
AI
Horizon Worlds
About us
Careers
Research
Products
Virtual reality / Meta Horizon
Developer Blog
Download SDKs
Meta for Work
Programs
Start
Meta Horizon Creator Program
Discover
Why Meta Quest?
What is mixed reality?
Platforms and tools
2D apps for Meta Horizon OS
Devices
Meta Avatars
Success stories
Use cases
Support and legal
Developer policies
Legal
Privacy
Forums
Support
Build with Meta
Social Technologies
Meta Horizon
AI
Horizon Worlds
About us
Careers
Research
Products
Virtual reality / Meta Horizon
Developer Blog
Download SDKs
Meta for Work
Programs
Start
Meta Horizon Creator Program
Discover
Why Meta Quest?
What is mixed reality?
Platforms and tools
2D apps for Meta Horizon OS
Devices
Meta Avatars
Success stories
Use cases
Support and legal
Developer policies
Legal
Privacy
Forums
Support
Build with Meta
Social Technologies
Meta Horizon
AI
Horizon Worlds
About us
Careers
Research
Products
Virtual reality / Meta Horizon
Developer Blog
Download SDKs
Meta for Work
Programs
Start
Meta Horizon Creator Program
Discover
Why Meta Quest?
What is mixed reality?
Platforms and tools
2D apps for Meta Horizon OS
Devices
Meta Avatars
Success stories
Use cases
Support and legal
Developer policies
Legal
Privacy
Forums
Support
English (US)
© 2025 Meta
API reference
API reference
Select your platform
No SDKs available
No versions available
Overview
AudioClipAudioSource
ImageViewer
Lib
Conduit
Editor
Editor
SourceCodeMapper
Wit
Runtime
Requests
Requests
IWitVRequestFactory
WitVRequestFactory
Utilities
Logging
Logging
ILogSource
BaseAudioClipInput
IAudioLevelRangeProvider
Mic
MicBase
MicEditor
VoiceLipSyncMic
Meta
Conduit
Conduit
ConduitActionAttribute
ConduitAssemblyAttribute
ConduitDispatcher
ConduitDispatcher
InvocationContextFilter
ConduitDispatcherFactory
ConduitEntityAttribute
ConduitParameterAttribute
ConduitParameterValue
ConduitUtilities
ConduitValueAttribute
Editor
Editor
AssemblyMiner
AssemblyWalker
ConduitAssembly
ConduitStatistics
EntitiesDelta
EnumCodeWrapper
EnumSynchronizer
IAssemblyMiner
IAssemblyWalker
IConduitAssembly
IParameterFilter
IParameterValidator
IPersistenceLayer
KeywordsDelta
ManifestGenerator
PersistenceLayer
FileIo
HandleEntityResolutionFailure
IConduitDispatcher
IFileIo
IInstanceResolver
IManifestLoader
IManifestMethod
IParameterProvider
InvocationContext
ListExtensions
Manifest
ManifestAction
ManifestEntity
ManifestErrorHandler
ManifestLoader
ManifestParameter
ParameterProvider
WitKeyword
Net
NativeWebSocket
NativeWebSocket
IWebSocket
MainThreadUtil
WaitForBackgroundThread
WaitForUpdate
WaitForUpdate
MainThreadAwaiter
WebSocket
WebSocketException
WebSocketFactory
WebSocketHelpers
WebSocketInvalidArgumentException
WebSocketInvalidStateException
WebSocketUnexpectedException
Voice
Voice
AboutWindow
Audio
Audio
AudioClipSettings
BaseAudioClipStream
BaseAudioPlayer
BaseAudioSystem
Decoding
Decoding
AudioDecoderJson
AudioDecoderMp3
AudioDecoderMp3Frame
AudioDecoderOpus
AudioDecoderPcm
AudioDecoderWav
IAudioDecoder
IAudioClipProvider
IAudioClipSetter
IAudioClipStream
IAudioPlayer
IAudioSourceProvider
IAudioSystem
RawAudioClipStream
UnityAudioPlayer
UnityAudioSystem
Hub
Hub
Attributes
Attributes
MetaHubContextAttribute
MetaHubPageAttribute
MetaHubPageScriptableObjectAttribute
Content
Content
Sample
SamplesPage
ImageDisplayScriptableObjectEditor
ImagePage
Inspectors
Inspectors
SampleEditor
SamplesPageInspector
Interfaces
Interfaces
IMetaHubPage
IOverrideSize
IPageInfo
Markdown
Markdown
MarkdownInspector
MarkdownPage
MetaHub
MetaHubContext
MetaHubContext
ScriptableObjectReflectionPage
MetaHubPage
ScriptableObjectPage
SettingsWindowPage
UIComponents
UIComponents
FoldoutGroup
FoldoutHierarchy
FoldoutHierarchyItem
ImageView
Utilities
Utilities
ContextFinder
PageFinder
ReflectionUtils
INLPRequestOptions
INLPRequestResponseDecoder
INLPRequestResults
ITranscriptionRequestOptions
ITranscriptionRequestResults
IVoiceRequestOptions
IVoiceRequestResults
Logging
Logging
CorrelationID
ErrorCode
ErrorMitigator
ICoreLogger
IErrorMitigator
ILogScope
ILogSink
ILogWriter
ILoggerRegistry
IVLogger
IVLoggerFactory
LazyLogger
LogCategoryAttribute
LogEntry
LogScope
LogSink
LoggerOptions
LoggerRegistry
LoggingContext
RingDictionaryBuffer
UnityLogWriter
VLogger
VLoggerFactory
NLPRequest
NLPRequestEvents
NLPRequestResponseEvent
NLPRequestResponseValidatorEvent
NLayer
NLayer
Decoder
Decoder
BitReservoir
FrameBase
Huffman
ID3Frame
LayerDecoderBase
LayerIDecoder
LayerIIDecoder
LayerIIDecoderBase
LayerIIIDecoder
MpegFrame
MpegStreamReader
RiffHeaderFrame
VBRInfo
IMpegFrame
MpegFile
MpegFrameDecoder
Net
Encoding
Wit
Wit
WitChunk
WitChunkConverter
WitChunkHeader
PubSub
PubSub
IPubSubAdapter
IPubSubSubscriber
WebSockets
WebSockets
IWebSocket
IWitWebSocketClient
IWitWebSocketClientProvider
IWitWebSocketRequest
NativeWebSocketWrapper
Requests
Requests
WitWebSocketAuthRequest
WitWebSocketJsonRequest
WitWebSocketMessageRequest
WitWebSocketSpeechRequest
WitWebSocketSubscriptionRequest
WitWebSocketTranscribeRequest
WitWebSocketTtsRequest
WitWebSocketAdapter
WitWebSocketClient
WitWebSocketSettings
Samples
BuiltInTimer
BuiltInTimer
TimerController
TimerDisplay
Chess
Chess
ChessBoardController
Dictation
Dictation
DictationActivation
SimpleLabelResizer
LightTraits
LightTraits
LightSwitch
LiveUnderstanding
LiveUnderstanding
LiveUnderstandingColorChanger
Shapes
Shapes
ColorChanger
ParallelTextActivator
ShapeSampleInstructions
ShapesConduit
ShapesConduit
ColorChangerConduit
TTSVoices
TTSVoices
SimpleDropdownList
TTSCacheToggle
TTSSpeakerEffectSelect
TTSSpeakerVoiceSelect
TelemetryUtilities
TelemetryUtilities
EditorTelemetry
ITelemetryWriter
OperationID
RuntimeTelemetry
Telemetry
TelemetryConsentManager
TranscriptionRequest
TranscriptionRequestEvent
TranscriptionRequestEvents
UnityOpus
UnityOpus
Decoder
Encoder
Library
VSDKHub
VSDKHub
VoiceHubConstants
VoiceSDKHub
VoiceRequest
VoiceRequestEvents
Windows
Windows
SettingsWindow
SettingsWindowPage
WitConfigWindowPage
WitAi
WitAi
ArrayNodeReference
ArrayPool
Attributes
Attributes
ButtonAttribute
DropDownAttribute
HiddenTextAttribute
HideIfAttribute
HideWhenSetAttribute
LabelAttribute
ObjectTypeAttribute
ShowIfAttribute
TooltipBoxAttribute
WitConfigurationAssetRefreshAttribute
AudioDurationTracker
BaseSpeechService
CallbackHandlers
CallbackHandlers
ConfidenceRange
FormattedValueEvents
OutOfScopeUtteranceHandler
SimpleIntentHandler
SimpleIntentHandlerEditor
SimpleStringEntityHandler
SimpleStringEntityHandlerEditor
ValuePathMatcher
ValuePathMatcherPropertyDrawer
WitIntentMatcher
WitIntentMatcherEditor
WitResponseHandler
WitResponseMatcher
WitUtteranceMatcher
Comment
ComponentExtensions
ComponentExtensions
ComponentCopyData
Configuration
Configuration
WitDictationRuntimeConfiguration
WitEndpointConfig
WitRequestOptions
WitRuntimeConfiguration
CoroutineUtility
CoroutineUtility
CoroutinePerformer
Data
Data
AudioBuffer
AudioBufferConfiguration
AudioEncoding
Configuration
Configuration
Tabs
Tabs
WitConfigurationApplicationTab
WitConfigurationEditorTab
WitConfigurationEntitiesTab
WitConfigurationIntentsTab
WitConfigurationTraitsTab
WitConfigurationVoicesTab
WitConfiguration
WitConfigurationAssetData
WitConfigurationUtility
Entities
Entities
DynamicEntityDataProvider
DynamicEntityKeywordRegistry
DynamicEntityProvider
RegisteredDynamicEntityKeyword
WitDynamicEntities
WitDynamicEntitiesData
WitDynamicEntity
WitEntityData
WitEntityDataBase
WitEntityFloatData
WitEntityIntData
WitSimpleDynamicEntity
Info
Info
WitAppInfo
WitContextMapInfo
WitEntityInfo
WitEntityKeywordInfo
WitEntityRoleInfo
WitExportInfo
WitIntentEntityInfo
WitIntentInfo
WitTraitInfo
WitTraitValueInfo
WitVersionTagInfo
WitVoiceInfo
Intents
Intents
WitIntentData
RingBuffer
RingBuffer
Marker
SimulatedResponse
SimulatedResponseMessage
ValueReferences
ValueReferences
IStringReference
StringReference
VoiceSession
WitDataCreation
WitFloatValue
WitIntValue
WitStringValue
WitValue
Dictation
Dictation
Data
Data
DictationSession
DictationService
Events
Events
DictationEvents
Editor
IDictationService
MultiRequestTranscription
WitDictation
Drawers
Drawers
ButtonAttributeDrawer
DynamicRangeAttributeDrawer
HiddenTextAttributeDrawer
HideIfDrawer
ShowIfDrawer
StringReferenceDrawer
TooltipBoxDrawer
EditorUtilities
EditorUtilities
SerializedPropertyExtensions
EnumerableExtensions
Events
Events
AudioBufferEvents
Editor
Editor
EventPropertyDrawer
VoiceEventPropertyDrawer
EventCategoryAttribute
EventRegistry
IWitByteDataReadyHandler
IWitByteDataSentHandler
SpeechEvents
TelemetryEvents
UnityEventListeners
UnityEventListeners
AudioEventListener
TranscriptionEventListener
VoiceEvents
WitByteDataEvent
WitErrorEvent
WitObjectEvent
WitSampleEvent
ExportParser
ExportSaver
IExportParserPlugin
IRequest
ITelemetryEventsProvider
IVoiceActivationHandler
IVoiceEventProvider
IVoiceService
IWitRequestConfiguration
IWitRequestEndpointInfo
IWitRuntimeConfigProvider
IWitRuntimeConfigSetter
Inspectors
Inspectors
WitInspector
Interfaces
Interfaces
CustomTranscriptionProvider
IAudioEventProvider
IAudioInputEvents
IAudioInputSource
IAudioUploadHandler
IDataUploadHandler
IDynamicEntitiesProvider
IPlatformIntegrationOverride
ITranscriptionEvent
ITranscriptionEventProvider
ITranscriptionProvider
IVoiceServiceRequestProvider
IWitConfigurationProvider
IWitConfigurationSetter
IWitInspectorTools
Json
Json
BaseJsonVariableInfo
ColorConverter
DateTimeConverter
HashSetConverter
IJsonDeserializer
IJsonSerializer
IJsonVariableInfo
JSONParseException
JsonConvert
JsonConverter
JsonFieldInfo
JsonIgnoreAttribute
JsonPropertyAttribute
JsonPropertyInfo
WitResponseArray
WitResponseClass
WitResponseData
WitResponseJson
WitResponseLazyCreator
WitResponseNode
Lib
Lib
BaseAudioClipInput
IAudioLevelRangeProvider
Mic
MicBase
MicEditor
VoiceLipSyncMic
MatchIntent
MatchIntentRegistry
ObjectNodeReference
ObjectPool
PluggableBase
RegisteredMatchIntent
Requests
Requests
AudioStreamHandler
IVRequest
IVRequestDownloadDecoder
IWitInfoVRequest
IWitSyncVRequest
IWitVRequest
TextStreamHandler
VRequest
VRequestResponse
VoiceEventToRequestEventMapper
VoiceServiceMockRequest
VoiceServiceRequest
VoiceServiceRequestEvent
VoiceServiceRequestEvents
VoiceServiceRequestEventsWrapper
VoiceServiceRequestOptions
VoiceServiceRequestOptions
QueryParam
VoiceServiceRequestResults
WitInfoVRequest
WitMessageVRequest
WitResponseDecoder
WitSocketRequest
WitSyncVRequest
WitTTSVRequest
WitUnityRequest
WitVRequest
ServiceReferences
ServiceReferences
AudioInputServiceReference
CombinedAudioEventReference
DictationServiceAudioEventReference
VoiceServiceAudioEventReference
Speech
Speech
ISpeechEventProvider
VoiceSpeechEvents
TTS
TTS
Data
Data
ITTSEvent
TTSClipData
TTSDiskCacheSettings
TTSEvent
TTSEventContainer
TTSPhonemeEvent
TTSStringEvent
TTSVisemeEvent
TTSVoiceSettings
TTSWordEvent
Events
Events
TTSDownloadEvents
TTSServiceEvents
TTSStreamEvents
TTSWebRequestEvents
Integrations
Integrations
BaseTTSRuntimeCache
TTSDiskCache
TTSEventAnimator
TTSRuntimeLRUCache
TTSRuntimePlaybackCache
TTSWit
TTSWitRequestSettings
TTSWitVoiceSettings
Interfaces
Interfaces
ISpeaker
ISpeakerTextPostprocessor
ISpeakerTextPreprocessor
ITTSDiskCacheHandler
ITTSEventPlayer
ITTSRuntimeCacheHandler
ITTSVoiceProvider
ITTSWebHandler
LipSync
LipSync
BaseTextureFlipLipSync
BaseTextureFlipLipSync
VisemeTextureData
BaseVisemeBlendShapeLipSync
BaseVisemeBlendShapeLipSync
VisemeBlendShapeData
VisemeBlendShapeWeight
ILipsyncAnimator
IVisemeAnimatorProvider
VisemeBlendShapeLipSync
VisemeChangedEvent
VisemeLerpEvent
VisemeLipSyncAnimator
VisemeTextureFlipLipSync
Preload
Preload
TTSPreloadData
TTSPreloadPhraseData
TTSPreloadSettings
TTSPreloadSettingsInspector
TTSPreloadUtility
TTSPreloadVoiceData
Samples
Samples
TTSStreamToggle
TTSEditorUtilities
TTSService
TTSServiceInspector
TTSSpeakerInspector
TTSWitInspector
UX
UX
TTSSpeakerErrorLabel
TTSSpeakerObserver
TTSSpeakerStatusLabel
Utilities
Utilities
ITTSPhraseProvider
TTSSpeaker
TTSSpeakerAutoLoader
TTSSpeakerBodyAnimator
TTSSpeakerClipEvent
TTSSpeakerClipEvents
TTSSpeakerClipMessageEvent
TTSSpeakerEvents
TTSSpeechSplitter
Voices
Voices
TTSWitVoiceSettingsDrawer
TaskExtensions
TaskUtility
ThreadUtility
TypeExtensions
UnityEventExtensions
UnityObjectExtensions
Utilities
Utilities
AssetDatabaseUtility
CaptionData
DictationServiceReference
DictionaryList
DynamicRangeAttribute
FloatToStringEvent
GameObjectSearchUtility
IOUtility
ReflectionUtils
StringToStringEvent
VoiceServiceReference
WitRuntimeStyles
VLog
ValidatePartialIntent
VoiceService
Windows
Windows
BaseWitWindow
Components
Components
WitMultiSelectionPopup
WitMultiSelectionPopupContent
ConduitManifestGenerationManager
ConfidenceRangeDrawer
FieldGUI
WitApplicationPropertyDrawer
WitConfigurationEditor
WitConfigurationWindow
WitEndpointConfigDrawer
WitEntityPropertyDrawer
WitEntityRolePropertyDrawer
WitIntentPropertyDrawer
WitParameterFilter
WitParameterValidator
WitPropertyDrawer
WitScriptableWizard
WitSimplePropertyDrawer
WitTraitPropertyDrawer
WitTraitValuePropertyDrawer
WitUnderstandingViewer
WitUnderstandingViewerServiceAPI
WitUnderstandingViewerServiceApiFactory
WitUnderstandingViewerVoiceServiceAPI
WitWelcomeWizard
WitWindow
WitWindowUtility
Wit
WitAppInfoUtility
WitAuthUtility
WitAuthUtility
DefaultTokenValidatorProvider
ITokenValidationProvider
WitConduitParameterProvider
WitConfigurationEditorUI
WitConstants
WitEditorConstants
WitEditorUI
WitExportRetriever
WitRequest
WitRequestFactory
WitRequestSettings
WitResponseReference
WitResultUtilities
WitRuntimeRequestConfiguration
WitService
WitStyles
WitTexts
WitTexts
WitText
WrapHttpWebRequest
ZipArchiveExtensions
Oculus
Voice
Voice
AppBuiltIns
AppVoiceExperience
Bindings
Android
Android
IVCBindingEvents
VoiceSDKBinding
VoiceSDKConfigBinding
VoiceSDKImpl
VoiceSDKImplRequest
VoiceSDKListenerBinding
Core
Bindings
Android
Android
AndroidServiceConnection
BaseAndroidConnectionImpl
BaseServiceBinding
PlatformLogger
PlatformLogger
VoiceSDKConsoleLoggerImpl
VoiceSDKLoggerBinding
VoiceSDKPlatformLoggerImpl
Interfaces
Interfaces
IConnection
IVoiceSDKLogger
Utilities
Utilities
ArrayElementTitleAttribute
ArrayElementTitleDrawer
AssistantEditorUtils
DateTimeUtility
Data
Data
VoiceSDKDataCreation
Dictation
Dictation
AppDictationExperience
AppDictationExperienceEditor
Bindings
Android
Android
DictationConfigurationBinding
DictationListenerBinding
IServiceEvents
PlatformDictationImpl
PlatformDictationSDKBinding
PlatformDictationSession
Configuration
Configuration
DictationConfiguration
Data
Data
AppDictationDataCreation
Inspectors
Inspectors
WitDictationRuntimeConfigDrawer
Listeners
Listeners
DictationListener
Inspectors
Inspectors
AppVoiceExperienceWitConfigurationEditor
Interfaces
Interfaces
IPlatformVoiceService
Logging
Logging
TTSServiceLogging
ObjectVoiceExperience
UX
UX
HierarchySimplifier
HierarchySimplifierInspector
Upgrade
Upgrade
WitUpgrader
Utility
Utility
InspectorHelper
VoiceSDKMenu
VoiceSDKStyles
VoiceSDKStyles
VoiceSDKTexts
VoiceSDKVersion
VoiceSDKConstants
Windows
Windows
UnderstandingViewerWindow
VoiceApplicationDetailProvider
VoiceSDKTokenValidatorProvider
WelcomeWizard
VoiceSDK
UX
UX
VoiceActivationButton
VoiceTranscriptionLabel
Utilities
Utilities
MicPermissionsManager
Code samples
Downloads
Release notes
Supported platforms
Meta
​
Back to Supported platforms
DictationService Class
Extends BaseSpeechService, IDictationService, IAudioEventProvider, ITranscriptionEventProvider
Protected Fields
DictationEvents dictationEvents[Get]
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 telemetryEvents[Get]
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
Protected Functions
virtual override SpeechEvents GetSpeechEvents ( )
If applicable, get all speech events
virtual void Awake ( )
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.
Parameters
requestOptions
Additional options such as custom request id
VoiceServiceRequest 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 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 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.
Parameters
requestOptions
Additional options such as custom request id
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.
Parameters
requestOptions
Additional options such as custom request id
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.
Parameters
requestOptions
Additional options such as custom request id
requestEvents
Events specific to the request's lifecycle
abstract void Cancel ( )
Cancels the current transcription. No FullTranscription event will fire.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Why Meta Quest?
Design
Develop
API reference
Distribute
Blog
Support
Login