diff options
| author | Vinay Kalia <vinaykalia@google.com> | 2017-09-01 12:18:10 -0700 |
|---|---|---|
| committer | Vinay Kalia <vinaykalia@google.com> | 2017-09-05 11:52:35 -0700 |
| commit | 97de572b1b76ba72740bea672a89a8f52a80d73c (patch) | |
| tree | 2dfa21a1a1b34583750d9ea8664c21c7d3433137 /framework/java/android/bluetooth | |
| parent | 01ea3736138c612f04ccee60adf68a5b0e2d5b7d (diff) | |
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
Diffstat (limited to 'framework/java/android/bluetooth')
| -rw-r--r-- | framework/java/android/bluetooth/le/BluetoothLeScanner.java | 7 |
1 files changed, 6 insertions, 1 deletions
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}. * <p> * 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}. * <p> * An app must hold * {@link android.Manifest.permission#ACCESS_COARSE_LOCATION ACCESS_COARSE_LOCATION} or |