Merge "SensorEventListener: Clarify documentation." into nyc-dev
am: 7d3a9e5259
* commit '7d3a9e525943705c7a6dca11929cfba29b2a24c1':
SensorEventListener: Clarify documentation.
This commit is contained in:
@@ -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).
|
||||
*
|
||||
* <p>See {@link android.hardware.SensorManager SensorManager}
|
||||
* for details on possible sensor types.
|
||||
* <p>See also {@link android.hardware.SensorEvent SensorEvent}.
|
||||
*
|
||||
*
|
||||
* <p><b>NOTE:</b> 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.
|
||||
*
|
||||
* <p>See the SENSOR_STATUS_* constants in
|
||||
* {@link android.hardware.SensorManager SensorManager} for details.
|
||||
|
||||
Reference in New Issue
Block a user