Most visited

Recently visited

Results for

Added in API level 21

Summary: Ctors | Methods | Inherited Methods | [Expand All]

ScanSettings.Builder

public static final class ScanSettings.Builder
extends Object

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

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.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

ScanSettings.Builder

Added in API level 21

ScanSettings.Builder ()

Public methods

build

Added in API level 21

ScanSettings build ()

Build ScanSettings.

Returns
`ScanSettings`

setCallbackType

Added in API level 23

ScanSettings.Builder setCallbackType (int callbackType)

Set callback type for Bluetooth LE scan.

Parameters
`callbackType`	`int`: The callback type flags for the scan.

Returns
`ScanSettings.Builder`

Throws
`IllegalArgumentException`	If the `callbackType` is invalid.

setMatchMode

Added in API level 23

ScanSettings.Builder setMatchMode (int matchMode)

Set match mode for Bluetooth LE scan filters hardware match

Parameters
`matchMode`	`int`: The match mode can be one of `MATCH_MODE_AGGRESSIVE` or `MATCH_MODE_STICKY`

Returns
`ScanSettings.Builder`

Throws
`IllegalArgumentException`	If the `matchMode` is invalid.

setNumOfMatches

Added in API level 23

ScanSettings.Builder setNumOfMatches (int numOfMatches)

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

Parameters
`numOfMatches`	`int`: The num of matches can be one of `MATCH_NUM_ONE_ADVERTISEMENT` or `MATCH_NUM_FEW_ADVERTISEMENT` or `MATCH_NUM_MAX_ADVERTISEMENT`

Returns
`ScanSettings.Builder`

Throws
`IllegalArgumentException`	If the `matchMode` is invalid.

setReportDelay

Added in API level 21

ScanSettings.Builder setReportDelay (long reportDelayMillis)

Set report delay timestamp for Bluetooth LE scan.

Parameters
`reportDelayMillis`	`long`: 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.

Returns
`ScanSettings.Builder`

Throws
`IllegalArgumentException`	If `reportDelayMillis` < 0.

setScanMode

Added in API level 21

ScanSettings.Builder setScanMode (int scanMode)

Set scan mode for Bluetooth LE scan.

Parameters
`scanMode`	`int`: The scan mode can be one of `SCAN_MODE_LOW_POWER`, `SCAN_MODE_BALANCED` or `SCAN_MODE_LOW_LATENCY`.

Returns
`ScanSettings.Builder`

Throws
`IllegalArgumentException`	If the `scanMode` is invalid.