summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Hayden Gomes <haydengomes@google.com> 2020-09-08 12:50:12 -0700
committer Hayden Gomes <haydengomes@google.com> 2020-09-10 08:07:30 -0700
commit74ecd8a55337ed7807110c159f4d184582a26c9b (patch)
treecce6698353fbe61abdb0091faafb51a069cad617
parent2e04dc8ebaa922d0361831f3595b521c58f57ae0 (diff)
Define Auto coordinate system for mics
For automotive form factors, the origin point for positioning is different than that of mobile devices. Updating microphone position javadocs to clarify the two systems. Bug: 159923715 Test: spell check & make Change-Id: I90926239e0ba7c3ef1e500d75e01ed6767a4bd6b
-rw-r--r--media/java/android/media/MicrophoneInfo.java7
1 files changed, 5 insertions, 2 deletions
diff --git a/media/java/android/media/MicrophoneInfo.java b/media/java/android/media/MicrophoneInfo.java
index 876628fefff4..acd284f3fad9 100644
--- a/media/java/android/media/MicrophoneInfo.java
+++ b/media/java/android/media/MicrophoneInfo.java
@@ -268,8 +268,11 @@ public final class MicrophoneInfo {
/**
* Returns A {@link Coordinate3F} object that represents the geometric location of microphone
- * in meters, from bottom-left-back corner of appliance. X-axis, Y-axis and Z-axis show
- * as the x, y, z values.
+ * in meters. X-axis, Y-axis and Z-axis show as the x, y, z values. For mobile devices, the axes
+ * originate from the bottom-left-back corner of the appliance. In devices with
+ * {@link android.content.pm.PackageManager#FEATURE_AUTOMOTIVE}, axes are defined with respect
+ * to the vehicle body frame, originating from the center of the vehicle's rear axle.
+ * @see <a href="https://source.android.com/devices/sensors/sensor-types#auto_axes">auto axes</a>
*
* @return the geometric location of the microphone or {@link #POSITION_UNKNOWN} if the
* geometric location is unknown