C API Unity API
Unity API Reference (Version 10.22.5)
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  RecordingStartedEvent
 
class  RecordingStoppedEvent
 
class  ShareRecordingEvent
 

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...
 
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. 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 ShareRecording ()
 Uses the platform's native share functionality to share the latest recorded Vuforia Session. This method must be called AFTER a recording was successfully saved on disk. In that vase, the OnShareRequested event will be invoked with a value of true. If this method is called before any session has been recorder or if the native share window is not shown, the OnShareRequested event will be invoked with a value of false. 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. Called from the Stop button in the Session Recorder UI. More...
 

Public Attributes

ShareRecordingEvent OnShareRequested = new ShareRecordingEvent()
 
RecordingStartedEvent OnStartRecording = new RecordingStartedEvent()
 
RecordingStoppedEvent OnStopRecording = new RecordingStoppedEvent()
 
CleanStorageEvent OnStorageCleaned = new CleanStorageEvent()
 

Detailed Description

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

Member Function Documentation

◆ CleanStorage()

void CleanStorage ( )
inline

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.

◆ 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 Recording Status.

◆ 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()

void ShareRecording ( )
inline

Uses the platform's native share functionality to share the latest recorded Vuforia Session. This method must be called AFTER a recording was successfully saved on disk. In that vase, the OnShareRequested event will be invoked with a value of true. If this method is called before any session has been recorder or if the native share window is not shown, the OnShareRequested event will be invoked with a value of false.

◆ StartRecording()

void StartRecording ( )
inline

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.

◆ StopRecording()

void StopRecording ( )
inline

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

Member Data Documentation

◆ OnShareRequested

ShareRecordingEvent OnShareRequested = new ShareRecordingEvent()

◆ OnStartRecording

RecordingStartedEvent OnStartRecording = new RecordingStartedEvent()

◆ OnStopRecording

◆ OnStorageCleaned

CleanStorageEvent OnStorageCleaned = new CleanStorageEvent()