diff --git a/core/java/android/hardware/SensorEventListener.java b/core/java/android/hardware/SensorEventListener.java index 0d859fb976344..0c059ba6bbc1b 100644 --- a/core/java/android/hardware/SensorEventListener.java +++ b/core/java/android/hardware/SensorEventListener.java @@ -18,28 +18,33 @@ package android.hardware; /** * Used for receiving notifications from the SensorManager when - * sensor values have changed. + * there is new sensor data. */ public interface SensorEventListener { /** - * Called when sensor values have changed. + * Called when there is a new sensor event. Note that "on changed" + * is somewhat of a misnomer, as this will also be called if we have a + * new reading from a sensor with the exact same sensor values (but a + * newer timestamp). + * *

See {@link android.hardware.SensorManager SensorManager} * for details on possible sensor types. *

See also {@link android.hardware.SensorEvent SensorEvent}. - * + * *

NOTE: The application doesn't own the * {@link android.hardware.SensorEvent event} * object passed as a parameter and therefore cannot hold on to it. * The object may be part of an internal pool and may be reused by * the framework. * - * @param event the {@link android.hardware.SensorEvent SensorEvent}. + * @param event the {@link android.hardware.SensorEvent SensorEvent}. */ public void onSensorChanged(SensorEvent event); /** - * Called when the accuracy of the registered sensor has changed. + * Called when the accuracy of the registered sensor has changed. Unlike + * onSensorChanged(), this is only called when this accuracy value changes. * *

See the SENSOR_STATUS_* constants in * {@link android.hardware.SensorManager SensorManager} for details.