diff options
| author | Sal Savage <salsavage@google.com> | 2022-03-10 12:17:23 -0800 |
|---|---|---|
| committer | Sal Savage <salsavage@google.com> | 2022-03-11 01:12:17 +0000 |
| commit | aed1d4830f320b877b2d75a752c25bbfd83ecc9c (patch) | |
| tree | cda32a6a14b13669bb54ef4c271ae08aea30c127 | |
| parent | 656de6db11a9257253bdcaf19b62d884cef09d52 (diff) | |
Update getSignalStrength() javadoc
Tag: #refactor
Bug: 219820175
Test: N/A, comment updates only
Change-Id: I9e7e8921e56114dccefb988c8750323ffd432cd9
| -rw-r--r-- | framework/java/android/bluetooth/BluetoothHeadsetClient.java | 31 |
1 files changed, 16 insertions, 15 deletions
diff --git a/framework/java/android/bluetooth/BluetoothHeadsetClient.java b/framework/java/android/bluetooth/BluetoothHeadsetClient.java index 6a67923f11..d47e41a0b1 100644 --- a/framework/java/android/bluetooth/BluetoothHeadsetClient.java +++ b/framework/java/android/bluetooth/BluetoothHeadsetClient.java @@ -1743,19 +1743,7 @@ public final class BluetoothHeadsetClient implements BluetoothProfile, AutoClose private final String mOperatorName; /** - * The general signal strength, from 0 to 5. - * - * Bluetooth HFP v1.8 specifies that the signal strength of a device can be [0, 5]. It does - * place any requirements on how a device derives those values. While they're typically - * derived from signal quality/RSSI buckets, there's way to be certain on the exact meaning. - * - * That said, you can "generally" interpret the values relative to each other as follows: - * - Level 0: None/Unknown - * - Level 1: Very Poor - * - Level 2: Poor - * - Level 3: Fair - * - Level 4: Good - * - Level 5: Great + * The general signal strength, from 0 to 5 */ private final int mSignalStrength; @@ -1821,9 +1809,22 @@ public final class BluetoothHeadsetClient implements BluetoothProfile, AutoClose } /** - * Get the network's general signal strength + * The HFP Client defined signal strength, from 0 to 5. + * + * Bluetooth HFP v1.8 specifies that the signal strength of a device can be [0, 5]. It does + * not place any requirements on how a device derives those values. While they're typically + * derived from signal quality/RSSI buckets, there's no way to be certain on the exact + * meaning. Derivation methods can even change between wireless cellular technologies. + * + * That said, you can "generally" interpret the values relative to each other as follows: + * - Level 0: None/Unknown + * - Level 1: Very Poor + * - Level 2: Poor + * - Level 3: Fair + * - Level 4: Good + * - Level 5: Great * - * @return The general signal strength, range [0, 5] + * @return the HFP Client defined signal strength, range [0, 5] * * @hide */ |