Classes

Added in API level 21

public final class

ScanSettings

extends Object
implements Parcelable

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

Class Overview

Bluetooth LE scan settings are passed to startScan(ScanCallback) to define the parameters for the scan.

Summary

Nested Classes
class	ScanSettings.Builder	Builder for `ScanSettings`.

Constants
int	CALLBACK_TYPE_ALL_MATCHES	Trigger a callback for every Bluetooth advertisement found that matches the filter criteria.
int	SCAN_MODE_BALANCED	Perform Bluetooth LE scan in balanced power mode.
int	SCAN_MODE_LOW_LATENCY	Scan using highest duty cycle.
int	SCAN_MODE_LOW_POWER	Perform Bluetooth LE scan in low power mode.

[Expand]

Inherited Constants

From interface android.os.Parcelable

Fields
public static final Creator<ScanSettings>	CREATOR

Public Methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable's marshalled representation.
int	getCallbackType()
long	getReportDelayMillis() Returns report delay timestamp based on the device clock.
int	getScanMode()
int	getScanResultType()
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.os.Parcelable

Constants

public static final int CALLBACK_TYPE_ALL_MATCHES

Added in API level 21

Trigger a callback for every Bluetooth advertisement found that matches the filter criteria. If no filter is active, all advertisement packets are reported.

Constant Value: 1 (0x00000001)

public static final int SCAN_MODE_BALANCED

Added in API level 21

Perform Bluetooth LE scan in balanced power mode. Scan results are returned at a rate that provides a good trade-off between scan frequency and power consumption.

Constant Value: 1 (0x00000001)

public static final int SCAN_MODE_LOW_LATENCY

Added in API level 21

Scan using highest duty cycle. It's recommended to only use this mode when the application is running in the foreground.

Constant Value: 2 (0x00000002)

public static final int SCAN_MODE_LOW_POWER

Added in API level 21

Perform Bluetooth LE scan in low power mode. This is the default scan mode as it consumes the least power.

Constant Value: 0 (0x00000000)

Fields

public static final Creator<ScanSettings> CREATOR

Added in API level 21

Public Methods

public int describeContents ()

Added in API level 21

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns

a bitmask indicating the set of special object types marshalled by the Parcelable.

public int getCallbackType ()

Added in API level 21

public long getReportDelayMillis ()

Added in API level 21

Returns report delay timestamp based on the device clock.

Flatten this object in to a Parcel.

Parameters

dest	The Parcel in which the object should be written.
flags	Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`.

Results

Classes

ScanSettings

Class Overview

Summary

Constants

public static final int CALLBACK_TYPE_ALL_MATCHES

public static final int SCAN_MODE_BALANCED

public static final int SCAN_MODE_LOW_LATENCY

public static final int SCAN_MODE_LOW_POWER

Fields

public static final Creator<ScanSettings> CREATOR

Public Methods

public int describeContents ()

Returns

public int getCallbackType ()

public long getReportDelayMillis ()

public int getScanMode ()

public int getScanResultType ()

public void writeToParcel (Parcel dest, int flags)

Parameters