Compass.Start Method
Definition
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.
Overloads
| Start(SensorSpeed) |
Start monitoring for changes to the compass. |
| Start(SensorSpeed, Boolean) |
Start monitoring for changes to the compass. |
Start(SensorSpeed)
- Source:
- Compass.shared.cs
- Source:
- Compass.shared.cs
Start monitoring for changes to the compass.
public:
static void Start(Microsoft::Maui::Devices::Sensors::SensorSpeed sensorSpeed);public static void Start (Microsoft.Maui.Devices.Sensors.SensorSpeed sensorSpeed);static member Start : Microsoft.Maui.Devices.Sensors.SensorSpeed -> unitPublic Shared Sub Start (sensorSpeed As SensorSpeed)Parameters
- sensorSpeed
- SensorSpeed
The speed to monitor for changes.
Remarks
Will throw FeatureNotSupportedException if not supported on device. Will throw InvalidOperationException if IsMonitoring is true.
Applies to
Start(SensorSpeed, Boolean)
- Source:
- Compass.shared.cs
- Source:
- Compass.shared.cs
Start monitoring for changes to the compass.
public:
static void Start(Microsoft::Maui::Devices::Sensors::SensorSpeed sensorSpeed, bool applyLowPassFilter);public static void Start (Microsoft.Maui.Devices.Sensors.SensorSpeed sensorSpeed, bool applyLowPassFilter);static member Start : Microsoft.Maui.Devices.Sensors.SensorSpeed * bool -> unitPublic Shared Sub Start (sensorSpeed As SensorSpeed, applyLowPassFilter As Boolean)Parameters
- sensorSpeed
- SensorSpeed
The speed to monitor for changes.
- applyLowPassFilter
- Boolean
Whether or not to apply a moving average filter (only used on Android).
Remarks
Will throw FeatureNotSupportedException if not supported on device. Will throw InvalidOperationException if IsMonitoring is true.
