Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 370ecf00 authored by Ugo Yu's avatar Ugo Yu
Browse files

Additional metadata keys for Fast Pair 

Tag: #feature
Bug: 171387275
Test: atest BluetoothInstrumentationTests
Change-Id: I98f4cbd214437d1cd3681be03108c824ad087260
parent b9c396b8

core/api/system-current.txt

+10 −0
Original line number Diff line number Diff line
@@ -1491,11 +1491,18 @@ package android.bluetooth { 
    field public static final int ACCESS_REJECTED = 2; // 0x2

    field public static final int ACCESS_UNKNOWN = 0; // 0x0

    field public static final String ACTION_SILENCE_MODE_CHANGED = "android.bluetooth.device.action.SILENCE_MODE_CHANGED";

    field public static final String DEVICE_TYPE_DEFAULT = "Default";

    field public static final String DEVICE_TYPE_UNTETHERED_HEADSET = "Untethered Headset";

    field public static final String DEVICE_TYPE_WATCH = "Watch";

    field public static final int METADATA_COMPANION_APP = 4; // 0x4

    field public static final int METADATA_DEVICE_TYPE = 17; // 0x11

    field public static final int METADATA_ENHANCED_SETTINGS_UI_URI = 16; // 0x10

    field public static final int METADATA_HARDWARE_VERSION = 3; // 0x3

    field public static final int METADATA_IS_UNTETHERED_HEADSET = 6; // 0x6

    field public static final int METADATA_MAIN_BATTERY = 18; // 0x12

    field public static final int METADATA_MAIN_CHARGING = 19; // 0x13

    field public static final int METADATA_MAIN_ICON = 5; // 0x5

    field public static final int METADATA_MAIN_LOW_BATTERY_THRESHOLD = 20; // 0x14

    field public static final int METADATA_MANUFACTURER_NAME = 0; // 0x0

    field public static final int METADATA_MAX_LENGTH = 2048; // 0x800

    field public static final int METADATA_MODEL_NAME = 1; // 0x1
@@ -1503,12 +1510,15 @@ package android.bluetooth { 
    field public static final int METADATA_UNTETHERED_CASE_BATTERY = 12; // 0xc

    field public static final int METADATA_UNTETHERED_CASE_CHARGING = 15; // 0xf

    field public static final int METADATA_UNTETHERED_CASE_ICON = 9; // 0x9

    field public static final int METADATA_UNTETHERED_CASE_LOW_BATTERY_THRESHOLD = 23; // 0x17

    field public static final int METADATA_UNTETHERED_LEFT_BATTERY = 10; // 0xa

    field public static final int METADATA_UNTETHERED_LEFT_CHARGING = 13; // 0xd

    field public static final int METADATA_UNTETHERED_LEFT_ICON = 7; // 0x7

    field public static final int METADATA_UNTETHERED_LEFT_LOW_BATTERY_THRESHOLD = 21; // 0x15

    field public static final int METADATA_UNTETHERED_RIGHT_BATTERY = 11; // 0xb

    field public static final int METADATA_UNTETHERED_RIGHT_CHARGING = 14; // 0xe

    field public static final int METADATA_UNTETHERED_RIGHT_ICON = 8; // 0x8

    field public static final int METADATA_UNTETHERED_RIGHT_LOW_BATTERY_THRESHOLD = 22; // 0x16

  }















  public final class BluetoothHeadset implements android.bluetooth.BluetoothProfile {

































core/java/android/bluetooth/BluetoothDevice.java



+124
−2




























Original line number
Diff line number
Diff line








@@ -354,6 +354,35 @@ public final class BluetoothDevice implements Parcelable {













    public static final String ACTION_SDP_RECORD =















            "android.bluetooth.device.action.SDP_RECORD";





























    /** @hide */













    @IntDef(prefix = "METADATA_", value = {













            METADATA_MANUFACTURER_NAME,













            METADATA_MODEL_NAME,













            METADATA_SOFTWARE_VERSION,













            METADATA_HARDWARE_VERSION,













            METADATA_COMPANION_APP,













            METADATA_MAIN_ICON,













            METADATA_IS_UNTETHERED_HEADSET,













            METADATA_UNTETHERED_LEFT_ICON,













            METADATA_UNTETHERED_RIGHT_ICON,













            METADATA_UNTETHERED_CASE_ICON,













            METADATA_UNTETHERED_LEFT_BATTERY,













            METADATA_UNTETHERED_RIGHT_BATTERY,













            METADATA_UNTETHERED_CASE_BATTERY,













            METADATA_UNTETHERED_LEFT_CHARGING,













            METADATA_UNTETHERED_RIGHT_CHARGING,













            METADATA_UNTETHERED_CASE_CHARGING,













            METADATA_ENHANCED_SETTINGS_UI_URI,













            METADATA_DEVICE_TYPE,













            METADATA_MAIN_BATTERY,













            METADATA_MAIN_CHARGING,













            METADATA_MAIN_LOW_BATTERY_THRESHOLD,













            METADATA_UNTETHERED_LEFT_LOW_BATTERY_THRESHOLD,













            METADATA_UNTETHERED_RIGHT_LOW_BATTERY_THRESHOLD,













            METADATA_UNTETHERED_CASE_LOW_BATTERY_THRESHOLD})













    @Retention(RetentionPolicy.SOURCE)













    public @interface MetadataKey{}





























    /**















     * Maximum length of a metadata entry, this is to avoid exploding Bluetooth















     * disk usage










@@ -502,6 +531,89 @@ public final class BluetoothDevice implements Parcelable {













    @SystemApi















    public static final int METADATA_ENHANCED_SETTINGS_UI_URI = 16;





























    /**













     * Type of the Bluetooth device, must be within the list of













     * BluetoothDevice.DEVICE_TYPE_*













     * Data type should be {@String} as {@link Byte} array.













     * @hide













     */













    @SystemApi













    public static final int METADATA_DEVICE_TYPE = 17;



























    /**













     * Battery level of the Bluetooth device, use when the Bluetooth device













     * does not support HFP battery indicator.













     * Data type should be {@String} as {@link Byte} array.













     * @hide













     */













    @SystemApi













    public static final int METADATA_MAIN_BATTERY = 18;



























    /**













     * Whether the device is charging.













     * Data type should be {@String} as {@link Byte} array.













     * @hide













     */













    @SystemApi













    public static final int METADATA_MAIN_CHARGING = 19;



























    /**













     * The battery threshold of the Bluetooth device to show low battery icon.













     * Data type should be {@String} as {@link Byte} array.













     * @hide













     */













    @SystemApi













    public static final int METADATA_MAIN_LOW_BATTERY_THRESHOLD = 20;



























    /**













     * The battery threshold of the left headset to show low battery icon.













     * Data type should be {@String} as {@link Byte} array.













     * @hide













     */













    @SystemApi













    public static final int METADATA_UNTETHERED_LEFT_LOW_BATTERY_THRESHOLD = 21;



























    /**













     * The battery threshold of the right headset to show low battery icon.













     * Data type should be {@String} as {@link Byte} array.













     * @hide













     */













    @SystemApi













    public static final int METADATA_UNTETHERED_RIGHT_LOW_BATTERY_THRESHOLD = 22;



























    /**













     * The battery threshold of the case to show low battery icon.













     * Data type should be {@String} as {@link Byte} array.













     * @hide













     */













    @SystemApi













    public static final int METADATA_UNTETHERED_CASE_LOW_BATTERY_THRESHOLD = 23;



























    /**













     * Device type which is used in METADATA_DEVICE_TYPE













     * Indicates this Bluetooth device is a standard Bluetooth accessory or













     * not listed in METADATA_DEVICE_TYPE_*.













     * @hide













     */













    @SystemApi













    public static final String DEVICE_TYPE_DEFAULT = "Default";



























    /**













     * Device type which is used in METADATA_DEVICE_TYPE













     * Indicates this Bluetooth device is a watch.













     * @hide













     */













    @SystemApi













    public static final String DEVICE_TYPE_WATCH = "Watch";



























    /**













     * Device type which is used in METADATA_DEVICE_TYPE













     * Indicates this Bluetooth device is an untethered headset.













     * @hide













     */













    @SystemApi













    public static final String DEVICE_TYPE_UNTETHERED_HEADSET = "Untethered Headset";





























    /**















     * Broadcast Action: This intent is used to broadcast the {@link UUID}















     * wrapped as a {@link android.os.ParcelUuid} of the remote device after it










@@ -2258,7 +2370,7 @@ public final class BluetoothDevice implements Parcelable {













    */















    @SystemApi















    @RequiresPermission(Manifest.permission.BLUETOOTH_PRIVILEGED)













    public boolean setMetadata(int key, @NonNull byte[] value) {













    public boolean setMetadata(@MetadataKey int key, @NonNull byte[] value) {















        final IBluetooth service = sService;















        if (service == null) {















            Log.e(TAG, "Bluetooth is not enabled. Cannot set metadata");










@@ -2286,7 +2398,7 @@ public final class BluetoothDevice implements Parcelable {













    @SystemApi















    @Nullable















    @RequiresPermission(Manifest.permission.BLUETOOTH_PRIVILEGED)













    public byte[] getMetadata(int key) {













    public byte[] getMetadata(@MetadataKey int key) {















        final IBluetooth service = sService;















        if (service == null) {















            Log.e(TAG, "Bluetooth is not enabled. Cannot get metadata");









@@ -2299,4 +2411,14 @@ public final class BluetoothDevice implements Parcelable {













            return null;















        }















    }



























    /**













     * Get the maxinum metadata key ID.













     *













     * @return the last supported metadata key













     * @hide













     */













    public static @MetadataKey int getMaxMetadataKey() {













        return METADATA_UNTETHERED_CASE_LOW_BATTERY_THRESHOLD;













    }















}