Magnetometer Class

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

Represents a magnetic sensor.

public ref class Magnetometer sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class Magnetometer final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class Magnetometer

Public NotInheritable Class Magnetometer

Inheritance: Object Platform::Object IInspectable Magnetometer

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

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

Remarks

Version history

Windows version	SDK version	Value added
1709	16299	FromIdAsync
1709	16299	GetDeviceSelector
1709	16299	MaxBatchSize
1709	16299	ReportLatency
2004	19041	ReportThreshold

Properties

DeviceId	Gets the device identifier.
MaxBatchSize	Gets the maximum number of events that can be batched by the sensor.
MinimumReportInterval	Gets the minimum report interval supported by the magnetometer.
ReadingTransform	Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data.
ReportInterval	Gets or sets the current report interval for the magnetometer.
ReportLatency	Gets or sets the delay between batches of sensor information.
ReportThreshold	Gets the MagnetometerDataThreshold for the magnetometer sensor.

Methods

FromIdAsync(String)	Asynchronously obtains the sensor from its identifier.
GetCurrentReading()	Gets the current magnetometer reading.
GetDefault()	Returns the default magnetometer.
GetDeviceSelector()	Gets the device selector.

Events

ReadingChanged

Occurs each time the compass reports a new sensor reading.

Applies to