CompassReading Structure
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Contains information about the magnetic field detected by the device’s compass sensor, which can be used to determine the orientation of the device relative to the Earth’s magnetic field.
Namespace: Microsoft.Devices.Sensors
Assembly: Microsoft.Devices.Sensors (in Microsoft.Devices.Sensors.dll)
Syntax
Public Structure CompassReading _
Implements ISensorReading
public struct CompassReading : ISensorReading
The CompassReading type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
HeadingAccuracy | Gets the accuracy, in degrees, of the compass heading readings. |
|
MagneticHeading | Gets the heading, in degrees, measured clockwise from the Earth’s magnetic north. |
|
MagnetometerReading | Gets the raw magnetometer reading in microteslas. |
|
Timestamp | Gets a timestamp indicating the time at which the compass reading was taken. This can be used to correlate readings across sensors and provide additional input to algorithms that process raw sensor data. |
|
TrueHeading | Gets the heading, in degrees, measured clockwise from the Earth’s geographic north. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
.gif "Protected method") |
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType.) |
Top
Remarks
To obtain a CompassReading object, create a Compass object and then use the CurrentValue property or implement a handler for the CurrentValueChanged event.
Capabilities
If you use this API in your app, you must specify the following capabilities in the app manifest. Otherwise, your app might not work correctly or it might exit unexpectedly.
ID_CAP_SENSORS |
Windows Phone 8, Windows Phone OS 7.1 |
For more info, see App capabilities and hardware requirements for Windows Phone 8.
Version Information
Windows Phone OS
Supported in: 8.1, 8.0, 7.1
Platforms
Windows Phone
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.