Class MixedRealityInputSystem

The Mixed Reality Toolkit's specific implementation of the IMixedRealityInputSystem

Inheritance
Object
BaseService
BaseEventSystem
BaseCoreSystem
BaseDataProviderAccessCoreSystem
MixedRealityInputSystem
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public class MixedRealityInputSystem : BaseDataProviderAccessCoreSystem, IMixedRealityDataProviderAccess, IMixedRealityInputSystem, IMixedRealityEventSystem, IMixedRealityService, IDisposable, IMixedRealityCapabilityCheck

Constructors

MixedRealityInputSystem(IMixedRealityServiceRegistrar, MixedRealityInputSystemProfile)

Constructor.

Declaration
public MixedRealityInputSystem(IMixedRealityServiceRegistrar registrar, MixedRealityInputSystemProfile profile)
Parameters
Type Name Description
IMixedRealityServiceRegistrar registrar

The IMixedRealityServiceRegistrar instance that loaded the service.
MixedRealityInputSystemProfile profile

The configuration profile for the service.

MixedRealityInputSystem(MixedRealityInputSystemProfile)

Constructor.

Declaration
public MixedRealityInputSystem(MixedRealityInputSystemProfile profile)
Parameters
Type Name Description
MixedRealityInputSystemProfile profile

The configuration profile for the service.

Properties

DetectedControllers

List of IMixedRealityControllers currently detected by the input manager.

Declaration
public HashSet<IMixedRealityController> DetectedControllers { get; }
Property Value
Type Description
HashSet<IMixedRealityController>
Remarks

This property is similar to DetectedInputSources, as this is a subset of those IMixedRealityInputSources in that list.

DetectedInputSources

List of the Interaction Input Sources as detected by the input manager like hands or motion controllers.

Declaration
public HashSet<IMixedRealityInputSource> DetectedInputSources { get; }
Property Value
Type Description
HashSet<IMixedRealityInputSource>

EyeGazeProvider

The current Eye Gaze Provider that's been implemented by this Input System.

Declaration
public IMixedRealityEyeGazeProvider EyeGazeProvider { get; }
Property Value
Type Description
IMixedRealityEyeGazeProvider

FocusProvider

The current Focus Provider that's been implemented by this Input System.

Declaration
public IMixedRealityFocusProvider FocusProvider { get; }
Property Value
Type Description
IMixedRealityFocusProvider

GazeProvider

The current Gaze Provider that's been implemented by this Input System.

Declaration
public IMixedRealityGazeProvider GazeProvider { get; }
Property Value
Type Description
IMixedRealityGazeProvider

InputSystemProfile

Typed representation of the ConfigurationProfile property.

Declaration
public MixedRealityInputSystemProfile InputSystemProfile { get; }
Property Value
Type Description
MixedRealityInputSystemProfile

IsInputEnabled

Indicates if input is currently enabled or not.

Declaration
public bool IsInputEnabled { get; }
Property Value
Type Description
Boolean

Name

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

Declaration
public override string Name { get; protected set; }
Property Value
Type Description
String
Overrides

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.

Declaration
public override uint Priority { get; }
Property Value
Type Description
UInt32
Overrides
Remarks

Input system is critical, so should be processed before all other managers

RaycastProvider

The current Raycast Provider that's been implemented by this Input System.

Declaration
public IMixedRealityRaycastProvider RaycastProvider { get; }
Property Value
Type Description
IMixedRealityRaycastProvider

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.

ClearFallbackInputStack()

Clear all fallback input handlers off the stack.

Declaration
public void ClearFallbackInputStack()

ClearInputDisableStack()

Clear the input disable stack, which will immediately re-enable input.

Declaration
public void ClearInputDisableStack()

ClearModalInputStack()

Clear all modal input handlers off the stack.

Declaration
public void ClearModalInputStack()

Destroy()

Declaration
public override void Destroy()
Overrides

Disable()

Optional Disable function to pause the service.

Declaration
public override void Disable()
Overrides

Enable()

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

Declaration
public override void Enable()
Overrides

GenerateNewSourceId()

Generates a new unique input source id.

Declaration
public uint GenerateNewSourceId()
Returns
Type Description
UInt32

a new unique Id for the input source.
Remarks

All Input Sources are required to call this method in their constructor or initialization.

GetDataProvider<T>(String)

Get the data provider that is registered under the specified name (optional) and matching the specified type.

Declaration
public override T GetDataProvider<T>(string name = null)
    where T : IMixedRealityDataProvider
Parameters
Type Name Description
String name

The friendly name of the data provider.
Returns
Type Description
T

