# Print output for @column tags ?>
public
final
class
ScanSettings
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.bluetooth.le.ScanSettings |
Bluetooth LE scan settings are passed to BluetoothLeScanner#startScan
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 |
PHY_LE_ALL_SUPPORTED
Use all supported PHYs for scanning. |
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 |
---|
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()
|
boolean
|
getLegacy()
Returns whether only legacy advertisements will be returned. |
int
|
getPhy()
Returns the physical layer used during a scan. |
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 | |
---|---|
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.
Constant Value: 1 (0x00000001)
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.
Constant Value: 2 (0x00000002)
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.
Constant Value: 4 (0x00000004)
public static final 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)
public static final int MATCH_MODE_STICKY
For sticky mode, higher threshold of signal strength and sightings is required before reporting by hw
Constant Value: 2 (0x00000002)
public static final 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)
public static final 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)
public static final int MATCH_NUM_ONE_ADVERTISEMENT
Match one advertisement per filter
Constant Value: 1 (0x00000001)
public static final int PHY_LE_ALL_SUPPORTED
Use all supported PHYs for scanning. This will check the controller capabilities, and start the scan on 1Mbit and LE Coded PHYs if supported, or on the 1Mbit PHY only.
Constant Value: 255 (0x000000ff)
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.
Constant Value: 1 (0x00000001)
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.
Constant Value: 2 (0x00000002)
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. This mode is enforced if the scanning application is not in foreground.
Constant Value: 0 (0x00000000)
public static final 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)
public 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(android.os.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.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
public int getCallbackType ()
Returns | |
---|---|
int |
public boolean getLegacy ()
Returns whether only legacy advertisements will be returned. Legacy advertisements include advertisements as specified by the Bluetooth core specification 4.2 and below.
Returns | |
---|---|
boolean |
public int getPhy ()
Returns the physical layer used during a scan.
Returns | |
---|---|
int |
public long getReportDelayMillis ()
Returns report delay timestamp based on the device clock.
Returns | |
---|---|
long |
public int getScanMode ()
Returns | |
---|---|
int |
public int getScanResultType ()
Returns | |
---|---|
int |
public 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.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |