Most visited

Recently visited

Results for

Added in API level 21

Summary: Methods | Inherited Methods | [Expand All]

BluetoothLeScanner

public final class BluetoothLeScanner
extends Object

java.lang.Object
↳	android.bluetooth.le.BluetoothLeScanner

This class provides methods to perform scan related operations for Bluetooth LE devices. An application can scan for a particular type of Bluetooth LE devices using ScanFilter. It can also request different types of callbacks for delivering the result.

Use getBluetoothLeScanner() to get an instance of BluetoothLeScanner.

Note: Most of the scan methods here require BLUETOOTH_ADMIN permission.

See also:

ScanFilter

Summary

Public methods
`void`	`flushPendingScanResults(ScanCallback callback)` Flush pending batch scan results stored in Bluetooth controller.
`void`	`startScan(ScanCallback callback)` Start Bluetooth LE scan with default parameters and no filters.
`void`	`startScan(List<ScanFilter> filters, ScanSettings settings, ScanCallback callback)` Start Bluetooth LE scan.
`void`	`stopScan(ScanCallback callback)` Stops an ongoing 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 methods

flushPendingScanResults

Added in API level 21

void flushPendingScanResults (ScanCallback callback)

Flush pending batch scan results stored in Bluetooth controller. This will return Bluetooth LE scan results batched on bluetooth controller. Returns immediately, batch scan results data will be delivered through the callback.

Parameters
`callback`	`ScanCallback`: Callback of the Bluetooth LE Scan, it has to be the same instance as the one used to start scan.

startScan

Added in API level 21

void startScan (ScanCallback callback)

Start Bluetooth LE scan with default parameters and no filters. The scan results will be delivered through callback.

Requires BLUETOOTH_ADMIN permission. An app must hold ACCESS_COARSE_LOCATION or ACCESS_FINE_LOCATION permission in order to get results.

Parameters
`callback`	`ScanCallback`: Callback used to deliver scan results.

Throws
`IllegalArgumentException`	If `callback` is null.

startScan

Added in API level 21

void startScan (List<ScanFilter> filters, 
                ScanSettings settings, 
                ScanCallback callback)

Start Bluetooth LE scan. The scan results will be delivered through callback.

Requires BLUETOOTH_ADMIN permission. An app must hold ACCESS_COARSE_LOCATION or ACCESS_FINE_LOCATION permission in order to get results.

Parameters
`filters`	`List`: `ScanFilter`s for finding exact BLE devices.
`settings`	`ScanSettings`: Settings for the scan.
`callback`	`ScanCallback`: Callback used to deliver scan results.

Throws
`IllegalArgumentException`	If `settings` or `callback` is null.

stopScan

Added in API level 21

void stopScan (ScanCallback callback)

Stops an ongoing Bluetooth LE scan.

Requires BLUETOOTH_ADMIN permission.