The requested data provider, or null if one cannot be found.
Type Parameters
Name Description
T

The desired data provider type.
Overrides
Remarks

If more than one data provider is registered under the specified name, the first will be returned.

GetDataProviders<T>()

Get the collection of registered observers of the specified type.

Declaration
public override IReadOnlyList<T> GetDataProviders<T>()
    where T : IMixedRealityDataProvider
Returns
Type Description
IReadOnlyList<T>

Read-only copy of the list of registered data providers that implement the specified type.
Type Parameters
Name Description
T

The desired data provider type
Overrides

HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)

The main function for handling and forwarding all events to their intended recipients.

Declaration
public override void HandleEvent<T>(BaseEventData eventData, ExecuteEvents.EventFunction<T> eventHandler)
    where T : IEventSystemHandler
Parameters
Type Name Description
BaseEventData eventData

Event Data
ExecuteEvents.EventFunction<T> eventHandler

Event Handler delegate
Type Parameters
Name Description
T

Event Handler Interface Type
Overrides
Microsoft.MixedReality.Toolkit.BaseEventSystem.HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)
Remarks

See: https://docs.unity3d.com/Manual/MessagingSystem.html

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.

Declaration
public override void Initialize()
Overrides

PopFallbackInputHandler()

Remove the last game object from the fallback input stack.

Declaration
public void PopFallbackInputHandler()

PopInputDisable()

Pop disabled input state. When the last disabled state is popped off the stack input will be re-enabled.

Declaration
public void PopInputDisable()

PopModalInputHandler()

Remove the last game object from the modal input stack.

Declaration
public void PopModalInputHandler()

PushFallbackInputHandler(GameObject)

Push a game object into the fallback input stack. Any input handlers on the game object are given input events when no modal or focused objects consume the event.

Declaration
public void PushFallbackInputHandler(GameObject inputHandler)
Parameters
Type Name Description
GameObject inputHandler

The input handler to push

PushInputDisable()

Push a disabled input state onto the input manager. While input is disabled no events will be sent out and the cursor displays a waiting animation.

Declaration
public void PushInputDisable()

PushModalInputHandler(GameObject)

Push a game object into the modal input stack. Any input handlers on the game object are given priority to input events before any focused objects.

Declaration
public void PushModalInputHandler(GameObject inputHandler)
Parameters
Type Name Description
GameObject inputHandler

The input handler to push

RaiseDictationComplete(IMixedRealityInputSource, String, AudioClip)

Declaration
public void RaiseDictationComplete(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip)
Parameters
Type Name Description
IMixedRealityInputSource source
String dictationResult
AudioClip dictationAudioClip

RaiseDictationError(IMixedRealityInputSource, String, AudioClip)

Declaration
public void RaiseDictationError(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip = null)
Parameters
Type Name Description
IMixedRealityInputSource source
String dictationResult
AudioClip dictationAudioClip

RaiseDictationHypothesis(IMixedRealityInputSource, String, AudioClip)

Declaration
public void RaiseDictationHypothesis(IMixedRealityInputSource source, string dictationHypothesis, AudioClip dictationAudioClip = null)
Parameters
Type Name Description
IMixedRealityInputSource source
String dictationHypothesis
AudioClip dictationAudioClip

RaiseDictationResult(IMixedRealityInputSource, String, AudioClip)

Declaration
public void RaiseDictationResult(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip = null)
Parameters
Type Name Description
IMixedRealityInputSource source
String dictationResult
AudioClip dictationAudioClip

RaiseFloatInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Single)

Raise Float Input Changed.

Declaration
public void RaiseFloatInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, float inputValue)
Parameters
Type Name Description
IMixedRealityInputSource source
Handedness handedness
MixedRealityInputAction inputAction
Single inputValue

RaiseFocusChanged(IMixedRealityPointer, GameObject, GameObject)

Raise the focus changed event.

Declaration
public void RaiseFocusChanged(IMixedRealityPointer pointer, GameObject oldFocusedObject, GameObject newFocusedObject)
Parameters
Type Name Description
IMixedRealityPointer pointer

The pointer that the focus change event is raised on.
GameObject oldFocusedObject

The old focused object.
GameObject newFocusedObject

The new focused object.

RaiseFocusEnter(IMixedRealityPointer, GameObject)

Raise the focus enter event.

Declaration
public void RaiseFocusEnter(IMixedRealityPointer pointer, GameObject focusedObject)
Parameters
Type Name Description
IMixedRealityPointer pointer

The pointer that has focus.
GameObject focusedObject

