MagnetometerAccuracy Enum

Reference

Definition

Namespace:: Windows.Devices.Sensors

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

The sensor's accuracy.

See One Dev Minute - Sensor calibration for a short video overview on how to calibrate the magnetometer.

public enum class MagnetometerAccuracy

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
enum class MagnetometerAccuracy

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public enum MagnetometerAccuracy

var value = Windows.Devices.Sensors.MagnetometerAccuracy.unknown

Public Enum MagnetometerAccuracy

Inheritance: Enum
MagnetometerAccuracy

Attributes: ContractVersionAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Fields

Name	Value	Description
Unknown	0	The accuracy is currently not available, typically because the driver can't report it. You should determine, based on your app's needs, whether your app will want to ask users to calibrate the device whenever this value is returned.
Unreliable	1	The actual and reported values have a high degree of inaccuracy. Apps should always ask the user to calibrate the device whenever this value is returned.
Approximate	2	The actual and reported values differ but may be accurate enough for some application. Apps that only need a relative value, like a virtual reality app, can continue without additional calibration.
High	3	The actual and reported values are accurate. No additional calibration is needed.

Remarks

Apps that need calibration should periodically ask the user to calibrate the device. We suggest doing this no more than every 10 minutes.

Applies to

Share via