Update docs to reflect LE batch scan report delay floor

Tag: #feature
Bug: 167340030
Test: Manual
Change-Id: Ieeb0e6bccfc316fd4c8cdc40f6865b4185d6d9e8
This commit is contained in:
Rahul Sabnis
2021-04-20 14:22:16 -07:00
parent 8d7bd3610a
commit edad7c7c60

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
* results immediately. Values > 0 causes the scan results to be queued up and delivered
* after the requested delay or when the internal buffers fill up.
* @throws IllegalArgumentException If {@code reportDelayMillis} < 0.
* @param reportDelayMillis how frequently scan results should be delivered in
* milliseconds
* @throws IllegalArgumentException if {@code reportDelayMillis} < 0
*/
public Builder setReportDelay(long reportDelayMillis) {
if (reportDelayMillis < 0) {