The GameObject that the pointer has entered focus on.

RaiseFocusExit(IMixedRealityPointer, GameObject)

Raise the focus exit event.

Declaration
public void RaiseFocusExit(IMixedRealityPointer pointer, GameObject unfocusedObject)
Parameters
Type Name Description
IMixedRealityPointer pointer

The pointer that has lost focus.
GameObject unfocusedObject

The GameObject that the pointer has exited focus on.

RaiseGestureCanceled(IMixedRealityController, MixedRealityInputAction)

Raise the Gesture Canceled Event.

Declaration
public void RaiseGestureCanceled(IMixedRealityController controller, MixedRealityInputAction action)
Parameters
Type Name Description
IMixedRealityController controller
MixedRealityInputAction action

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction)

Raise the Gesture Completed Event.

Declaration
public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action)
Parameters
Type Name Description
IMixedRealityController controller
MixedRealityInputAction action

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, MixedRealityPose)

Raise the Gesture Completed Event.

Declaration
public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, MixedRealityPose inputData)
Parameters
Type Name Description
IMixedRealityController controller
MixedRealityInputAction action
MixedRealityPose inputData

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Quaternion)

Raise the Gesture Completed Event.

Declaration
public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, Quaternion inputData)
Parameters
Type Name Description
IMixedRealityController controller
MixedRealityInputAction action
Quaternion inputData

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Vector2)

Raise the Gesture Completed Event.

Declaration
public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, Vector2 inputData)
Parameters
Type Name Description
IMixedRealityController controller
MixedRealityInputAction action
Vector2 inputData

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Vector3)

Raise the Gesture Completed Event.

Declaration
public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, Vector3 inputData)
Parameters
Type Name Description
IMixedRealityController controller
MixedRealityInputAction action
Vector3 inputData

RaiseGestureStarted(IMixedRealityController, MixedRealityInputAction)

Raise the Gesture Started Event.

Declaration
public void RaiseGestureStarted(IMixedRealityController controller, MixedRealityInputAction action)
Parameters
Type Name Description
IMixedRealityController controller
MixedRealityInputAction action

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction)

Raise the Gesture Updated Event.

Declaration
public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action)
Parameters
Type Name Description
IMixedRealityController controller
MixedRealityInputAction action

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, MixedRealityPose)

Raise the Gesture Updated Event.

Declaration
public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, MixedRealityPose inputData)
Parameters
Type Name Description
IMixedRealityController controller
MixedRealityInputAction action
MixedRealityPose inputData

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Quaternion)

Raise the Gesture Updated Event.

Declaration
public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, Quaternion inputData)
Parameters
Type Name Description
IMixedRealityController controller
MixedRealityInputAction action
Quaternion inputData

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Vector2)

Raise the Gesture Updated Event.

Declaration
public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, Vector2 inputData)
Parameters
Type Name Description
IMixedRealityController controller
MixedRealityInputAction action
Vector2 inputData

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Vector3)

Raise the Gesture Updated Event.

Declaration
public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, Vector3 inputData)
Parameters
Type Name Description
IMixedRealityController controller
MixedRealityInputAction action
Vector3 inputData

RaiseHandJointsUpdated(IMixedRealityInputSource, Handedness, IDictionary<TrackedHandJoint, MixedRealityPose>)

Declaration
public void RaiseHandJointsUpdated(IMixedRealityInputSource source, Handedness handedness, IDictionary<TrackedHandJoint, MixedRealityPose> jointPoses)
Parameters
Type Name Description
IMixedRealityInputSource source
Handedness handedness
IDictionary<TrackedHandJoint, MixedRealityPose> jointPoses

RaiseHandMeshUpdated(IMixedRealityInputSource, Handedness, HandMeshInfo)

Declaration
public void RaiseHandMeshUpdated(IMixedRealityInputSource source, Handedness handedness, HandMeshInfo handMeshInfo)
Parameters
Type Name Description
IMixedRealityInputSource source
Handedness handedness
HandMeshInfo handMeshInfo

RaiseOnInputDown(IMixedRealityInputSource, Handedness, MixedRealityInputAction)

Raise the input down event.

Declaration
public void RaiseOnInputDown(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction)
Parameters
Type Name Description
IMixedRealityInputSource source
Handedness handedness
MixedRealityInputAction inputAction

RaiseOnInputUp(IMixedRealityInputSource, Handedness, MixedRealityInputAction)

Raise the input up event.

Declaration
public void RaiseOnInputUp(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction)
Parameters
Type Name Description
IMixedRealityInputSource source
Handedness handedness
MixedRealityInputAction inputAction

