Interface IMixedRealityInputRecordingService
Provides input recording into an internal buffer and exporting to files.
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public interface IMixedRealityInputRecordingService : IMixedRealityInputDeviceManager, IMixedRealityDataProvider, IMixedRealityService, IDisposable
Properties
IsRecording
True if input is being recorded.
Declaration
bool IsRecording { get; }
Property Value
Type | Description |
---|---|
Boolean |
RecordingBufferTimeLimit
Maximum duration in seconds of the input recording if UseBufferTimeLimit is enabled.
Declaration
float RecordingBufferTimeLimit { get; set; }
Property Value
Type | Description |
---|---|
Single |
Remarks
If UseBufferTimeLimit is enabled then keyframes older than this limit will be discarded.
UseBufferTimeLimit
Limit the size of the recording buffer.
Declaration
bool UseBufferTimeLimit { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Remarks
If recording is limited any input older than the RecordingBufferTimeLimit will be discarded.
Methods
DiscardRecordedInput()
Discard all recorded input
Declaration
void DiscardRecordedInput()
SaveInputAnimation(String)
Save recorded input animation to a file.
Declaration
string SaveInputAnimation(string directory = null)
Parameters
Type | Name | Description |
---|---|---|
String | directory | Directory in which to create the file. If null the persistent data path of the app is used. |
Returns
Type | Description |
---|---|
String | File path where input has been recorded. |
Remarks
Filename is determined automatically.
SaveInputAnimation(String, String)
Save recorded input animation to a file.
Declaration
string SaveInputAnimation(string filename, string directory)
Parameters
Type | Name | Description |
---|---|---|
String | filename | Name of the file to create. |
String | directory | Directory in which to create the file. If null the persistent data path of the app is used. |
Returns
Type | Description |
---|---|
String | File path where input has been recorded. |
SaveInputAnimationAsync(String)
Save recorded input animation to a file asynchronously.
Declaration
Task<string> SaveInputAnimationAsync(string directory = null)
Parameters
Type | Name | Description |
---|---|---|
String | directory | Directory in which to create the file. If null the persistent data path of the app is used. |
Returns
Type | Description |
---|---|
Task<String> | File path where input has been recorded. |
Remarks
Filename is determined automatically.
SaveInputAnimationAsync(String, String)
Save recorded input animation to a file asynchronously.
Declaration
Task<string> SaveInputAnimationAsync(string filename, string directory)
Parameters
Type | Name | Description |
---|---|---|
String | filename | Name of the file to create. |
String | directory | Directory in which to create the file. If null the persistent data path of the app is used. |
Returns
Type | Description |
---|---|
Task<String> | File path where input has been recorded. |
StartRecording()
Start unlimited input recording.
Declaration
void StartRecording()
StopRecording()
Stop recording input.
Declaration
void StopRecording()