From 97de572b1b76ba72740bea672a89a8f52a80d73c Mon Sep 17 00:00:00 2001 From: Vinay Kalia Date: Fri, 1 Sep 2017 12:18:10 -0700 Subject: Update documentation for startScan With change c4a1e1, unfiltered BLE scans are stopped on screen off and resumed when screen is turned back on. This is done to save power. This change updates the documentation accordingly. BUG: 62264269 Test: Documentation update. Change-Id: I2d8e9f9f122f978c4d4f59d4139cb51cd4e4a123 --- framework/java/android/bluetooth/le/BluetoothLeScanner.java | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'framework/java/android/bluetooth/le/BluetoothLeScanner.java') diff --git a/framework/java/android/bluetooth/le/BluetoothLeScanner.java b/framework/java/android/bluetooth/le/BluetoothLeScanner.java index ad9e20b929..dd1a61c316 100644 --- a/framework/java/android/bluetooth/le/BluetoothLeScanner.java +++ b/framework/java/android/bluetooth/le/BluetoothLeScanner.java @@ -99,7 +99,9 @@ public final class BluetoothLeScanner { /** * Start Bluetooth LE scan with default parameters and no filters. The scan results will be - * delivered through {@code callback}. + * delivered through {@code callback}. For unfiltered scans, scanning is stopped on screen + * off to save power. Scanning is resumed when screen is turned on again. To avoid this, use + * {@link #startScan(List, ScanSettings, ScanCallback)} with desired {@link ScanFilter}. *

* An app must hold * {@link android.Manifest.permission#ACCESS_COARSE_LOCATION ACCESS_COARSE_LOCATION} or @@ -116,6 +118,9 @@ public final class BluetoothLeScanner { /** * Start Bluetooth LE scan. The scan results will be delivered through {@code callback}. + * For unfiltered scans, scanning is stopped on screen off to save power. Scanning is + * resumed when screen is turned on again. To avoid this, do filetered scanning by + * using proper {@link ScanFilter}. *

* An app must hold * {@link android.Manifest.permission#ACCESS_COARSE_LOCATION ACCESS_COARSE_LOCATION} or -- cgit v1.2.3