diff options
| author | Rahul Sabnis <rahulsabnis@google.com> | 2022-06-06 13:54:07 -0700 |
|---|---|---|
| committer | Rahul Sabnis <rahulsabnis@google.com> | 2022-06-06 14:02:20 -0700 |
| commit | be3185b409aeacb05e9f4a8b59d56e7805075ad5 (patch) | |
| tree | 6901291ac4b2654ffd62d31416c413a2aa25d6b3 | |
| parent | aaa3fcb70b36ad95cfb7276dabf6ee0836454d6a (diff) | |
Update API docs to state that the IRK must be supplied in little endian
byte order
Tag: #feature
Bug: 233217148
Test: Manual (docs change)
Ignore-AOSP-First: Android T docs change
Change-Id: I5cab17003c22329744341235bb053cb55b4f7989
| -rw-r--r-- | framework/java/android/bluetooth/le/ScanFilter.java | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/framework/java/android/bluetooth/le/ScanFilter.java b/framework/java/android/bluetooth/le/ScanFilter.java index ee65f168be..bf902e889a 100644 --- a/framework/java/android/bluetooth/le/ScanFilter.java +++ b/framework/java/android/bluetooth/le/ScanFilter.java @@ -742,11 +742,11 @@ public final class ScanFilter implements Parcelable { * address can be validated using {@link BluetoothAdapter#checkBluetoothAddress}. * <p> * The IRK is used to resolve a static address from a private address. The IRK must be - * provided in big endian byte order. + * provided in little endian byte order. * * @param deviceAddress the remote device Bluetooth address for the filter * @param addressType indication of the type of address - * @param irk non-null byte array representing the Identity Resolving Key + * @param irk non-null little endian byte array representing the Identity Resolving Key * * @throws IllegalArgumentException If the {@code deviceAddress} is invalid * @throws IllegalArgumentException if the {@code irk} is invalid length @@ -777,9 +777,8 @@ public final class ScanFilter implements Parcelable { * format of "01:02:03:AB:CD:EF". The device address can be validated using {@link * BluetoothAdapter#checkBluetoothAddress}. * @param addressType indication of the type of address - * e.g. {@link BluetoothDevice#ADDRESS_TYPE_PUBLIC} - * @param irk non-null byte array representing the Identity Resolving Address; nullable - * internally. + * @param irk non-null little endian byte array representing the Identity Resolving Key; + * nullable internally. * * @throws IllegalArgumentException if the {@code deviceAddress} is invalid * @throws IllegalArgumentException if the {@code addressType} is not PUBLIC or RANDOM |