Merge "Update docs to reflect LE batch scan report delay floor" am: e52fa865f8

Original change: https://android-review.googlesource.com/c/platform/frameworks/base/+/1682051

Change-Id: I1caef5696f0803f733771d5cfc6f09181ed25f5f
This commit is contained in:
Treehugger Robot
2021-04-21 17:50:39 +00:00
committed by Automerger Merge Worker

View File

@@ -345,12 +345,14 @@ public final class ScanSettings implements Parcelable {
} }
/** /**
* Set report delay timestamp for Bluetooth LE scan. * Set report delay timestamp for Bluetooth LE scan. If set to 0, you will be notified of
* scan results immediately. If > 0, scan results are queued up and delivered after the
* requested delay or 5000 milliseconds (whichever is higher). Note scan results may be
* delivered sooner if the internal buffers fill up.
* *
* @param reportDelayMillis Delay of report in milliseconds. Set to 0 to be notified of * @param reportDelayMillis how frequently scan results should be delivered in
* results immediately. Values > 0 causes the scan results to be queued up and delivered * milliseconds
* after the requested delay or when the internal buffers fill up. * @throws IllegalArgumentException if {@code reportDelayMillis} < 0
* @throws IllegalArgumentException If {@code reportDelayMillis} < 0.
*/ */
public Builder setReportDelay(long reportDelayMillis) { public Builder setReportDelay(long reportDelayMillis) {
if (reportDelayMillis < 0) { if (reportDelayMillis < 0) {