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

AppDictationExperience Class

Protected Fields

ShouldSendMicData : override bool
Signature
override bool Oculus.Voice.Dictation.AppDictationExperience.ShouldSendMicData

Fields

Active : override bool
Signature
override bool Oculus.Voice.Dictation.AppDictationExperience.Active
ActiveRequestOptions : WitRequestOptions
Signature
WitRequestOptions Oculus.Voice.Dictation.AppDictationExperience.ActiveRequestOptions
ActiveSession : DictationSession
Signature
DictationSession Oculus.Voice.Dictation.AppDictationExperience.ActiveSession
Configuration : WitConfiguration
Signature
WitConfiguration Oculus.Voice.Dictation.AppDictationExperience.Configuration
HasPlatformIntegrations : bool
Signature
bool Oculus.Voice.Dictation.AppDictationExperience.HasPlatformIntegrations
IsRequestActive : override bool
Signature
override bool Oculus.Voice.Dictation.AppDictationExperience.IsRequestActive
MicActive : override bool
Signature
override bool Oculus.Voice.Dictation.AppDictationExperience.MicActive
RuntimeConfiguration : WitRuntimeConfiguration
Signature
WitRuntimeConfiguration Oculus.Voice.Dictation.AppDictationExperience.RuntimeConfiguration

Properties

DoNotFallbackToWit : bool
[Get][Set]
Signature
bool Oculus.Voice.Dictation.AppDictationExperience.DoNotFallbackToWit
RuntimeDictationConfiguration : WitDictationRuntimeConfiguration
[Get][Set]
Signature
WitDictationRuntimeConfiguration Oculus.Voice.Dictation.AppDictationExperience.RuntimeDictationConfiguration
TranscriptionProvider : override ITranscriptionProvider
[Get][Set]
Signature
override ITranscriptionProvider Oculus.Voice.Dictation.AppDictationExperience.TranscriptionProvider
UsePlatformIntegrations : bool
[Get][Set]
Signature
bool Oculus.Voice.Dictation.AppDictationExperience.UsePlatformIntegrations

Events

OnInitialized : Action
Signature
Action Oculus.Voice.Dictation.AppDictationExperience.OnInitialized

Protected Methods

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

Methods

Activate ( requestOptions , requestEvents )
Activate the microphone and send data to Wit for NLU processing.
Signature
override VoiceServiceRequest Oculus.Voice.Dictation.AppDictationExperience.Activate(WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents)
Parameters
requestOptions: WitRequestOptions
Returns
override VoiceServiceRequest
ActivateImmediately ( requestOptions , requestEvents )
Activates immediately and starts sending data to the server. This will not wait for min wake threshold
Signature
override VoiceServiceRequest Oculus.Voice.Dictation.AppDictationExperience.ActivateImmediately(WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents)
Parameters
requestOptions: WitRequestOptions
Returns
override VoiceServiceRequest
Cancel ()
Deactivates and ignores any pending transcription content.
Signature
override void Oculus.Voice.Dictation.AppDictationExperience.Cancel()
Returns
override void
Deactivate ()
Deactivates. If a transcription is in progress the network request will complete and any additional transcription values will be returned.
Signature
override void Oculus.Voice.Dictation.AppDictationExperience.Deactivate()
Returns
override void
Toggle ()
Toggle dictation activation from on->off or off->on depending on the current active state.
Signature
void Oculus.Voice.Dictation.AppDictationExperience.Toggle()
Returns
void