<doc>
	<legacy_id></legacy_id>
	<name>iphoneSetHeadingCalibrationTimeout</name>
	<type>command</type>

	<syntax>
		<example>iphoneSetHeadingCalibrationTimeout <i>timeoutInSeconds</i></example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Sets the maximum length of time a prompt for calibration is displayed to the user.</summary>

	<examples>
<example>iphoneSetHeadingCalibrationTimeout 5</example>
<example>iphoneSetHeadingCalibrationTimeout 0</example>
	</examples>

	<history>
		<introduced version="4.6.1">Added.</introduced>
		<deprecated version=""></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>
		<function tag="iphoneHeadingCalibrationTimeout">iphoneHeadingCalibrationTimeout Function</function>
		<command tag="mobileStartTrackingSensor">mobileStartTrackingSensor Command</command>
		<command tag="mobileStopTrackingSensor">mobileStopTrackingSensor Command</command>
		<message tag="headingChanged">headingChanged Message</message>
		<message tag="trackingError">trackingError Message</message>
	</references>

	<description>
	<overview>Use the <b>iphoneSetHeadingCalibrationTimeout</b> command to control the length of time the system shows the calibration prompt to the user.</overview>

		<parameters>
  <parameter>
    <name>timeoutInSeconds</name>
    <description>An integer specifying the maximum length of time a prompt for calibration is displayed to the user, in seconds. If <i>timeoutInSeconds</i> is 0 no calibration prompt will be displayed.</description>
  </parameter>		</parameters>

	<value></value>
	<comments>It is sometimes necessary for the system to prompt the user to calibrate the magnetometer in order to provide reliable heading information. <p></p><p>By default this facility is turned off - i.e. the system will not prompt for calibration.</p><p></p><p>Use the <b>iphoneSetHeadingCalibrationTimeout</b> command to set the maximum length of time a prompt for calibration is displayed to the user. If <i>timeoutInSeconds</i> is 0 no calibration prompt is shown to the user, if non-zero it determines the maximum length of time the prompt for calibration is shown to the user. If the user does not choose to calibrate the device within that time the prompt will be dismissed.</p><p></p><p>The current setting of the timeout can be queried using the iphoneHeadingCalibrationTimeout function.</p></comments>
	</description>
</doc>