Wikitude Unity Plugin
Public Member Functions | Public Attributes | Properties | List of all members
Wikitude.TrackingMapRecorder Class Reference

Provides tracking map recording functionality. More...

Inherits MonoBehaviour.

Public Member Functions

bool StartRecording ()
 Starts a new 3D tracking map recording session. More...
 
bool StopRecording ()
 Stops an already running 3D tracking map recording session. More...
 

Public Attributes

OnRecordingFinishedEvent OnRecordingFinished = new OnRecordingFinishedEvent()
 Called when recording has successfully finished. More...
 
OnRecordingErrorEvent OnRecordingError = new OnRecordingErrorEvent()
 Called when recording finished with an error. More...
 
OnRecordingQualityChangedEvent OnRecordingQualityChanged = new OnRecordingQualityChangedEvent()
 

Properties

string TrackingMapName [get, set]
 Name with which the tracking map will be saved when recording is complete. More...
 
bool IsRecording [get]
 Use this to check if a 3D tracking map recording session is currently running or not. More...
 

Detailed Description

Provides tracking map recording functionality.

Member Function Documentation

bool Wikitude.TrackingMapRecorder.StartRecording ( )
inline

Starts a new 3D tracking map recording session.

This method returns immediately and starts the recording session in the background.

Returns
true, if recording was started, false if an error was encountered.
bool Wikitude.TrackingMapRecorder.StopRecording ( )
inline

Stops an already running 3D tracking map recording session.

Returns
true, if recording was stoped, false if an error was encountered.

Member Data Documentation

OnRecordingErrorEvent Wikitude.TrackingMapRecorder.OnRecordingError = new OnRecordingErrorEvent()

Called when recording finished with an error.

Parameters
errorDescription of error.
OnRecordingFinishedEvent Wikitude.TrackingMapRecorder.OnRecordingFinished = new OnRecordingFinishedEvent()

Called when recording has successfully finished.

Parameters
urlAbsolute path to the saved .wtm file.
OnRecordingQualityChangedEvent Wikitude.TrackingMapRecorder.OnRecordingQualityChanged = new OnRecordingQualityChangedEvent()

Called whenever an active 3d tracking map recording session changes it's quality.

The new recording quality might be worse than the previous one, meaning that a new value doesn't has to be better than a previous one.

Parameters
newQualityNew quality of recording.

Property Documentation

bool Wikitude.TrackingMapRecorder.IsRecording
get

Use this to check if a 3D tracking map recording session is currently running or not.

string Wikitude.TrackingMapRecorder.TrackingMapName
getset

Name with which the tracking map will be saved when recording is complete.