Interface IMixedRealityDictationSystem

Mixed Reality Toolkit controller definition, used to manage a specific controller type

Inherited Members

IMixedRealityInputDeviceManager.GetActiveControllers()

IMixedRealityService.Name

IMixedRealityService.Priority

IMixedRealityService.ConfigurationProfile

IMixedRealityService.Initialize()

IMixedRealityService.Reset()

IMixedRealityService.Enable()

IMixedRealityService.Update()

IMixedRealityService.LateUpdate()

IMixedRealityService.Disable()

IMixedRealityService.Destroy()

Namespace: Microsoft.MixedReality.Toolkit.Input

Assembly: cs.temp.dll.dll

Syntax

public interface IMixedRealityDictationSystem : IMixedRealityInputDeviceManager, IMixedRealityDataProvider, IMixedRealityService, IDisposable

Properties

IsListening

Is the system currently listing for dictation input?

Declaration

bool IsListening { get; }

Property Value

Type	Description
Boolean

IsListening

Is the system currently listing for dictation input?

Declaration

bool IsListening { get; }

Property Value

Type	Description
Boolean

Methods

StartRecording(GameObject, Single, Single, Int32, String)

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

Declaration

void StartRecording(GameObject listener, float initialSilenceTimeout = 5F, float autoSilenceTimeout = 20F, int recordingTime = 10, string micDeviceName = "")

Parameters

Type	Name	Description
GameObject	listener	GameObject listening for the dictation input.
Single	initialSilenceTimeout	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.
Single	autoSilenceTimeout	The time length in seconds before dictation recognizer session ends due to lack of audio input.
Int32	recordingTime	Length in seconds for the manager to listen.
String	micDeviceName	Optional: The microphone device to listen to.

StartRecording(GameObject, Single, Single, Int32, String)

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

Declaration

void StartRecording(GameObject listener, float initialSilenceTimeout = 5F, float autoSilenceTimeout = 20F, int recordingTime = 10, string micDeviceName = "")

Parameters

Type	Name	Description
GameObject	listener	GameObject listening for the dictation input.
Single	initialSilenceTimeout	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.
Single	autoSilenceTimeout	The time length in seconds before dictation recognizer session ends due to lack of audio input.
Int32	recordingTime	Length in seconds for the manager to listen.
String	micDeviceName	Optional: The microphone device to listen to.

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

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

Declaration

Task StartRecordingAsync(GameObject listener, float initialSilenceTimeout = 5F, float autoSilenceTimeout = 20F, int recordingTime = 10, string micDeviceName = "")

Parameters

Type	Name	Description
GameObject	listener	GameObject listening for the dictation input.
Single	initialSilenceTimeout	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.
Single	autoSilenceTimeout	The time length in seconds before dictation recognizer session ends due to lack of audio input.
Int32	recordingTime	Length in seconds for the manager to listen.
String	micDeviceName	Optional: The microphone device to listen to.

Returns

Type	Description
Task

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

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

Declaration

Task StartRecordingAsync(GameObject listener, float initialSilenceTimeout = 5F, float autoSilenceTimeout = 20F, int recordingTime = 10, string micDeviceName = "")

Parameters

Type	Name	Description
GameObject	listener	GameObject listening for the dictation input.
Single	initialSilenceTimeout	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.
Single	autoSilenceTimeout	The time length in seconds before dictation recognizer session ends due to lack of audio input.
Int32	recordingTime	Length in seconds for the manager to listen.
String	micDeviceName	Optional: The microphone device to listen to.

Returns

Type	Description
Task

StopRecording()

Ends the recording session.

Declaration

void StopRecording()

StopRecording()

Ends the recording session.

Declaration

void StopRecording()

StopRecordingAsync()

Ends the recording session.

Declaration

Task<AudioClip> StopRecordingAsync()

Returns

Type	Description
Task<AudioClip>	AudioClip of the last recording session.

StopRecordingAsync()

Ends the recording session.

Declaration

Task<AudioClip> StopRecordingAsync()

Returns

Type	Description
Task<AudioClip>	AudioClip of the last recording session.