InputPlaybackService Class

Definition

Plays back input animation via the input simulation system.

public ref class InputPlaybackService : Microsoft::MixedReality::Toolkit::Input::BaseInputSimulationService, IDisposable, Microsoft::MixedReality::Toolkit::Input::IMixedRealityInputPlaybackService
public ref class InputPlaybackService : Microsoft::MixedReality::Toolkit::Input::BaseInputSimulationService, IDisposable, Microsoft::MixedReality::Toolkit::Input::IMixedRealityEyeGazeDataProvider, Microsoft::MixedReality::Toolkit::Input::IMixedRealityInputPlaybackService
[Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Lumin | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Web | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Input Playback Service", "", "MixedRealityToolkit", false)]
public class InputPlaybackService : Microsoft.MixedReality.Toolkit.Input.BaseInputSimulationService, IDisposable, Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputPlaybackService
[Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Lumin | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Web | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Input Playback Service", "", "MixedRealityToolkit", false)]
public class InputPlaybackService : Microsoft.MixedReality.Toolkit.Input.BaseInputSimulationService, IDisposable, Microsoft.MixedReality.Toolkit.Input.IMixedRealityEyeGazeDataProvider, Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputPlaybackService
[Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Lumin | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Web | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Input Playback Service", "", "MixedRealityToolkit", false, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)]
public class InputPlaybackService : Microsoft.MixedReality.Toolkit.Input.BaseInputSimulationService, IDisposable, Microsoft.MixedReality.Toolkit.Input.IMixedRealityEyeGazeDataProvider, Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputPlaybackService
[<Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Lumin | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Web | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Input Playback Service", "", "MixedRealityToolkit", false)>]
type InputPlaybackService = class
    inherit BaseInputSimulationService
    interface IMixedRealityInputPlaybackService
    interface IMixedRealityInputDeviceManager
    interface IMixedRealityDataProvider
    interface IMixedRealityService
    interface IDisposable
[<Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Lumin | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Web | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Input Playback Service", "", "MixedRealityToolkit", false)>]
type InputPlaybackService = class
    inherit BaseInputSimulationService
    interface IMixedRealityInputPlaybackService
    interface IMixedRealityInputDeviceManager
    interface IMixedRealityDataProvider
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityEyeGazeDataProvider
[<Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Lumin | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Web | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Input Playback Service", "", "MixedRealityToolkit", false, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)>]
type InputPlaybackService = class
    inherit BaseInputSimulationService
    interface IMixedRealityInputPlaybackService
    interface IMixedRealityInputDeviceManager
    interface IMixedRealityDataProvider
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityEyeGazeDataProvider
Public Class InputPlaybackService
Inherits BaseInputSimulationService
Implements IDisposable, IMixedRealityInputPlaybackService
Public Class InputPlaybackService
Inherits BaseInputSimulationService
Implements IDisposable, IMixedRealityEyeGazeDataProvider, IMixedRealityInputPlaybackService
Inheritance
Attributes
Implements

Constructors

InputPlaybackService(IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)

Constructor.

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

Constructor.

Fields

DefaultPriority (Inherited from BaseService)
disposed

Value indicating if the object has completed disposal.

(Inherited from BaseService)

Properties

Animation

The animation currently being played.

ConfigurationProfile

The configuration profile for the service.

(Inherited from BaseService)
Duration

Duration of the played animation.

EnablePointerCache

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

(Inherited from BaseInputDeviceManager)
HandDataLeft

Pose data for the left hand.

HandDataRight

Pose data for the right hand.

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)
IsPlaying

True if the animation is currently playing.

LocalTime

The local time in seconds relative to the start of the animation.

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)
Registrar
Obsolete.

The service registrar instance that registered this service.

(Inherited from BaseDataProvider<T>)
SaccadeProvider
Service

The service instance to which this provider is providing data.

(Inherited from BaseDataProvider<T>)
SmoothEyeTracking

Methods

CheckCapability(MixedRealityCapability) System.Object.CheckCapability(Microsoft.MixedReality.Toolkit.MixedRealityCapability)
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.

(Inherited from BaseService)
Dispose()

Cleanup resources used by this object.

(Inherited from BaseService)
Dispose(Boolean)

Cleanup resources used by the object

(Inherited from BaseService)
Enable()

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

(Inherited from BaseService)
GetActiveControllers()

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

(Inherited from BaseInputSimulationService)
GetControllerDevice(Handedness) (Inherited from BaseInputSimulationService)
GetHandDevice(Handedness)
Obsolete.
(Inherited from BaseInputSimulationService)
GetOrAddControllerDevice(Handedness, ControllerSimulationMode) (Inherited from BaseInputSimulationService)
GetOrAddHandDevice(Handedness, ControllerSimulationMode)
Obsolete.
(Inherited from BaseInputSimulationService)
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.

(Inherited from BaseInputDeviceManager)
LateUpdate()

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

(Inherited from BaseService)
LoadInputAnimation(String)

Try to load input animation data from the given file.

LoadInputAnimationAsync(String)

Try to load input animation data from the given file asynchronously.

Pause()

Pause playback and keep the current local time.

Play()

Start playing the animation.

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)
RemoveAllControllerDevices() (Inherited from BaseInputSimulationService)
RemoveAllHandDevices()
Obsolete.
(Inherited from BaseInputSimulationService)
RemoveControllerDevice(Handedness) (Inherited from BaseInputSimulationService)
RemoveHandDevice(Handedness)
Obsolete.
(Inherited from BaseInputSimulationService)
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)
Stop()

Stop playing the animation and jump to the start.

Update()

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

UpdateControllerDevice(ControllerSimulationMode, Handedness, Object) (Inherited from BaseInputSimulationService)
UpdateHandDevice(ControllerSimulationMode, Handedness, SimulatedHandData)
Obsolete.
(Inherited from BaseInputSimulationService)

Events

OnPlaybackPaused

Invoked when playback is paused

OnPlaybackStarted

Invoked when playback begins or resumes

OnPlaybackStopped

Invoked when playback stops

Applies to