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:

Public Member Functions
bool	Clean ()
	Deletes ALL the existing recordings on the device.
RecordingSource	GetDefaultSources ()
	Returns the sources that are appropriate for the current device to create AR session recordings The value is a bit-wise combination of the appropriate RecordingSource flags.
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.
RecordingStatus	GetRecordingStatus ()
	Returns the current status of the session recorder.
RecordingStatusInfo	GetRecordingStatusInfo ()
	Returns additional status info of the session recorder.
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.
bool	ShareRecording ()
	Uses the platform's native share functionality to share the latest recorded Vuforia Session.
RecordingStartError	StartRecording (bool captureSensors=true, bool captureAudio=false, RecordingVideoEncodingQuality encodingQuality=RecordingVideoEncodingQuality.HIGH)
	Starts recording a Vuforia session. If the captureSensor parameter is set to false, the session recorder will only save the camera feed.
void	StopRecording ()
	Stops the current recording.

Detailed Description

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

Member Function Documentation

Clean()

bool Clean ( )

inline

Deletes ALL the existing recordings on the device.

Returns

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

GetDefaultSources()

RecordingSource GetDefaultSources ( )

inline

Returns the sources that are appropriate for the current device to create AR session recordings The value is a bit-wise combination of the appropriate RecordingSource flags.

GetRecordingPath()

string GetRecordingPath ( )

inline

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.

GetRecordingStatus()

RecordingStatus GetRecordingStatus ( )

inline

Returns the current status of the session recorder.

GetRecordingStatusInfo()

RecordingStatusInfo GetRecordingStatusInfo ( )

inline

Returns additional status info of the session recorder.

GetSupportedSources()

RecordingSource GetSupportedSources ( )

inline

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

ShareRecording()

bool ShareRecording ( )

inline

Uses the platform's native share functionality to share the latest recorded Vuforia Session.

Returns

true if the native share popup was shown. false otherwise.

StartRecording()

RecordingStartError StartRecording ( bool captureSensors = true, bool captureAudio = false, RecordingVideoEncodingQuality encodingQuality = RecordingVideoEncodingQuality::HIGH )

inline

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

Parameters

captureSensors	Determine if the session recorder should also record sensor data. Defaults to true.
captureAudio	Determine if the session recorder should also record audio. Defaults to false.
encodingQuality	Quality settings used for encoding the recorded video. Defaults to High.

StopRecording()

void StopRecording ( )

inline

Stops the current recording.