ScanSettings (rxandroidble 1.10.1 API)

java.lang.Object
- com.polidea.rxandroidble2.scan.ScanSettings

All Implemented Interfaces:

android.os.Parcelable, ExternalScanSettingsExtension
```
public class ScanSettings
extends java.lang.Object
implements android.os.Parcelable, ExternalScanSettingsExtension
```
Bluetooth LE scan settings are passed to BluetoothLeScanner.startScan(android.bluetooth.le.ScanCallback) to define the parameters for the scan. RxAndroidBle Note: This class is basically copied from the Android AOSP. All of the exposed functionality is emulated by the software due to a lot of potential issues with different phones: https://code.google.com/p/android/issues/detail?id=158522 https://code.google.com/p/android/issues/detail?id=178614 https://code.google.com/p/android/issues/detail?id=228428

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ScanSettings.Builder` Builder for `ScanSettings`.
`static interface`	`ScanSettings.CallbackType`
`static interface`	`ScanSettings.MatchMode`
`static interface`	`ScanSettings.MatchNum`
`static interface`	`ScanSettings.ScanMode`

Nested classes/interfaces inherited from interface android.os.Parcelable
android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

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 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 availibility of the resources in hw
`static int`	`MATCH_NUM_ONE_ADVERTISEMENT` Match one advertisement per filter
`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()`
`int`	`getMatchMode()`
`int`	`getNumOfMatches()`
`long`	`getReportDelayMillis()` Returns report delay timestamp based on the device clock.
`int`	`getScanMode()`
`boolean`	`shouldCheckLocationProviderState()`
`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
  - 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.
    
    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.
    
    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.
    
    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 availibility 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
  - 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()
```
  - getReportDelayMillis
```
public long getReportDelayMillis()
```
    Returns report delay timestamp based on the device clock.
  - shouldCheckLocationProviderState
```
public boolean shouldCheckLocationProviderState()
```
    Specified by:
    
    shouldCheckLocationProviderState in interface ExternalScanSettingsExtension
  - 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

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

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

CREATOR

Method Detail

getScanMode

getCallbackType

getMatchMode

getNumOfMatches

getReportDelayMillis

shouldCheckLocationProviderState

writeToParcel

describeContents