client-core-android/no.nordicsemi.kotlin.ble.client.android/CentralManager/ScanOptions

ScanOptions

data class ScanOptions(val mode: ScanMode = ScanMode.LOW_LATENCY, val passive: Boolean = false, val legacyOnly: Boolean = false, val phy: PrimaryPhy? = null)

Android-specific scan options.

Constructors

ScanOptions

constructor(mode: ScanMode = ScanMode.LOW_LATENCY, passive: Boolean = false, legacyOnly: Boolean = false, phy: PrimaryPhy? = null)

Types

Companion

object Companion

Properties

legacyOnly

val legacyOnly: Boolean

Whether to report only legacy advertisements. By default, extended advertisements are reported as well, if the phone supports them (Android 8+).

mode

val mode: ScanMode

The scan mode, which trades scanning latency for power consumption. Ignored before Android 5.

passive

val passive: Boolean

Whether to scan passively. A passive scan doesn't send scan requests, so it doesn't get scan responses, which often contain the device name. In return, it uses less power and radio traffic. Available from Android 16 QPR2, ignored on older versions.

phy

val phy: PrimaryPhy?

The primary PHY to scan on, or null to scan on all PHYs supported by the phone. Scanning on LE Coded requires Android 8 and a phone that supports it, otherwise the scan fails to start with ScanningFailedToStartException. Ignored when legacyOnly is set, as legacy advertisements are always sent on LE 1M.