public
final
class
ScanSettings
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.bluetooth.le.ScanSettings |
Bluetooth LE scan settings are passed to startScan(ScanCallback) to define the
parameters for the scan.
Nested classes | |
|---|---|
class |
ScanSettings.Builder
Builder for |
Constants | |
|---|---|
int |
CALLBACK_TYPE_ALL_MATCHES
Trigger a callback for every Bluetooth advertisement found that matches the filter criteria. |
int |
CALLBACK_TYPE_FIRST_MATCH
A result callback is only triggered for the first advertisement packet received that matches the filter criteria. |
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. |
int |
MATCH_MODE_AGGRESSIVE
In Aggressive mode, hw will determine a match sooner even with feeble signal strength and few number of sightings/match in a duration. |
int |
MATCH_MODE_STICKY
For sticky mode, higher threshold of signal strength and sightings is required before reporting by hw |
int |
MATCH_NUM_FEW_ADVERTISEMENT
Match few advertisement per filter, depends on current capability and availibility of the resources in hw |
int |
MATCH_NUM_MAX_ADVERTISEMENT
Match as many advertisement per filter as hw could allow, depends on current capability and availibility of the resources in hw |
int |
MATCH_NUM_ONE_ADVERTISEMENT
Match one advertisement per filter |
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. |
int |
SCAN_MODE_OPPORTUNISTIC
A special Bluetooth LE scan mode. |
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 instance's marshaled 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. |
Inherited methods | |
|---|---|
From
class
java.lang.Object
| |
From
interface
android.os.Parcelable
| |
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.
Constant Value: 1 (0x00000001)
int CALLBACK_TYPE_FIRST_MATCH
A result callback is only triggered for the first advertisement packet received that matches the filter criteria.
Constant Value: 2 (0x00000002)
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.
Constant Value: 4 (0x00000004)
int MATCH_MODE_AGGRESSIVE
In Aggressive mode, hw will determine a match sooner even with feeble signal strength and few number of sightings/match in a duration.
Constant Value: 1 (0x00000001)
int MATCH_MODE_STICKY
For sticky mode, higher threshold of signal strength and sightings is required before reporting by hw
Constant Value: 2 (0x00000002)
int MATCH_NUM_FEW_ADVERTISEMENT
Match few advertisement per filter, depends on current capability and availibility of the resources in hw
Constant Value: 2 (0x00000002)
int MATCH_NUM_MAX_ADVERTISEMENT
Match as many advertisement per filter as hw could allow, depends on current capability and availibility of the resources in hw
Constant Value: 3 (0x00000003)
int MATCH_NUM_ONE_ADVERTISEMENT
Match one advertisement per filter
Constant Value: 1 (0x00000001)
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.
Constant Value: 1 (0x00000001)
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.
Constant Value: 2 (0x00000002)
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.
Constant Value: 0 (0x00000000)
int SCAN_MODE_OPPORTUNISTIC
A special Bluetooth LE scan mode. Applications using this scan mode will passively listen for other scan results without starting BLE scans themselves.
Constant Value: -1 (0xffffffff)
int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(Parcel, int),
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR bit.
| Returns | |
|---|---|
int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. |
long getReportDelayMillis ()
Returns report delay timestamp based on the device clock.
| Returns | |
|---|---|
long |
|
void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel:
The Parcel in which the object should be written. |
flags |
int:
Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
|
Developers