RaiseOnTouchCompleted(IMixedRealityInputSource, IMixedRealityController, Handedness, Vector3)

Declaration
public void RaiseOnTouchCompleted(IMixedRealityInputSource source, IMixedRealityController controller, Handedness handedness, Vector3 touchPoint)
Parameters
Type Name Description
IMixedRealityInputSource source
IMixedRealityController controller
Handedness handedness
Vector3 touchPoint

RaiseOnTouchStarted(IMixedRealityInputSource, IMixedRealityController, Handedness, Vector3)

Declaration
public void RaiseOnTouchStarted(IMixedRealityInputSource source, IMixedRealityController controller, Handedness handedness, Vector3 touchPoint)
Parameters
Type Name Description
IMixedRealityInputSource source
IMixedRealityController controller
Handedness handedness
Vector3 touchPoint

RaiseOnTouchUpdated(IMixedRealityInputSource, IMixedRealityController, Handedness, Vector3)

Declaration
public void RaiseOnTouchUpdated(IMixedRealityInputSource source, IMixedRealityController controller, Handedness handedness, Vector3 touchPoint)
Parameters
Type Name Description
IMixedRealityInputSource source
IMixedRealityController controller
Handedness handedness
Vector3 touchPoint

RaisePointerClicked(IMixedRealityPointer, MixedRealityInputAction, Int32, Handedness, IMixedRealityInputSource)

Declaration
public void RaisePointerClicked(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, int count, Handedness handedness = null, IMixedRealityInputSource inputSource = null)
Parameters
Type Name Description
IMixedRealityPointer pointer
MixedRealityInputAction inputAction
Int32 count
Handedness handedness
IMixedRealityInputSource inputSource

RaisePointerDown(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource)

Raise the pointer down event.

Declaration
public void RaisePointerDown(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, Handedness handedness = null, IMixedRealityInputSource inputSource = null)
Parameters
Type Name Description
IMixedRealityPointer pointer

The pointer where the event originates.
MixedRealityInputAction inputAction
Handedness handedness
IMixedRealityInputSource inputSource

RaisePointerDragged(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource)

Raise the pointer dragged event.

Declaration
public void RaisePointerDragged(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, Handedness handedness = null, IMixedRealityInputSource inputSource = null)
Parameters
Type Name Description
IMixedRealityPointer pointer

The pointer where the event originates.
MixedRealityInputAction inputAction
Handedness handedness
IMixedRealityInputSource inputSource

RaisePointerUp(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource)

Raise the pointer up event.

Declaration
public void RaisePointerUp(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, Handedness handedness = null, IMixedRealityInputSource inputSource = null)
Parameters
Type Name Description
IMixedRealityPointer pointer
MixedRealityInputAction inputAction
Handedness handedness
IMixedRealityInputSource inputSource

RaisePoseInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, MixedRealityPose)

Raise the 6 degrees of freedom input event.

Declaration
public void RaisePoseInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, MixedRealityPose inputData)
Parameters
Type Name Description
IMixedRealityInputSource source
Handedness handedness
MixedRealityInputAction inputAction
MixedRealityPose inputData

RaisePositionInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Vector2)

Raise the 2 degrees of freedom input event.

Declaration
public void RaisePositionInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, Vector2 inputPosition)
Parameters
Type Name Description
IMixedRealityInputSource source
Handedness handedness
MixedRealityInputAction inputAction
Vector2 inputPosition

RaisePositionInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Vector3)

Raise the 3 degrees of freedom input event.

Declaration
public void RaisePositionInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, Vector3 position)
Parameters
Type Name Description
IMixedRealityInputSource source
Handedness handedness
MixedRealityInputAction inputAction
Vector3 position

RaisePreFocusChanged(IMixedRealityPointer, GameObject, GameObject)

Raise the pre-focus changed event.

Declaration
public void RaisePreFocusChanged(IMixedRealityPointer pointer, GameObject oldFocusedObject, GameObject newFocusedObject)
Parameters
Type Name Description
IMixedRealityPointer pointer

The pointer that the focus change event is raised on.
GameObject oldFocusedObject

The old focused object.
GameObject newFocusedObject

The new focused object.
Remarks

This event is useful for doing logic before the focus changed event.

RaiseRotationInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Quaternion)

Raise the 3 degrees of freedom input event.

Declaration
public void RaiseRotationInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, Quaternion rotation)
Parameters
Type Name Description
IMixedRealityInputSource source
Handedness handedness
MixedRealityInputAction inputAction
Quaternion rotation

