summaryrefslogtreecommitdiffstats
path: root/core/java
diff options
context:
space:
mode:
authorChris Tate <>2009-04-01 16:01:18 -0700
committerThe Android Open Source Project <initial-contribution@android.com>2009-04-01 16:01:18 -0700
commit5a0cb42f3ffc10502233d94fe4fae629c3111c7b (patch)
tree69e39bab27570f0cc91e2e093b12b31f39216567 /core/java
parent79ad6262314281dff10f7c4ed90fec893a60e274 (diff)
downloadframeworks_base-5a0cb42f3ffc10502233d94fe4fae629c3111c7b.zip
frameworks_base-5a0cb42f3ffc10502233d94fe4fae629c3111c7b.tar.gz
frameworks_base-5a0cb42f3ffc10502233d94fe4fae629c3111c7b.tar.bz2
AI 144135: am: CL 144134 Fix issue 1750132 - SensorManager listener 'rate' parameter units are undocumented
Original author: ctate Merged from: //branches/cupcake/... Automated import of CL 144135
Diffstat (limited to 'core/java')
-rw-r--r--core/java/android/hardware/SensorManager.java11
1 files changed, 8 insertions, 3 deletions
diff --git a/core/java/android/hardware/SensorManager.java b/core/java/android/hardware/SensorManager.java
index 7fbb3a7..0c88a2e 100644
--- a/core/java/android/hardware/SensorManager.java
+++ b/core/java/android/hardware/SensorManager.java
@@ -616,7 +616,8 @@ public class SensorManager extends IRotationWatcher.Stub
* @param sensors a bit masks of the sensors to register to
* @param rate rate of events. This is only a hint to the system. events
* may be received faster or slower than the specified rate. Usually events
- * are received faster.
+ * are received faster. The value must be one of {@link #SENSOR_DELAY_NORMAL},
+ * {@link #SENSOR_DELAY_UI}, {@link #SENSOR_DELAY_GAME}, or {@link #SENSOR_DELAY_FASTEST}.
*
* @return true if the sensor is supported and successfully enabled
*/
@@ -785,7 +786,9 @@ public class SensorManager extends IRotationWatcher.Stub
* @param sensor The {@link android.hardware.Sensor Sensor} to register to.
* @param rate The rate {@link android.hardware.SensorEvent sensor events} are delivered at.
* This is only a hint to the system. Events may be received faster or
- * slower than the specified rate. Usually events are received faster.
+ * slower than the specified rate. Usually events are received faster. The value must be
+ * one of {@link #SENSOR_DELAY_NORMAL}, {@link #SENSOR_DELAY_UI}, {@link #SENSOR_DELAY_GAME},
+ * or {@link #SENSOR_DELAY_FASTEST}.
*
* @return true if the sensor is supported and successfully enabled.
*
@@ -802,7 +805,9 @@ public class SensorManager extends IRotationWatcher.Stub
* @param sensor The {@link android.hardware.Sensor Sensor} to register to.
* @param rate The rate {@link android.hardware.SensorEvent sensor events} are delivered at.
* This is only a hint to the system. Events may be received faster or
- * slower than the specified rate. Usually events are received faster.
+ * slower than the specified rate. Usually events are received faster. The value must be one
+ * of {@link #SENSOR_DELAY_NORMAL}, {@link #SENSOR_DELAY_UI}, {@link #SENSOR_DELAY_GAME}, or
+ * {@link #SENSOR_DELAY_FASTEST}.
* @param handler The {@link android.os.Handler Handler} the
* {@link android.hardware.SensorEvent sensor events} will be delivered to.
*