Edit

Share via


IMixedRealityInputPlaybackService Interface

Definition

Plays back input animation via the input simulation system.

public interface class IMixedRealityInputPlaybackService : IDisposable, Microsoft::MixedReality::Toolkit::Input::IMixedRealityInputDeviceManager
public interface IMixedRealityInputPlaybackService : IDisposable, Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputDeviceManager
type IMixedRealityInputPlaybackService = interface
    interface IMixedRealityInputDeviceManager
    interface IMixedRealityDataProvider
    interface IMixedRealityService
    interface IDisposable
Public Interface IMixedRealityInputPlaybackService
Implements IDisposable, IMixedRealityInputDeviceManager
Derived
Implements

Properties

Animation

The animation currently being played.

ConfigurationProfile

The configuration profile for the service.

(Inherited from IMixedRealityService)
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 IMixedRealityService)
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 IMixedRealityService)

Methods

Destroy()

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

(Inherited from IMixedRealityService)
Disable()

Optional Disable function to pause the service.

(Inherited from IMixedRealityService)
Enable()

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

(Inherited from IMixedRealityService)
GetActiveControllers()

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

(Inherited from IMixedRealityInputDeviceManager)
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 IMixedRealityService)
LateUpdate()

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

(Inherited from IMixedRealityService)
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.

Reset()

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

(Inherited from IMixedRealityService)
Stop()

Stop playing the animation and jump to the start.

Update()

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

(Inherited from IMixedRealityService)

Applies to