WindowsSpeechInputProvider Class

Definition

public ref class WindowsSpeechInputProvider : Microsoft::MixedReality::Toolkit::Input::BaseInputDeviceManager, IDisposable, Microsoft::MixedReality::Toolkit::IMixedRealityCapabilityCheck, Microsoft::MixedReality::Toolkit::Input::IMixedRealitySpeechSystem
[Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Windows Speech Input", "", "MixedRealityToolkit", false)]
[UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/input/speech")]
public class WindowsSpeechInputProvider : Microsoft.MixedReality.Toolkit.Input.BaseInputDeviceManager, IDisposable, Microsoft.MixedReality.Toolkit.IMixedRealityCapabilityCheck, Microsoft.MixedReality.Toolkit.Input.IMixedRealitySpeechSystem
[UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/input/speech")]
[Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Windows Speech Input", "", "MixedRealityToolkit", false, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)]
public class WindowsSpeechInputProvider : Microsoft.MixedReality.Toolkit.Input.BaseInputDeviceManager, IDisposable, Microsoft.MixedReality.Toolkit.IMixedRealityCapabilityCheck, Microsoft.MixedReality.Toolkit.Input.IMixedRealitySpeechSystem
[UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/input/speech")]
public class WindowsSpeechInputProvider : Microsoft.MixedReality.Toolkit.Input.BaseInputDeviceManager, IDisposable, Microsoft.MixedReality.Toolkit.IMixedRealityCapabilityCheck, Microsoft.MixedReality.Toolkit.Input.IMixedRealitySpeechSystem
[<Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Windows Speech Input", "", "MixedRealityToolkit", false)>]
[<UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/input/speech")>]
type WindowsSpeechInputProvider = class
    inherit BaseInputDeviceManager
    interface IMixedRealitySpeechSystem
    interface IMixedRealityInputDeviceManager
    interface IMixedRealityDataProvider
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityCapabilityCheck
[<UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/input/speech")>]
[<Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Windows Speech Input", "", "MixedRealityToolkit", false, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)>]
type WindowsSpeechInputProvider = class
    inherit BaseInputDeviceManager
    interface IMixedRealitySpeechSystem
    interface IMixedRealityInputDeviceManager
    interface IMixedRealityDataProvider
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityCapabilityCheck
[<UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/input/speech")>]
type WindowsSpeechInputProvider = class
    inherit BaseInputDeviceManager
    interface IMixedRealitySpeechSystem
    interface IMixedRealityInputDeviceManager
    interface IMixedRealityDataProvider
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityCapabilityCheck
Public Class WindowsSpeechInputProvider
Inherits BaseInputDeviceManager
Implements IDisposable, IMixedRealityCapabilityCheck, IMixedRealitySpeechSystem
Inheritance
Attributes
MixedRealityDataProviderAttribute UnityEngine.HelpURLAttribute
Implements

Constructors

WindowsSpeechInputProvider(IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)

Constructor.

WindowsSpeechInputProvider(IMixedRealityServiceRegistrar, IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)
Obsolete.

Constructor.

Fields

DefaultPriority (Inherited from BaseService)
disposed

Value indicating if the object has completed disposal.

(Inherited from BaseService)
InputSource

The Input Source for Windows Speech Input.

Properties

ConfigurationProfile

The configuration profile for the service.

(Inherited from BaseService)
EnablePointerCache

Control mechanism to enable/disable use of Pointer Cache in request/recycling of pointers by Input System

(Inherited from BaseInputDeviceManager)
InputSource

The Input Source for Windows Speech Input.

InputSystemProfile

The input system configuration profile in use in the application.

(Inherited from BaseInputDeviceManager)
IsEnabled

Indicates whether or not the service is currently enabled.

(Inherited from BaseService)
IsInitialized

Indicates whether or not the service has been initialized.

(Inherited from BaseService)
IsMarkedDestroyed

Indicates whether or not the Destroy method been called on this service.

(Inherited from BaseService)
IsRecognitionActive

Query whether or not the speech system is active

Name

Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action.

(Inherited from BaseService)
Priority

Optional Priority to reorder registered managers based on their respective priority, reduces the risk of race conditions by prioritizing the order in which managers are evaluated.

(Inherited from BaseService)
RecognitionConfidenceLevel

The minimum confidence level for the recognizer to fire an event.

Registrar
Obsolete.

The service registrar instance that registered this service.

(Inherited from BaseDataProvider<T>)
Service

The service instance to which this provider is providing data.

(Inherited from BaseDataProvider<T>)

Methods

CheckCapability(MixedRealityCapability)

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

Destroy()

Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed.

(Inherited from BaseInputDeviceManager)
Disable()

Optional Disable function to pause the service.

Dispose()

Cleanup resources used by this object.

(Inherited from BaseService)
Dispose(Boolean)

Cleanup resources used by the object

Enable()

Optional Enable function to enable / re-enable the service.

GetActiveControllers()

Retrieve all controllers currently registered with this device at runtime (if direct access is required)

(Inherited from BaseInputDeviceManager)
Initialize()

The initialize function is used to setup the service once created. This method is called once all services have been registered in the Mixed Reality Toolkit.

LateUpdate()

Optional LateUpdate function to that is called after Update has been called on all services.

(Inherited from BaseService)
RecyclePointers(IMixedRealityInputSource)

Recycle all pointers associated with the provided IMixedRealityInputSource. This involves reseting the pointer, disabling the pointer GameObject, and possibly caching it for re-use.

(Inherited from BaseInputDeviceManager)
RequestPointers(SupportedControllerType, Handedness)

Request an array of pointers for the controller type.

(Inherited from BaseInputDeviceManager)
Reset()

Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change.

(Inherited from BaseService)
StartRecognition()

Make sure the keyword recognizer is on, then stop it. Otherwise, leave it alone because it's already in the desired state.

StopRecognition()

Make sure the keyword recognizer is on, then stop it. Otherwise, leave it alone because it's already in the desired state.

Update()

Optional Update function to perform per-frame updates of the service.

Applies to