Skip to content

Most visited

Recently visited

navigation

ScanResult

public final class ScanResult
extends Object implements Parcelable

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


ScanResult for Bluetooth LE scan.

Summary

Constants

int DATA_COMPLETE

For chained advertisements, inidcates tha the data contained in this scan result is complete.

int DATA_TRUNCATED

For chained advertisements, indicates that the controller was unable to receive all chained packets and the scan result contains incomplete truncated data.

int PERIODIC_INTERVAL_NOT_PRESENT

Periodic advertising interval is not present in the packet.

int PHY_UNUSED

Indicates that the secondary physical layer was not used.

int SID_NOT_PRESENT

Advertising Set ID is not present in the packet.

int TX_POWER_NOT_PRESENT

TX power is not present in the packet.

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<ScanResult> CREATOR

Public constructors

ScanResult(BluetoothDevice device, ScanRecord scanRecord, int rssi, long timestampNanos)

This constructor was deprecated in API level O. use ScanResult(BluetoothDevice, int, int, int, int, int, int, int, ScanRecord, long)

ScanResult(BluetoothDevice device, int eventType, int primaryPhy, int secondaryPhy, int advertisingSid, int txPower, int rssi, int periodicAdvertisingInterval, ScanRecord scanRecord, long timestampNanos)

Constructs a new ScanResult.

Public methods

int describeContents()

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

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

int getAdvertisingSid()

Returns the advertising set id.

int getDataStatus()

Returns the data status.

BluetoothDevice getDevice()

Returns the remote Bluetooth device identified by the Bluetooth device address.

int getPeriodicAdvertisingInterval()

Returns the periodic advertising interval in units of 1.25ms.

int getPrimaryPhy()

Returns the primary Physical Layer on which this advertisment was received.

int getRssi()

Returns the received signal strength in dBm.

ScanRecord getScanRecord()

Returns the scan record, which is a combination of advertisement and scan response.

int getSecondaryPhy()

Returns the secondary Physical Layer on which this advertisment was received.

long getTimestampNanos()

Returns timestamp since boot when the scan record was observed.

int getTxPower()

Returns the transmit power in dBm.

int hashCode()

Returns a hash code value for the object.

boolean isConnectable()

Returns true if this object represents connectable scan result.

boolean isLegacy()

Returns true if this object represents legacy scan result.

String toString()

Returns a string representation of the object.

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

Constants

DATA_COMPLETE

int DATA_COMPLETE

For chained advertisements, inidcates tha the data contained in this scan result is complete.

Constant Value: 0 (0x00000000)

DATA_TRUNCATED

int DATA_TRUNCATED

For chained advertisements, indicates that the controller was unable to receive all chained packets and the scan result contains incomplete truncated data.

Constant Value: 2 (0x00000002)

PERIODIC_INTERVAL_NOT_PRESENT

int PERIODIC_INTERVAL_NOT_PRESENT

Periodic advertising interval is not present in the packet.

Constant Value: 0 (0x00000000)

PHY_UNUSED

int PHY_UNUSED

Indicates that the secondary physical layer was not used.

Constant Value: 0 (0x00000000)

SID_NOT_PRESENT

int SID_NOT_PRESENT

Advertising Set ID is not present in the packet.

Constant Value: 255 (0x000000ff)

TX_POWER_NOT_PRESENT

int TX_POWER_NOT_PRESENT

TX power is not present in the packet.

Constant Value: 127 (0x0000007f)

Fields

CREATOR

added in API level 21
Creator<ScanResult> CREATOR

Public constructors

ScanResult

added in API level 21
ScanResult (BluetoothDevice device, 
                ScanRecord scanRecord, 
                int rssi, 
                long timestampNanos)

This constructor was deprecated in API level O.
use ScanResult(BluetoothDevice, int, int, int, int, int, int, int, ScanRecord, long)

Constructs a new ScanResult.

Parameters
device BluetoothDevice: Remote Bluetooth device found.

scanRecord ScanRecord: Scan record including both advertising data and scan response data.

rssi int: Received signal strength.

timestampNanos long: Timestamp at which the scan result was observed.

ScanResult

ScanResult (BluetoothDevice device, 
                int eventType, 
                int primaryPhy, 
                int secondaryPhy, 
                int advertisingSid, 
                int txPower, 
                int rssi, 
                int periodicAdvertisingInterval, 
                ScanRecord scanRecord, 
                long timestampNanos)

Constructs a new ScanResult.

Parameters
device BluetoothDevice: Remote Bluetooth device found.

eventType int: Event type.

primaryPhy int: Primary advertising phy.

secondaryPhy int: Secondary advertising phy.

advertisingSid int: Advertising set ID.

txPower int: Transmit power.

rssi int: Received signal strength.

periodicAdvertisingInterval int: Periodic advertising interval.

scanRecord ScanRecord: Scan record including both advertising data and scan response data.

timestampNanos long: Timestamp at which the scan result was observed.

Public methods

describeContents

added in API level 21
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.

equals

added in API level 21
boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
obj Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getAdvertisingSid

int getAdvertisingSid ()

Returns the advertising set id. May return SID_NOT_PRESENT if no set id was is present.

Returns
int

getDataStatus

int getDataStatus ()

Returns the data status. Can be one of DATA_COMPLETE or DATA_TRUNCATED.

Returns
int

getDevice

added in API level 21
BluetoothDevice getDevice ()

Returns the remote Bluetooth device identified by the Bluetooth device address.

Returns
BluetoothDevice

getPeriodicAdvertisingInterval

int getPeriodicAdvertisingInterval ()

Returns the periodic advertising interval in units of 1.25ms. Valid range is 6 (7.5ms) to 65536 (81918.75ms). A value of PERIODIC_INTERVAL_NOT_PRESENT means periodic advertising interval is not present.

Returns
int

getPrimaryPhy

int getPrimaryPhy ()

Returns the primary Physical Layer on which this advertisment was received. Can be one of PHY_LE_1M or PHY_LE_CODED.

Returns
int

getRssi

added in API level 21
int getRssi ()

Returns the received signal strength in dBm. The valid range is [-127, 126].

Returns
int

getScanRecord

added in API level 21
ScanRecord getScanRecord ()

Returns the scan record, which is a combination of advertisement and scan response.

Returns
ScanRecord

This value may be null.

getSecondaryPhy

int getSecondaryPhy ()

Returns the secondary Physical Layer on which this advertisment was received. Can be one of PHY_LE_1M, PHY_LE_2M, PHY_LE_CODED or PHY_UNUSED - if the advertisement was not received on a secondary physical channel.

Returns
int

getTimestampNanos

added in API level 21
long getTimestampNanos ()

Returns timestamp since boot when the scan record was observed.

Returns
long

getTxPower

int getTxPower ()

Returns the transmit power in dBm. Valid range is [-127, 126]. A value of TX_POWER_NOT_PRESENT indicates that the TX power is not present.

Returns
int

hashCode

added in API level 21
int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

isConnectable

boolean isConnectable ()

Returns true if this object represents connectable scan result.

Returns
boolean

isLegacy

boolean isLegacy ()

Returns true if this object represents legacy scan result. Legacy scan results do not contain advanced advertising information as specified in the Bluetooth Core Specification v5.

Returns
boolean

toString

added in API level 21
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

added in API level 21
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.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.