FlashMode Enumeration

enum FlashMode : Enum<FlashMode>

Whether the flash fired when a page was captured, which tells the engine to expect glare and uneven lighting.

Read from the photo’s EXIF data on import, and carried in a page’s metadata.

Entries

UNDEFINED

UNDEFINED

The photo carries no flash information.

NOT_FIRED

NOT_FIRED

The flash did not fire.

FIRED

FIRED

The flash fired, so expect glare and uneven lighting.

Properties

entries

val entries: EnumEntries<FlashMode>

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): FlashMode

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<FlashMode>

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