Class WindowsDictationInputProvider

Inheritance

Object

WindowsDictationInputProvider

Implements

IMixedRealityDictationSystem

IMixedRealityCapabilityCheck

Namespace: Microsoft.MixedReality.Toolkit.Windows.Input

Assembly: cs.temp.dll.dll

Syntax

public class WindowsDictationInputProvider : BaseInputDeviceManager, IMixedRealityDictationSystem, IMixedRealityCapabilityCheck

Constructors

WindowsDictationInputProvider(IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)

Constructor.

Declaration

public WindowsDictationInputProvider(IMixedRealityInputSystem inputSystem, string name = null, uint priority = default(uint), BaseMixedRealityProfile profile = null)

Parameters

Type	Name	Description
IMixedRealityInputSystem	inputSystem	The IMixedRealityInputSystem instance that receives data from this provider.
String	name	Friendly name of the service.
UInt32	priority	Service priority. Used to determine order of instantiation.
BaseMixedRealityProfile	profile	The service's configuration profile.

WindowsDictationInputProvider(IMixedRealityServiceRegistrar, IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)

Constructor.

Declaration

[Obsolete("This constructor is obsolete (registrar parameter is no longer required) and will be removed in a future version of the Microsoft Mixed Reality Toolkit.")]
public WindowsDictationInputProvider(IMixedRealityServiceRegistrar registrar, IMixedRealityInputSystem inputSystem, string name = null, uint priority = default(uint), BaseMixedRealityProfile profile = null)

Parameters

Type	Name	Description
IMixedRealityServiceRegistrar	registrar	The IMixedRealityServiceRegistrar instance that loaded the data provider.
IMixedRealityInputSystem	inputSystem	The IMixedRealityInputSystem instance that receives data from this provider.
String	name	Friendly name of the service.
UInt32	priority	Service priority. Used to determine order of instantiation.
BaseMixedRealityProfile	profile	The service's configuration profile.

Properties

IsListening

Declaration

public bool IsListening { get; }

Property Value

Type	Description
Boolean

Methods

CheckCapability(MixedRealityCapability)

Checks to see if one or more registered data providers supports the requested capability on the current platform.

Declaration

public bool CheckCapability(MixedRealityCapability capability)

Parameters

Type	Name	Description
MixedRealityCapability	capability	The capability to check.

Returns

Type	Description
Boolean	True if the capability is supported, false otherwise.

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

Declaration

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

Parameters

Type	Name	Description
GameObject	listener
Single	initialSilenceTimeout
Single	autoSilenceTimeout
Int32	recordingTime
String	micDeviceName

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

Declaration

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

Parameters

Type	Name	Description
GameObject	listener
Single	initialSilenceTimeout
Single	autoSilenceTimeout
Int32	recordingTime
String	micDeviceName

Returns

Type	Description
Task

StopRecording()

Declaration

public void StopRecording()

StopRecordingAsync()

Declaration

public Task<AudioClip> StopRecordingAsync()

Returns

Type	Description
Task<AudioClip>

Implements

IMixedRealityDictationSystem

IMixedRealityCapabilityCheck