ScanResult
class ScanResult
Represents a scan result for Bluetooth LE scan.
The ScanResult class is used by Bluetooth LE applications to scan for and discover Bluetooth LE devices. When a Bluetooth LE application scans for devices, it will receive a list of ScanResult objects that contain information about the scanned devices. The application can then use this information to determine which devices it wants to connect to.
Summary
Constants |
|
|---|---|
const Int |
Periodic advertising interval is not present in the packet. |
Public functions |
|
|---|---|
ByteArray? |
getManufacturerSpecificData(manufacturerId: Int)Returns the manufacturer specific data associated with the manufacturer id. |
ByteArray? |
getServiceData(serviceUuid: UUID)Returns the service data associated with the service UUID. |
Boolean |
Checks if this object represents a connectable scan result. |
Public properties |
|
|---|---|
BluetoothDevice |
Remote Bluetooth device found. |
BluetoothAddress |
Bluetooth address for the remote device found. |
Long |
Returns the periodic advertising interval in milliseconds ranging from 7.5ms to 81918.75ms A value of |
Int |
Returns the received signal strength in dBm. |
Map<ParcelUuid, ByteArray> |
Returns a map of service UUID and its corresponding service data. |
List<ParcelUuid> |
Returns a list of service solicitation UUIDs within the advertisement that are used to identify the Bluetooth GATT services. |
List<UUID> |
A list of service UUIDs within advertisement that are used to identify the bluetooth GATT services. |
Long |
Device timestamp when the advertisement was last seen. |
Constants
PERIODIC_INTERVAL_NOT_PRESENT
const val PERIODIC_INTERVAL_NOT_PRESENT: Int
Periodic advertising interval is not present in the packet.
Public functions
getManufacturerSpecificData
fun getManufacturerSpecificData(manufacturerId: Int): ByteArray?
Returns the manufacturer specific data associated with the manufacturer id.
| Parameters | |
|---|---|
manufacturerId: Int |
The manufacturer id of the scanned device |
| Returns | |
|---|---|
ByteArray? |
the manufacturer specific data associated with the manufacturer id, or @{code null} if the manufacturer specific data is not present |
getServiceData
fun getServiceData(serviceUuid: UUID): ByteArray?
Returns the service data associated with the service UUID.
| Parameters | |
|---|---|
serviceUuid: UUID |
The service UUID of the service data |
| Returns | |
|---|---|
ByteArray? |
the service data associated with the specified service UUID, or |
isConnectable
fun isConnectable(): Boolean
Checks if this object represents a connectable scan result.
| Returns | |
|---|---|
Boolean |
{@code true} if the scanned device is connectable. Please note that this will return {@code true} on versions before |
Public properties
deviceAddress
val deviceAddress: BluetoothAddress
Bluetooth address for the remote device found.
periodicAdvertisingInterval
val periodicAdvertisingInterval: Long
Returns the periodic advertising interval in milliseconds ranging from 7.5ms to 81918.75ms A value of PERIODIC_INTERVAL_NOT_PRESENT means periodic advertising interval is not present.
Please note that this will return PERIODIC_INTERVAL_NOT_PRESENT on versions before android.os.Build.VERSION_CODES.Q.
rssi
val rssi: Int
Returns the received signal strength in dBm. The valid range is -127, 126.
serviceData
val serviceData: Map<ParcelUuid, ByteArray>
Returns a map of service UUID and its corresponding service data.
serviceSolicitationUuids
val serviceSolicitationUuids: List<ParcelUuid>
Returns a list of service solicitation UUIDs within the advertisement that are used to identify the Bluetooth GATT services.
Please note that this will return an emptyList() on versions before android.os.Build.VERSION_CODES.Q.
serviceUuids
val serviceUuids: List<UUID>
A list of service UUIDs within advertisement that are used to identify the bluetooth GATT services.
timestampNanos
val timestampNanos: Long
Device timestamp when the advertisement was last seen.