summaryrefslogtreecommitdiff
path: root/core/java/android
diff options
context:
space:
mode:
authorkmccormick <kmccormick@google.com>2013-03-28 17:47:52 -0700
committerkmccormick <kmccormick@google.com>2013-03-28 17:58:57 -0700
commita230b3cb96f8c73ab8703fbe0773fa02155369cd (patch)
tree7ac20b9218039e5e46a4d0258088a0385a4df5bd /core/java/android
parent689e827aa3fa69d20087972dfb93ed257e4d109b (diff)
Doc update: clarify rules for rate param
"Bug: 5581113" Change-Id: Ic87f1c331fba2b08de295b2d77832739bf823500
Diffstat (limited to 'core/java/android')
-rw-r--r--core/java/android/hardware/SensorManager.java10
1 files changed, 8 insertions, 2 deletions
diff --git a/core/java/android/hardware/SensorManager.java b/core/java/android/hardware/SensorManager.java
index b8ad8181ac79..08fba29956ce 100644
--- a/core/java/android/hardware/SensorManager.java
+++ b/core/java/android/hardware/SensorManager.java
@@ -572,7 +572,10 @@ public abstract class SensorManager {
* 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}
- * or, the desired delay between events in microsecond.
+ * or, the desired delay between events in microseconds.
+ * Specifying the delay in microseconds only works from Android
+ * 2.3 (API level 9) onwards. For earlier releases, you must use
+ * one of the {@code SENSOR_DELAY_*} constants.
*
* @return <code>true</code> if the sensor is supported and successfully
* enabled.
@@ -604,7 +607,10 @@ public abstract class SensorManager {
* 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}.
- * or, the desired delay between events in microsecond.
+ * or, the desired delay between events in microseconds.
+ * Specifying the delay in microseconds only works from Android
+ * 2.3 (API level 9) onwards. For earlier releases, you must use
+ * one of the {@code SENSOR_DELAY_*} constants.
*
* @param handler
* The {@link android.os.Handler Handler} the