com.kontakt.sdk.android.ble.configuration.scan

Enum ScanMode

java.lang.Object

java.lang.Enum<ScanMode>

com.kontakt.sdk.android.ble.configuration.scan.ScanMode

All Implemented Interfaces:

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

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

ScanMode constants.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BALANCED Perform Bluetooth LE scan in balanced power mode.
LOW_LATENCY Scan using highest duty cycle.
LOW_POWER Perform Bluetooth LE scan in low power mode.

Method Summary

Modifier and Type	Method and Description
int	getCode()
static ScanMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScanMode[]	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

LOW_POWER

public static final ScanMode LOW_POWER

Perform Bluetooth LE scan in low power mode. This is the default scan mode as it consumes the least power.

BALANCED

public static final ScanMode 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.

LOW_LATENCY

public static final ScanMode LOW_LATENCY

Scan using highest duty cycle. It's recommended to only use this mode when the application is running in the foreground.

Method Detail

values

public static ScanMode[] 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 (ScanMode c : ScanMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ScanMode 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

getCode

public int getCode()