WindowsDictationInputProvider.StartRecordingAsync Method

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.Windows.Input

Assembly:: Microsoft.MixedReality.Toolkit.Providers.WindowsVoiceInput.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Turns on the dictation recognizer and begins recording audio from the default microphone.

public System.Threading.Tasks.Task StartRecordingAsync (UnityEngine.GameObject listener = default, float initialSilenceTimeout = 5, float autoSilenceTimeout = 20, int recordingTime = 10, string micDeviceName = "");

abstract member StartRecordingAsync : UnityEngine.GameObject * single * single * int * string -> System.Threading.Tasks.Task
override this.StartRecordingAsync : UnityEngine.GameObject * single * single * int * string -> System.Threading.Tasks.Task

Public Function StartRecordingAsync (Optional listener As GameObject = Nothing, Optional initialSilenceTimeout As Single = 5, Optional autoSilenceTimeout As Single = 20, Optional recordingTime As Integer = 10, Optional micDeviceName As String = "") As Task

Parameters

listener: UnityEngine.GameObject

GameObject listening for the dictation input.

initialSilenceTimeout: Single

The time length in seconds before dictation recognizer session ends due to lack of audio input in case there was no audio heard in the current session.

autoSilenceTimeout: Single

The time length in seconds before dictation recognizer session ends due to lack of audio input.

recordingTime: Int32

Length in seconds for the manager to listen.

micDeviceName: String

Optional: The microphone device to listen to.

Returns

Task

Implements

StartRecordingAsync(GameObject, Single, Single, Int32, String)

Applies to