API reference
API reference
Select your platform
No SDKs available
No versions available

AppVoiceExperience Class

Extends Meta.WitAi.VoiceService
Implements Meta.WitAi.IWitRuntimeConfigProvider, Meta.WitAi.Interfaces.IWitConfigurationProvider

Protected Fields

ShouldSendMicData : override bool
Signature 
override bool Oculus.Voice.AppVoiceExperience.ShouldSendMicData

Fields

Active : override bool
Signature 
override bool Oculus.Voice.AppVoiceExperience.Active
Configuration : WitConfiguration
Signature 
WitConfiguration Oculus.Voice.AppVoiceExperience.Configuration
EnableConsoleLogging : bool
Signature 
bool Oculus.Voice.AppVoiceExperience.EnableConsoleLogging
HasPlatformIntegrations : bool
Signature 
bool Oculus.Voice.AppVoiceExperience.HasPlatformIntegrations
IsRequestActive : override bool
Signature 
override bool Oculus.Voice.AppVoiceExperience.IsRequestActive
MicActive : override bool
Signature 
override bool Oculus.Voice.AppVoiceExperience.MicActive

Properties

RuntimeConfiguration : WitRuntimeConfiguration
[Get][Set]
Signature 
WitRuntimeConfiguration Oculus.Voice.AppVoiceExperience.RuntimeConfiguration
TranscriptionProvider : override ITranscriptionProvider
[Get][Set]
Signature 
override ITranscriptionProvider Oculus.Voice.AppVoiceExperience.TranscriptionProvider
UsePlatformIntegrations : override bool
[Get][Set]
Signature 
override bool Oculus.Voice.AppVoiceExperience.UsePlatformIntegrations

Events

OnInitialized : Action
Signature 
Action Oculus.Voice.AppVoiceExperience.OnInitialized

Protected Methods

OnDisable ()
On enable, stop watching for request initialized callbacks
Signature 
override void Oculus.Voice.AppVoiceExperience.OnDisable()
Returns
override void
OnEnable ()
On enable, begin watching for request initialized callbacks
Signature 
override void Oculus.Voice.AppVoiceExperience.OnEnable()
Returns
override void
OnRequestComplete ( request )
Signature 
override void Oculus.Voice.AppVoiceExperience.OnRequestComplete(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
override void
OnRequestFullTranscription ( request , transcription )
Signature 
override void Oculus.Voice.AppVoiceExperience.OnRequestFullTranscription(VoiceServiceRequest request, string transcription)
Parameters
request: VoiceServiceRequest
transcription: string
Returns
override void
OnRequestInit ( request )
Signature 
override void Oculus.Voice.AppVoiceExperience.OnRequestInit(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
override void
OnRequestPartialTranscription ( request , transcription )
Signature 
override void Oculus.Voice.AppVoiceExperience.OnRequestPartialTranscription(VoiceServiceRequest request, string transcription)
Parameters
request: VoiceServiceRequest
transcription: string
Returns
override void
OnRequestSend ( request )
Signature 
override void Oculus.Voice.AppVoiceExperience.OnRequestSend(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
override void
OnRequestStartListening ( request )
Signature 
override void Oculus.Voice.AppVoiceExperience.OnRequestStartListening(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
override void
OnRequestStopListening ( request )
Signature 
override void Oculus.Voice.AppVoiceExperience.OnRequestStopListening(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
override void
OnRequestSuccess ( request )
Signature 
override void Oculus.Voice.AppVoiceExperience.OnRequestSuccess(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
override void

Methods

Activate ( text , requestOptions , requestEvents )
Send text data for NLU processing with custom request options.
Signature 
override async Task<VoiceServiceRequest> Oculus.Voice.AppVoiceExperience.Activate(string text, WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents)
Parameters
text: string  Text to be used for NLU processing
requestOptions: WitRequestOptions  Additional options such as dynamic entities
requestEvents: VoiceServiceRequestEvents  Events specific to the request's lifecycle
Returns
override async Task< VoiceServiceRequest >
Activate ( requestOptions , requestEvents )
Start listening for sound or speech from the user and start sending data to Wit.ai once sound or speech has been detected.
Signature 
override VoiceServiceRequest Oculus.Voice.AppVoiceExperience.Activate(WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents)
Parameters
requestOptions: WitRequestOptions  Additional options such as dynamic entities
requestEvents: VoiceServiceRequestEvents  Events specific to the request's lifecycle
Returns
override VoiceServiceRequest
ActivateImmediately ( requestOptions , requestEvents )
Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin.
Signature 
override VoiceServiceRequest Oculus.Voice.AppVoiceExperience.ActivateImmediately(WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents)
Parameters
requestOptions: WitRequestOptions  Additional options such as dynamic entities
requestEvents: VoiceServiceRequestEvents  Events specific to the request's lifecycle
Returns
override VoiceServiceRequest
CanActivateAudio ()
Whether an audio request can be started or not
Signature 
override bool Oculus.Voice.AppVoiceExperience.CanActivateAudio()
Returns
override bool
CanSend ()
Whether a voice service request can be sent or not
Signature 
override bool Oculus.Voice.AppVoiceExperience.CanSend()
Returns
override bool
Deactivate ()
Deactivate all requests
Signature 
override void Oculus.Voice.AppVoiceExperience.Deactivate()
Returns
override void
DeactivateAndAbortRequest ()
Deactivate and abort all locally originated requests
Signature 
override void Oculus.Voice.AppVoiceExperience.DeactivateAndAbortRequest()
Returns
override void
GetActivateAudioError ()
Check for error that will occur if attempting to activate audio
Signature 
override string Oculus.Voice.AppVoiceExperience.GetActivateAudioError()
Returns
override string  Returns an error audio activation should not be allowed.
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta