Accelerometer.GetCurrentReading Method

Definition

Namespace:

Windows.Devices.Sensors

Gets the current accelerometer reading.

public:
 virtual AccelerometerReading ^ GetCurrentReading() = GetCurrentReading;

AccelerometerReading GetCurrentReading();

public AccelerometerReading GetCurrentReading();

function getCurrentReading()

Public Function GetCurrentReading () As AccelerometerReading

Returns

AccelerometerReading

This method has no parameters.

Examples

The following example demonstrates how a UWP app built with XAML and C# retrieves the current reading for the three axes of the default accelerometer.

private void DisplayCurrentReading(object sender, object args)
{
    AccelerometerReading reading = _accelerometer.GetCurrentReading();
    if (reading != null)
    {
        ScenarioOutput_X.Text = String.Format("{0,5:0.00}", reading.AccelerationX);
        ScenarioOutput_Y.Text = String.Format("{0,5:0.00}", reading.AccelerationY);
        ScenarioOutput_Z.Text = String.Format("{0,5:0.00}", reading.AccelerationZ);
    }
}

Remarks

An application may use this method to poll the sensor for the current reading as an alternative to registering a ReadingChanged event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired ReportInterval. This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests

If the sensor is configured to support batch delivery, this method flushes the current batch and starts a new latency period. For more information about sensor batching, see Sensors.

Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.)

See also

• Sensor data and display orientation
• Accelerometer sample (Windows 10)