C++ Java Unity
Unity Reference
SessionRecorderBehaviour Class Reference

The session recorder allows the user to record Vuforia sessions for playback in the editor and on a device More...

Inheritance diagram for SessionRecorderBehaviour:
VuforiaMonoBehaviour

Classes

class  CleanStorageEvent
 
class  StartRecordingEvent
 
class  StopRecordingEvent
 

Public Member Functions

void CleanStorage ()
 Deletes ALL the existing recordings on the device. The method invokes the OnStorageCleaned event with a value of true after the storage has been successfully cleaned. It is not allowed to clean the storage while a recording is in progress. In that case, or if an error occurs, the OnStorageCleaned event will be invoked with a value of false. Called from the Session Recorder UI. More...
 
string GetRecordingPath ()
 Returns the path to the last successful recording. If called while recording, it returns the path to the current recording. It is recommended to preserve a copy of this path if a list of all recordings is needed. The session recorder does not keep this information. More...
 
RecordingStatus GetRecordingStatus ()
 Returns the current Recording Status. More...
 
RecordingSource GetSupportedSources ()
 Returns the sources supported by the device whose data can be recorded. The value is a bit-wise combination of the appropriate RecordingSource flags. More...
 
void StartRecording ()
 Starts the recording of a Vuforia session. It uses the value assigned to the field CaptureSensorsData to configure the Session Recorder. Invokes the OnRecordingStarted event after the recording is started. Called from the Record button in the Session Recorder UI. More...
 
void StopRecording ()
 Stops recording. The method updates the Recording Status and invokes the OnRecordingStopped event accordingly. Called from the Stop button in the Session Recorder UI. More...
 

Public Attributes

StartRecordingEvent OnRecordingStarted
 
StopRecordingEvent OnRecordingStopped
 
CleanStorageEvent OnStorageCleaned
 

Detailed Description

The session recorder allows the user to record Vuforia sessions for playback in the editor and on a device

Member Function Documentation

void CleanStorage ( )

Deletes ALL the existing recordings on the device. The method invokes the OnStorageCleaned event with a value of true after the storage has been successfully cleaned. It is not allowed to clean the storage while a recording is in progress. In that case, or if an error occurs, the OnStorageCleaned event will be invoked with a value of false. Called from the Session Recorder UI.

string GetRecordingPath ( )

Returns the path to the last successful recording. If called while recording, it returns the path to the current recording. It is recommended to preserve a copy of this path if a list of all recordings is needed. The session recorder does not keep this information.

Returns
RecordingStatus GetRecordingStatus ( )

Returns the current Recording Status.

Returns
RecordingSource GetSupportedSources ( )

Returns the sources supported by the device whose data can be recorded. The value is a bit-wise combination of the appropriate RecordingSource flags.

Returns
void StartRecording ( )

Starts the recording of a Vuforia session. It uses the value assigned to the field CaptureSensorsData to configure the Session Recorder. Invokes the OnRecordingStarted event after the recording is started. Called from the Record button in the Session Recorder UI.

void StopRecording ( )

Stops recording. The method updates the Recording Status and invokes the OnRecordingStopped event accordingly. Called from the Stop button in the Session Recorder UI.

Member Data Documentation

StartRecordingEvent OnRecordingStarted
StopRecordingEvent OnRecordingStopped
CleanStorageEvent OnStorageCleaned