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

AppVoiceExperience Class

Oculus::Voice::AppVoiceExperience extends Meta.WitAi.VoiceService.
Oculus::Voice::AppVoiceExperience extends Meta.WitAi.IWitRuntimeConfigProvider.
Oculus::Voice::AppVoiceExperience extends Meta.WitAi.Interfaces.IWitConfigurationProvider.

Overview

Data Fields

override bool
Active[Get]
override bool
override bool
bool
bool

Events

Action

Object Data

override bool

Public Member Functions

override bool
CanSend ( )
Whether a voice service request can be sent or not
Activate
( string text,
WitRequestOptions requestOptions,
VoiceServiceRequestEvents requestEvents )
Send text data for NLU processing with custom request options.
override bool
Whether an audio request can be started or not
override string
Check for error that will occur if attempting to activate audio
Activate
( WitRequestOptions requestOptions,
VoiceServiceRequestEvents requestEvents )
Start listening for sound or speech from the user and start sending data to Wit.ai once sound or speech has been detected.
Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin.
override void
Deactivate all requests
override void
Deactivate and abort all requests

Object Data

override void
On enable, begin watching for request initialized callbacks
override void
On enable, stop watching for request initialized callbacks
override void
override void
override void
override void
override void
override void
override void
override void

Details

Properties

WitRuntimeConfiguration Oculus.Voice.AppVoiceExperience.RuntimeConfiguration
No description available.
override ITranscriptionProvider Oculus.Voice.AppVoiceExperience.TranscriptionProvider
No description available.
override bool Oculus.Voice.AppVoiceExperience.UsePlatformIntegrations
No description available.

Fields

WitConfiguration Oculus.Voice.AppVoiceExperience.Configuration
No description available.
override bool Oculus.Voice.AppVoiceExperience.Active
No description available.
override bool Oculus.Voice.AppVoiceExperience.IsRequestActive
No description available.
override bool Oculus.Voice.AppVoiceExperience.MicActive
No description available.
bool Oculus.Voice.AppVoiceExperience.HasPlatformIntegrations
No description available.
bool Oculus.Voice.AppVoiceExperience.EnableConsoleLogging
No description available.

Events

Action Oculus.Voice.AppVoiceExperience.OnInitialized ( )
No description available.

Object Data

override bool Oculus.Voice.AppVoiceExperience.ShouldSendMicData
No description available.

Member Functions

override bool Oculus.Voice.AppVoiceExperience.CanSend ( )
Whether a voice service request can be sent or not
override VoiceServiceRequest Oculus.Voice.AppVoiceExperience.Activate
( string text,
WitRequestOptions requestOptions,
VoiceServiceRequestEvents requestEvents )
Send text data for NLU processing with custom request options.
Parameters
text
Text to be used for NLU processing
requestOptions
Additional options such as dynamic entities
requestEvents
Events specific to the request's lifecycle
override bool Oculus.Voice.AppVoiceExperience.CanActivateAudio ( )
Whether an audio request can be started or not
override string Oculus.Voice.AppVoiceExperience.GetActivateAudioError ( )
Check for error that will occur if attempting to activate audio
Returns
Returns an error audio activation should not be allowed.
override VoiceServiceRequest Oculus.Voice.AppVoiceExperience.Activate
( WitRequestOptions requestOptions,
VoiceServiceRequestEvents requestEvents )
Start listening for sound or speech from the user and start sending data to Wit.ai once sound or speech has been detected.
Parameters
requestOptions
Additional options such as dynamic entities
requestEvents
Events specific to the request's lifecycle
override VoiceServiceRequest Oculus.Voice.AppVoiceExperience.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.
Parameters
requestOptions
Additional options such as dynamic entities
requestEvents
Events specific to the request's lifecycle
override void Oculus.Voice.AppVoiceExperience.Deactivate ( )
Deactivate all requests
override void Oculus.Voice.AppVoiceExperience.DeactivateAndAbortRequest ( )
Deactivate and abort all requests

Object Data

override void Oculus.Voice.AppVoiceExperience.OnEnable ( )
On enable, begin watching for request initialized callbacks
override void Oculus.Voice.AppVoiceExperience.OnDisable ( )
On enable, stop watching for request initialized callbacks
override void Oculus.Voice.AppVoiceExperience.OnRequestInit
( VoiceServiceRequest request )
No description available.
override void Oculus.Voice.AppVoiceExperience.OnRequestStartListening
( VoiceServiceRequest request )
No description available.
override void Oculus.Voice.AppVoiceExperience.OnRequestStopListening
( VoiceServiceRequest request )
No description available.
override void Oculus.Voice.AppVoiceExperience.OnRequestSend
( VoiceServiceRequest request )
No description available.
override void Oculus.Voice.AppVoiceExperience.OnRequestPartialTranscription
( VoiceServiceRequest request )
No description available.
override void Oculus.Voice.AppVoiceExperience.OnRequestFullTranscription
( VoiceServiceRequest request )
No description available.
override void Oculus.Voice.AppVoiceExperience.OnRequestSuccess
( VoiceServiceRequest request )
No description available.
override void Oculus.Voice.AppVoiceExperience.OnRequestComplete
( VoiceServiceRequest request )
No description available.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon