ScanSettings (Android Bluetooth LE Scanner Compat library)

java.lang.Object
- no.nordicsemi.android.support.v18.scanner.ScanSettings

All Implemented Interfaces:

android.os.Parcelable
```
public final class ScanSettings
extends Object
implements android.os.Parcelable
```
Bluetooth LE scan settings are passed to BluetoothLeScannerCompat.startScan(no.nordicsemi.android.support.v18.scanner.ScanCallback) to define the parameters for the scan.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ScanSettings.Builder
Builder for ScanSettings.
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`ScanSettings.Builder` Builder for `ScanSettings`.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CALLBACK_TYPE_ALL_MATCHES` Trigger a callback for every Bluetooth advertisement found that matches the filter criteria.
`static int`	`CALLBACK_TYPE_FIRST_MATCH` A result callback is only triggered for the first advertisement packet received that matches the filter criteria.
`static 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.
`static android.os.Parcelable.Creator<ScanSettings>`	`CREATOR`
`static long`	`MATCH_LOST_DEVICE_TIMEOUT_DEFAULT` The default value of the maximum time for the device not to be discoverable before it will be assumed lost.
`static long`	`MATCH_LOST_TASK_INTERVAL_DEFAULT` The default interval of the task that calls match lost events.
`static 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.
`static int`	`MATCH_MODE_STICKY` For sticky mode, higher threshold of signal strength and sightings is required before reporting by hw
`static int`	`MATCH_NUM_FEW_ADVERTISEMENT` Match few advertisement per filter, depends on current capability and availability of the resources in hw
`static int`	`MATCH_NUM_MAX_ADVERTISEMENT` Match as many advertisement per filter as hw could allow, depends on current capability and availability of the resources in hw
`static int`	`MATCH_NUM_ONE_ADVERTISEMENT` Match one advertisement per filter
`static int`	`PHY_LE_ALL_SUPPORTED` Use all supported PHYs for scanning.
`static int`	`SCAN_MODE_BALANCED` Perform Bluetooth LE scan in balanced power mode.
`static int`	`SCAN_MODE_LOW_LATENCY` Scan using highest duty cycle.
`static int`	`SCAN_MODE_LOW_POWER` Perform Bluetooth LE scan in low power mode.
`static int`	`SCAN_MODE_OPPORTUNISTIC` A special Bluetooth LE scan mode.

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`describeContents()`
`int`	`getCallbackType()`
`boolean`	`getLegacy()` Returns whether only legacy advertisements will be returned.
`long`	`getMatchLostDeviceTimeout()`
`long`	`getMatchLostTaskInterval()`
`int`	`getMatchMode()`
`int`	`getNumOfMatches()`
`int`	`getPhy()` Returns the physical layer used during a scan.
`long`	`getPowerSaveRest()`
`long`	`getPowerSaveScan()`
`long`	`getReportDelayMillis()` Returns report delay timestamp based on the device clock.
`int`	`getScanMode()`
`boolean`	`getUseHardwareBatchingIfSupported()`
`boolean`	`getUseHardwareCallbackTypesIfSupported()`
`boolean`	`getUseHardwareFilteringIfSupported()`
`boolean`	`hasPowerSaveMode()` Determine if we should do power-saving sleep on pre-Lollipop
`void`	`writeToParcel(android.os.Parcel dest, int flags)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MATCH_LOST_DEVICE_TIMEOUT_DEFAULT
```
public static final long MATCH_LOST_DEVICE_TIMEOUT_DEFAULT
```
    The default value of the maximum time for the device not to be discoverable before it will be assumed lost.
    
    See Also:
    
    Constant Field Values
  - MATCH_LOST_TASK_INTERVAL_DEFAULT
```
public static final long MATCH_LOST_TASK_INTERVAL_DEFAULT
```
    The default interval of the task that calls match lost events.
    
    See Also:
    
    Constant Field Values
  - SCAN_MODE_OPPORTUNISTIC
```
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.
    On Android Lollipop SCAN_MODE_LOW_POWER will be used instead, as opportunistic mode was not yet supported.
    On pre-Lollipop devices it is possible to override the default intervals using ScanSettings.Builder.setPowerSave(long, long).
    
    See Also:
    
    Constant Field Values
  - SCAN_MODE_LOW_POWER
```
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.
    On pre-Lollipop devices this mode will be emulated by scanning for 0.5 second followed by 4.5 second of idle, which corresponds to the low power intervals on Lollipop or newer.
    
    See Also:
    
    Constant Field Values
  - SCAN_MODE_BALANCED
