C++ Java Unity
Unity Reference
SessionRecorder 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 SessionRecorder:
ISessionRecorder

Public Member Functions

bool Clean ()
 Deletes ALL the existing recordings on the device. 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 status of the session recorder. 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...
 
RecordingStatus Start (bool captureSensors=true)
 Starts recording a Vuforia session. If the captureSensor parameter is set to false, the session recorder will only save the camera feed. More...
 
void Stop ()
 Stops the current recording. More...
 

Properties

static ISessionRecorder Instance [get, set]
 The current instance of the session recorder. If no session recorder is available, a new one is created. More...
 

Detailed Description

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

Member Function Documentation

bool Clean ( )

Deletes ALL the existing recordings on the device.

Returns
true if all the recordings were successfully deleted. false otherwise.

Implements ISessionRecorder.

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

Implements ISessionRecorder.

RecordingStatus GetRecordingStatus ( )

Returns the current status of the session recorder.

Returns

Implements ISessionRecorder.

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

Implements ISessionRecorder.

RecordingStatus Start ( bool  captureSensors = true)

Starts recording a Vuforia session. If the captureSensor parameter is set to false, the session recorder will only save the camera feed.

Parameters
captureSensorsDetermine if the session recorder should also record sensor data. Defaults to true.
Returns

Implements ISessionRecorder.

void Stop ( )

Stops the current recording.

Implements ISessionRecorder.

Property Documentation

ISessionRecorder Instance
staticgetset

The current instance of the session recorder. If no session recorder is available, a new one is created.