Compass Class

July 28, 2014

Provides Windows Phone applications access to the device’s compass sensor.

Namespace:  Microsoft.Devices.Sensors
Assembly:  Microsoft.Devices.Sensors (in Microsoft.Devices.Sensors.dll)
XMLNS for XAML: Not mapped to an xmlns.

public sealed class Compass : SensorBase<CompassReading>

The Compass type exposes the following members.

  NameDescription
Public methodCompassInitializes a new instance of the Compass class.
Top

  NameDescription
Public propertyCurrentValueGets an object that implements ISensorReading that contains the current value of the sensor. This object will be one of the following types, depending on which sensor is being referenced: AccelerometerReading, CompassReading, GyroscopeReading, MotionReading. (Inherited from SensorBase<TSensorReading>.)
Public propertyIsDataValidGets the validity of the sensor’s data. (Inherited from SensorBase<TSensorReading>.)
Public propertyStatic memberIsSupportedGets whether the device on which the application is running supports the compass sensor.
Public propertyTimeBetweenUpdatesGets or sets the preferred time between CurrentValueChanged events. (Inherited from SensorBase<TSensorReading>.)
Top

  NameDescription
Public methodDisposeReleases the managed and unmanaged resources used by the sensor. (Inherited from SensorBase<TSensorReading>.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from SensorBase<TSensorReading>.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodStartStarts acquisition of data from the sensor. (Inherited from SensorBase<TSensorReading>.)
Public methodStopStops acquisition of data from the sensor. (Inherited from SensorBase<TSensorReading>.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventCalibrateOccurs when the operating system detects that the compass needs calibration.
Public eventCurrentValueChangedOccurs when new data arrives from the sensor. (Inherited from SensorBase<TSensorReading>.)
Top

The compass, or magnetometer, sensor can be used to determine the angle by which the device is rotated relative to the Earth’s magnetic north pole. An application can also use raw magnetometer readings to detect magnetic forces around the device.

The compass uses a different axis to compute the heading, depending on the orientation of the device. For an example of how to determine which axis is being used, see How to get data from the compass sensor for Windows Phone 8.

If you want to create an application that uses the device’s orientation in 3D space, you should use the RotationMatrix property of the Motion class.

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.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft