InputRecordingService Class

Definition

Namespace:

Microsoft.MixedReality.Toolkit.Input

Assembly:

Microsoft.MixedReality.Toolkit.Services.InputAnimation.dll

Provides input recording into an internal buffer and exporting to files.

public ref class InputRecordingService : Microsoft::MixedReality::Toolkit::Input::BaseInputDeviceManager, IDisposable, Microsoft::MixedReality::Toolkit::Input::IMixedRealityInputRecordingService

[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 Recording Service", "Profiles/DefaultMixedRealityInputRecordingProfile.asset", "MixedRealityToolkit.SDK", true, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)]
public class InputRecordingService : Microsoft.MixedReality.Toolkit.Input.BaseInputDeviceManager, IDisposable, Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputRecordingService

[<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 Recording Service", "Profiles/DefaultMixedRealityInputRecordingProfile.asset", "MixedRealityToolkit.SDK", true, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)>]
type InputRecordingService = class
    inherit BaseInputDeviceManager
    interface IMixedRealityInputRecordingService
    interface IMixedRealityInputDeviceManager
    interface IMixedRealityDataProvider
    interface IMixedRealityService
    interface IDisposable

Public Class InputRecordingService
Inherits BaseInputDeviceManager
Implements IDisposable, IMixedRealityInputRecordingService

Inheritance

Object

BaseService

BaseDataProvider<IMixedRealityInputSystem>

BaseInputDeviceManager

InputRecordingService

Attributes

MixedRealityDataProviderAttribute

Implements

IMixedRealityDataProvider IMixedRealityService IMixedRealityInputDeviceManager IMixedRealityInputRecordingService IDisposable

Constructors

InputRecordingService(IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)	Constructor.
InputRecordingService(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

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)
EndTime	End time of recording.
InputRecordingProfile	The profile used for recording.
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)
IsRecording	True if input is being recorded.
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)
RecordingBufferTimeLimit	Maximum duration in seconds of the input recording if UseBufferTimeLimit is enabled.
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>)
StartTime	Start time of recording.
UseBufferTimeLimit	Limit the size of the recording buffer.

Methods

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.
DiscardRecordedInput()	Discard all recorded input
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.
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. (Inherited from BaseInputDeviceManager)
LateUpdate()	Optional LateUpdate function to that is called after Update has been called on all services.
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)
SaveInputAnimation(String)	Save recorded input animation to a file.
SaveInputAnimation(String, String)	Save recorded input animation to a file.
SaveInputAnimationAsync(String)	Save recorded input animation to a file asynchronously.
SaveInputAnimationAsync(String, String)	Save recorded input animation to a file asynchronously.
StartRecording()	Start unlimited input recording.
StopRecording()	Stop recording input.
Update()	Optional Update function to perform per-frame updates of the service. (Inherited from BaseService)

Events

OnRecordingStarted	Invoked when recording begins
OnRecordingStopped	Invoked when recording ends