RaiseSourceDetected(IMixedRealityInputSource, IMixedRealityController)

Raise the event that the Input Source was detected.

Declaration
public void RaiseSourceDetected(IMixedRealityInputSource source, IMixedRealityController controller = null)
Parameters
Type Name Description
IMixedRealityInputSource source

The detected Input Source.
IMixedRealityController controller

RaiseSourceLost(IMixedRealityInputSource, IMixedRealityController)

Raise the event that the Input Source was lost.

Declaration
public void RaiseSourceLost(IMixedRealityInputSource source, IMixedRealityController controller = null)
Parameters
Type Name Description
IMixedRealityInputSource source

The lost Input Source.
IMixedRealityController controller

RaiseSourcePoseChanged(IMixedRealityInputSource, IMixedRealityController, MixedRealityPose)

Raise the event that the Input Source position was changed.

Declaration
public void RaiseSourcePoseChanged(IMixedRealityInputSource source, IMixedRealityController controller, MixedRealityPose position)
Parameters
Type Name Description
IMixedRealityInputSource source
IMixedRealityController controller
MixedRealityPose position

RaiseSourcePositionChanged(IMixedRealityInputSource, IMixedRealityController, Vector2)

Raise the event that the Input Source position was changed.

Declaration
public void RaiseSourcePositionChanged(IMixedRealityInputSource source, IMixedRealityController controller, Vector2 position)
Parameters
Type Name Description
IMixedRealityInputSource source
IMixedRealityController controller
Vector2 position

RaiseSourcePositionChanged(IMixedRealityInputSource, IMixedRealityController, Vector3)

Raise the event that the Input Source position was changed.

Declaration
public void RaiseSourcePositionChanged(IMixedRealityInputSource source, IMixedRealityController controller, Vector3 position)
Parameters
Type Name Description
IMixedRealityInputSource source
IMixedRealityController controller
Vector3 position

RaiseSourceRotationChanged(IMixedRealityInputSource, IMixedRealityController, Quaternion)

Raise the event that the Input Source position was changed.

Declaration
public void RaiseSourceRotationChanged(IMixedRealityInputSource source, IMixedRealityController controller, Quaternion rotation)
Parameters
Type Name Description
IMixedRealityInputSource source
IMixedRealityController controller
Quaternion rotation

RaiseSourceTrackingStateChanged(IMixedRealityInputSource, IMixedRealityController, TrackingState)

Raise the event that the Input Source's tracking state has changed.

Declaration
public void RaiseSourceTrackingStateChanged(IMixedRealityInputSource source, IMixedRealityController controller, TrackingState state)
Parameters
Type Name Description
IMixedRealityInputSource source
IMixedRealityController controller
TrackingState state

RaiseSpeechCommandRecognized(IMixedRealityInputSource, RecognitionConfidenceLevel, TimeSpan, DateTime, SpeechCommands)

Declaration
public void RaiseSpeechCommandRecognized(IMixedRealityInputSource source, RecognitionConfidenceLevel confidence, TimeSpan phraseDuration, DateTime phraseStartTime, SpeechCommands command)
Parameters
Type Name Description
IMixedRealityInputSource source
RecognitionConfidenceLevel confidence
TimeSpan phraseDuration
DateTime phraseStartTime
SpeechCommands command

Register(GameObject)

Register a GameObject to listen to events that will receive all input events, regardless of which other GameObjects might have handled the event beforehand.

Declaration
public override void Register(GameObject listener)
Parameters
Type Name Description
GameObject listener

Listener to add.
Overrides
Remarks

Useful for listening to events when the GameObject is currently not being raycasted against by the FocusProvider.

RequestNewGenericInputSource(String, IMixedRealityPointer[], InputSourceType)

Declaration
public IMixedRealityInputSource RequestNewGenericInputSource(string name, IMixedRealityPointer[] pointers = null, InputSourceType sourceType = InputSourceType.Other)
Parameters
Type Name Description
String name
IMixedRealityPointer[] pointers
InputSourceType sourceType
Returns
Type Description
IMixedRealityInputSource

Reset()

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

Declaration
public override void Reset()
Overrides

Unregister(GameObject)

Unregister a GameObject from listening to input events.

Declaration
public override void Unregister(GameObject listener)
Parameters
Type Name Description
GameObject listener
Overrides

Events

InputDisabled

Declaration
public event BaseEventSystem.Action InputDisabled
Event Type
Type Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action

InputEnabled

Declaration
public event BaseEventSystem.Action InputEnabled
Event Type
Type Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action

Implements

IDisposable