iphoneHeadingCalibrationTimeout

Typefunction
DictionaryLCS
LibraryLiveCode Script
Syntax
iphoneHeadingCalibrationTimeout()
Summary

Returns the current value of the magnetometer calibration timeout.

Introduced4.6.1
OSios
Platformsmobile
Example
get iphoneHeadingCalibrationTimeout()
put iphoneHeadingCalibrationTimeout() into tTimeout
Values
NameTypeDescription
return

The iphoneHeadingCalibrationTimeout function returns an integer describing the maximum length of time a prompt for calibration is displayed to the user. A value of 0 means no calibration prompt is displayed.

RelatedCommand: iphoneStopTrackingHeading, iphoneSetHeadingCalibrationTimeout, iphoneStartTrackingHeading
Function: mobileCurrentHeading, mobileCanTrackHeading
Message: trackingError, headingChanged
Description

Use the iphoneHeadingCalibrationTimeout function to find the current value of the magnetometer calibration timeout.

It is sometimes necessary for the system to prompt the user to calibrate the magnetometer in order to provide reliable heading information. The iphoneHeadingCalibrationTimeout function returns the number of seconds this prompt is shown for. The calibration timeout can be set using the iphoneSetHeadingCalibrationTimeout command.