```
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.
    On pre-Lollipop devices this mode will be emulated by scanning for 2 second followed by 3 seconds of idle, which corresponds to the low power intervals on Lollipop or newer.
    
    See Also:
    
    Constant Field Values
  - SCAN_MODE_LOW_LATENCY
```
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.
    
    See Also:
    
    Constant Field Values
  - CALLBACK_TYPE_ALL_MATCHES
```
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.
    
    See Also:
    
    Constant Field Values
  - CALLBACK_TYPE_FIRST_MATCH
```
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.
    
    See Also:
    
    Constant Field Values
  - CALLBACK_TYPE_MATCH_LOST
```
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.
    
    See Also:
    
    Constant Field Values
  - MATCH_NUM_ONE_ADVERTISEMENT
```
public static final int MATCH_NUM_ONE_ADVERTISEMENT
```
    Match one advertisement per filter
    
    See Also:
    
    Constant Field Values
  - MATCH_NUM_FEW_ADVERTISEMENT
```
public static final int MATCH_NUM_FEW_ADVERTISEMENT
```
    Match few advertisement per filter, depends on current capability and availability of the resources in hw
    
    See Also:
    
    Constant Field Values
  - MATCH_NUM_MAX_ADVERTISEMENT
```
public static final int MATCH_NUM_MAX_ADVERTISEMENT
```
    Match as many advertisement per filter as hw could allow, depends on current capability and availability of the resources in hw
    
    See Also:
    
    Constant Field Values
  - MATCH_MODE_AGGRESSIVE
```
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.
    
    See Also:
    
    Constant Field Values
  - MATCH_MODE_STICKY
```
public static final int MATCH_MODE_STICKY
```
    For sticky mode, higher threshold of signal strength and sightings is required before reporting by hw
    
    See Also:
    
    Constant Field Values
  - PHY_LE_ALL_SUPPORTED
```
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.
    
    See Also:
    
    Constant Field Values
  - CREATOR
```
public static final android.os.Parcelable.Creator<ScanSettings> CREATOR
```
- Method Detail
  - getScanMode
```
public int getScanMode()
```
  - getCallbackType
```
public int getCallbackType()
```
  - getMatchMode
```
public int getMatchMode()
```
  - getNumOfMatches
```
public int getNumOfMatches()
```
  - getUseHardwareFilteringIfSupported
```
public boolean getUseHardwareFilteringIfSupported()
```
  - getUseHardwareBatchingIfSupported
```
public boolean getUseHardwareBatchingIfSupported()
```
  - getUseHardwareCallbackTypesIfSupported
```
public boolean getUseHardwareCallbackTypesIfSupported()
```
  - getMatchLostDeviceTimeout
```
public long getMatchLostDeviceTimeout()
```
  - getMatchLostTaskInterval
```
public long getMatchLostTaskInterval()
```
  - getLegacy
```
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.
  - getPhy
```
public int getPhy()
```
    Returns the physical layer used during a scan.
  - getReportDelayMillis
```
public long getReportDelayMillis()
```
    Returns report delay timestamp based on the device clock.
  - writeToParcel
```
public void writeToParcel(android.os.Parcel dest,
                          int flags)
```
    Specified by:
    
    writeToParcel in interface android.os.Parcelable
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface android.os.Parcelable
  - hasPowerSaveMode
```
public boolean hasPowerSaveMode()
```
    Determine if we should do power-saving sleep on pre-Lollipop
  - getPowerSaveRest
```
public long getPowerSaveRest()
```
  - getPowerSaveScan
```
public long getPowerSaveScan()
```

Class ScanSettings

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MATCH_LOST_DEVICE_TIMEOUT_DEFAULT

MATCH_LOST_TASK_INTERVAL_DEFAULT

SCAN_MODE_OPPORTUNISTIC

SCAN_MODE_LOW_POWER

SCAN_MODE_BALANCED

SCAN_MODE_LOW_LATENCY

CALLBACK_TYPE_ALL_MATCHES

CALLBACK_TYPE_FIRST_MATCH

CALLBACK_TYPE_MATCH_LOST

MATCH_NUM_ONE_ADVERTISEMENT

MATCH_NUM_FEW_ADVERTISEMENT

MATCH_NUM_MAX_ADVERTISEMENT

MATCH_MODE_AGGRESSIVE

MATCH_MODE_STICKY

PHY_LE_ALL_SUPPORTED

CREATOR

Method Detail

getScanMode

getCallbackType

getMatchMode

getNumOfMatches

getUseHardwareFilteringIfSupported

getUseHardwareBatchingIfSupported

getUseHardwareCallbackTypesIfSupported

getMatchLostDeviceTimeout

getMatchLostTaskInterval

getLegacy

getPhy

getReportDelayMillis

writeToParcel

describeContents

hasPowerSaveMode

getPowerSaveRest

getPowerSaveScan