com.idevicesinc.sweetblue

Enum BleScanPower

java.lang.Object

java.lang.Enum<BleScanPower>

com.idevicesinc.sweetblue.BleScanPower

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BleScanPower>

public enum BleScanPower
extends java.lang.Enum<BleScanPower>

Type-safe parallel of various static final int members of ScanSettings for setting the scanning power when using the Lollipop scanning API. This is ONLY valid on devices running Lollipop, or higher.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO SweetBlue will automatically set the scan power depending on if the app is in the foreground or not.
HIGH_POWER Lollipop-and-up-relevant-only, this is strict typing for ScanSettings.SCAN_MODE_LOW_LATENCY.
LOW_POWER Lollipop-and-up-relevant-only, this is strict typing for ScanSettings.SCAN_MODE_LOW_POWER.
MEDIUM_POWER Lollipop-and-up-relevant-only, this is strict typing for ScanSettings.SCAN_MODE_BALANCED.
VERY_LOW_POWER Lollipop-and-up-relevant-only, this is strict typing for ScanSettings.SCAN_MODE_OPPORTUNISTIC.

Method Summary

Modifier and Type	Method and Description
int	getNativeMode()
static BleScanPower	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BleScanPower[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTO

public static final BleScanPower AUTO

SweetBlue will automatically set the scan power depending on if the app is in the foreground or not. When foregrounded, and running a periodic, or limited scan, HIGH_POWER will be used. If you are using an infinite scan length, then MEDIUM_POWER will be used instead. Otherwise, when in the background, LOW_POWER is used.

VERY_LOW_POWER

public static final BleScanPower VERY_LOW_POWER

Lollipop-and-up-relevant-only, this is strict typing for ScanSettings.SCAN_MODE_OPPORTUNISTIC. For phones lower than Lollipop, this will be ignored.

LOW_POWER

public static final BleScanPower LOW_POWER

Lollipop-and-up-relevant-only, this is strict typing for ScanSettings.SCAN_MODE_LOW_POWER. For phones lower than Lollipop, this will be ignored.

MEDIUM_POWER

public static final BleScanPower MEDIUM_POWER

Lollipop-and-up-relevant-only, this is strict typing for ScanSettings.SCAN_MODE_BALANCED. For phones lower than Lollipop, this will be ignored.

HIGH_POWER

public static final BleScanPower HIGH_POWER

Lollipop-and-up-relevant-only, this is strict typing for ScanSettings.SCAN_MODE_LOW_LATENCY. For phones lower than Lollipop, this will be ignored.

Method Detail

values

public static BleScanPower[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BleScanPower c : BleScanPower.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BleScanPower valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getNativeMode

public int getNativeMode()