com.reelyactive.blesdk.support.ble

Class ScanSettings

java.lang.Object

com.reelyactive.blesdk.support.ble.ScanSettings

All Implemented Interfaces:

android.os.Parcelable

public final class ScanSettings
extends java.lang.Object
implements android.os.Parcelable

Bluetooth LE scan settings are passed to BluetoothLeScannerCompat.startScan(com.reelyactive.blesdk.support.ble.ScanCallback) to define the parameters for the scan.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScanSettings.Builder Builder for ScanSettings.

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static int	CALLBACK_TYPE_ALL_MATCHES Trigger a callback for every Bluetooth advertisement found that matches the filter criteria.
static int	CALLBACK_TYPE_FIRST_MATCH A result callback is only triggered for the first advertisement packet received that matches the filter criteria.
static int	CALLBACK_TYPE_MATCH_LOST Receive a callback when advertisements are no longer received from a device that has been previously reported by a first match callback.
static android.os.Parcelable.Creator<ScanSettings>	CREATOR
static int	SCAN_MODE_BALANCED Perform Bluetooth LE scan in balanced power mode.
static int	SCAN_MODE_LOW_LATENCY Scan using highest duty cycle.
static int	SCAN_MODE_LOW_POWER Perform Bluetooth LE scan in low power mode.
static int	SCAN_RESULT_TYPE_ABBREVIATED Request abbreviated scan results which contain the device, rssi and scan timestamp.
static int	SCAN_RESULT_TYPE_FULL Request full scan results which contain the device, rssi, advertising data, scan response as well as the scan timestamp.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
int	describeContents()
int	getCallbackType()
long	getReportDelayMillis() Returns report delay timestamp based on the device clock.
int	getScanMode()
int	getScanResultType()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCAN_MODE_LOW_POWER

public static final int SCAN_MODE_LOW_POWER

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

See Also:

Constant Field Values

SCAN_MODE_BALANCED

public static final int SCAN_MODE_BALANCED

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.

See Also:

Constant Field Values

SCAN_MODE_LOW_LATENCY

public static final int SCAN_MODE_LOW_LATENCY

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

See Also:

Constant Field Values

CALLBACK_TYPE_ALL_MATCHES

public static final int CALLBACK_TYPE_ALL_MATCHES

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

See Also:

Constant Field Values

CALLBACK_TYPE_FIRST_MATCH

public static final int CALLBACK_TYPE_FIRST_MATCH

A result callback is only triggered for the first advertisement packet received that matches the filter criteria.

See Also:

Constant Field Values

CALLBACK_TYPE_MATCH_LOST

public static final int CALLBACK_TYPE_MATCH_LOST

Receive a callback when advertisements are no longer received from a device that has been previously reported by a first match callback.

See Also:

Constant Field Values

SCAN_RESULT_TYPE_FULL

public static final int SCAN_RESULT_TYPE_FULL

Request full scan results which contain the device, rssi, advertising data, scan response as well as the scan timestamp.

See Also:

Constant Field Values

SCAN_RESULT_TYPE_ABBREVIATED

public static final int SCAN_RESULT_TYPE_ABBREVIATED

Request abbreviated scan results which contain the device, rssi and scan timestamp.

Note: It is possible for an application to get more scan results than it asked for, if there are multiple apps using this type.

See Also:

Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<ScanSettings> CREATOR

Method Detail

getScanMode

public int getScanMode()

getCallbackType

public int getCallbackType()

getScanResultType

public int getScanResultType()

getReportDelayMillis

public long getReportDelayMillis()

Returns report delay timestamp based on the device clock.

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                 int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable