<doc>
	<legacy_id></legacy_id>
	<name>iphoneHeadingCalibrationTimeout</name>
	<type>function</type>

	<syntax>
		<example>iphoneHeadingCalibrationTimeout()</example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Returns the current value of the magnetometer calibration timeout.</summary>

	<examples>
<example>get iphoneHeadingCalibrationTimeout()</example>
<example>put iphoneHeadingCalibrationTimeout() into tTimeout</example>
	</examples>

	<history>
		<introduced version="4.6.1">Added.</introduced>
		<deprecated version="5.5">Deprecated.</deprecated>
		<removed version=""></removed>
		<changed version=""></changed>
	</history>

	<objects>
	</objects>

	<platforms>
		<ios/>
	</platforms>

	<classes>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
	</classification>

	<references>
		<function tag="mobileCanTrackHeading">mobileCanTrackHeading Function</function>
		<function tag="mobileCurrentHeading">mobileCurrentHeading Function</function>
		<command tag="iphoneStartTrackingHeading">iphoneStartTrackingHeading Command</command>
		<command tag="iphoneStopTrackingHeading">iphoneStopTrackingHeading Command</command>
		<command tag="iphoneSetHeadingCalibrationTimeout">iphoneSetHeadingCalibrationTimeout Command</command>
		<message tag="headingChanged">headingChanged Message</message>
		<message tag="trackingError">trackingError Message</message>
	</references>

	<description>
	<overview>Use the <b>iphoneHeadingCalibrationTimeout</b> function to find the current value of the magnetometer calibration timeout.</overview>

		<parameters>
		</parameters>

	<value>The <b>iphoneHeadingCalibrationTimeout</b> function returns an integer describing the maximum length of time a prompt for calibration is displayed to the user.<p></p><p>A value of 0 means no calibration prompt is displayed.</p></value>
	<comments>It is sometimes necessary for the system to prompt the user to calibrate the magnetometer in order to provide reliable heading information. The <b>iphoneHeadingCalibrationTimeout</b> function returns the number of seconds this prompt is shown for. The calibration timeout can be set using the <command tag="iphoneSetHeadingCalibrationTimeout">iphoneSetHeadingCalibrationTimeout</command> command.</comments>
	</description>
</doc>