Device Enumeration

enum Device : Enum<Device>

The camera a page was captured with, so the engine can compensate for that hardware’s known characteristics.

Set through ScanningSdkLibrary.DEVICE in a page’s metadata. Leave it unset. The SDK does not set the key itself, and with no value the engine applies no hardware-specific compensation, which is the intended behaviour on Android today.

The other 28 entries name individual iPhone and iPad models. They exist because the engine is shared with the iOS SDK, which identifies capture hardware by model; they describe iOS hardware and have no meaning for a page captured on Android.

Entries

UNKNOWN

UNKNOWN

No specific device: the engine applies no hardware-specific compensation.

ANDROID

ANDROID

An Android device, without naming the model.

Properties

entries

val entries: EnumEntries<Device>

Returns a representation of an immutable list of all enum entries, in the order they’re declared.

name

val name: String

ordinal

val ordinal: Int

Functions

toInt

fun toInt(): Int

Returns the integer form used in a page’s metadata bundle.

valueOf

fun valueOf(value: String): Device

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.)

values

fun values(): Array<Device>

Returns an array containing the constants of this enum type, in the order they’re declared.