kiteqr/io.github.yuroyami.kiteqr.aztec.encoder/Encoder/encode

encode

fun encode(data: String): AztecCode

Encodes the given string content as an Aztec symbol (without ECI code)

Return

Aztec symbol matrix with metadata

Parameters

data

input data string; must be encodable as ISO/IEC 8859-1 (Latin-1)

fun encode(data: String, minECCPercent: Int, userSpecifiedLayers: Int): AztecCode

Encodes the given string content as an Aztec symbol (without ECI code)

Return

Aztec symbol matrix with metadata

Parameters

data

input data string; must be encodable as ISO/IEC 8859-1 (Latin-1)

minECCPercent

minimal percentage of error check words (According to ISO/IEC 24778:2008, a minimum of 23% + 3 words is recommended)

userSpecifiedLayers

if non-zero, a user-specified value for the number of layers

fun encode(data: String, minECCPercent: Int, userSpecifiedLayers: Int, charset: KiteCharset?): AztecCode

Encodes the given string content as an Aztec symbol

Return

Aztec symbol matrix with metadata

Parameters

data

input data string

minECCPercent

minimal percentage of error check words (According to ISO/IEC 24778:2008, a minimum of 23% + 3 words is recommended)

userSpecifiedLayers

if non-zero, a user-specified value for the number of layers

charset

character set in which to encode string using ECI; if null, no ECI code will be inserted, and the string must be encodable as ISO/IEC 8859-1 (Latin-1), the default encoding of the symbol.

fun encode(data: ByteArray): AztecCode

Encodes the given binary content as an Aztec symbol (without ECI code)

Return

Aztec symbol matrix with metadata

Parameters

data

input data string

fun encode(data: ByteArray, minECCPercent: Int, userSpecifiedLayers: Int): AztecCode

Encodes the given binary content as an Aztec symbol (without ECI code)

Return

Aztec symbol matrix with metadata

Parameters

data

input data string

minECCPercent

minimal percentage of error check words (According to ISO/IEC 24778:2008, a minimum of 23% + 3 words is recommended)

userSpecifiedLayers

if non-zero, a user-specified value for the number of layers

fun encode(data: ByteArray, minECCPercent: Int, userSpecifiedLayers: Int, charset: KiteCharset?): AztecCode

Encodes the given binary content as an Aztec symbol

Return

Aztec symbol matrix with metadata

Parameters

data

input data string

minECCPercent

minimal percentage of error check words (According to ISO/IEC 24778:2008, a minimum of 23% + 3 words is recommended)

userSpecifiedLayers

if non-zero, a user-specified value for the number of layers

charset

character set to mark using ECI; if null, no ECI code will be inserted, and the default encoding of ISO/IEC 8859-1 will be assuming by readers.