QRCode-Kotlin/qrcode.raw/ErrorCorrectionLevel

ErrorCorrectionLevel

enum ErrorCorrectionLevel : Enum<ErrorCorrectionLevel> (source)

The level of Error Correction to apply to the QR Code image. The Higher the Error Correction, the lower quality print the QRCode can be (think of "wow, even with the paper a bit crumpled, it still read the QR Code!" - that is likely a HIGH or VERY_HIGH error correction).

The trade-off is the amount of data you can encode. The higher the error correction level, the less amount of data you'll be able to encode.

Please consult Kazuhiko's Online Demo where at the time of writing a handy table showed how many bytes can be encoded given a data type (QRCodeDataType) and Error Correction Level.

This library automatically tries to fit ~2048 bytes into the QR Code regardless of error correction level. That is the reason and meaning of maxTypeNum.

Rewritten in Kotlin from the original (GitHub)

Author

Rafael Lins - g0dkar

Kazuhiko Arase - kazuhikoarase

Parameters

value

Value associated with this error correction level

maxTypeNum

Maximum type value which can fit 2048 bytes. Used to automatically calculate the type value.

Entries

Properties

entries

val entries: EnumEntries<ErrorCorrectionLevel>

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

val maxTypeNum: Int

val name: String

val ordinal: Int

val value: Int

Functions

valueOf

fun valueOf(value: String): ErrorCorrectionLevel

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

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