Android APIs
public static final class

ScanSettings.Builder

extends Object
java.lang.Object
   ↳ android.bluetooth.le.ScanSettings.Builder

Class Overview

Builder for ScanSettings.

Summary

Public Constructors
ScanSettings.Builder()
Public Methods
ScanSettings build()
Build ScanSettings.
ScanSettings.Builder setCallbackType(int callbackType)
Set callback type for Bluetooth LE scan.
ScanSettings.Builder setMatchMode(int matchMode)
Set match mode for Bluetooth LE scan filters hardware match
ScanSettings.Builder setNumOfMatches(int numOfMatches)
Set the number of matches for Bluetooth LE scan filters hardware match
ScanSettings.Builder setReportDelay(long reportDelayMillis)
Set report delay timestamp for Bluetooth LE scan.
ScanSettings.Builder setScanMode(int scanMode)
Set scan mode for Bluetooth LE scan.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ScanSettings.Builder ()

Added in API level 21

Public Methods

public ScanSettings build ()

Added in API level 21

Build ScanSettings.

public ScanSettings.Builder setCallbackType (int callbackType)

Added in API level 23

Set callback type for Bluetooth LE scan.

Parameters
callbackType The callback type flags for the scan.
Throws
IllegalArgumentException If the callbackType is invalid.

public ScanSettings.Builder setMatchMode (int matchMode)

Added in API level 23

Set match mode for Bluetooth LE scan filters hardware match

Parameters
matchMode The match mode can be one of MATCH_MODE_AGGRESSIVE or MATCH_MODE_STICKY
Throws
IllegalArgumentException If the matchMode is invalid.

public ScanSettings.Builder setNumOfMatches (int numOfMatches)

Added in API level 23

Set the number of matches for Bluetooth LE scan filters hardware match

Parameters
numOfMatches The num of matches can be one of MATCH_NUM_ONE_ADVERTISEMENT or MATCH_NUM_FEW_ADVERTISEMENT or MATCH_NUM_MAX_ADVERTISEMENT
Throws
IllegalArgumentException If the matchMode is invalid.

public ScanSettings.Builder setReportDelay (long reportDelayMillis)

Added in API level 21

Set report delay timestamp for Bluetooth LE scan.

Parameters
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 reportDelayMillis < 0.

public ScanSettings.Builder setScanMode (int scanMode)

Added in API level 21

Set scan mode for Bluetooth LE scan.

Parameters
scanMode The scan mode can be one of SCAN_MODE_LOW_POWER, SCAN_MODE_BALANCED or SCAN_MODE_LOW_LATENCY.
Throws
IllegalArgumentException If the scanMode is invalid.