EncodeHintType

These are a set of hints that you may pass to Writers to specify their behavior.

Entries

Link copied to clipboard

Specifies what degree of error correction to use, for example in QR Codes. Type depends on the encoder. For example for QR codes it's type ErrorCorrectionLevel. For Aztec it is an Int, representing the minimal percentage of error correction words. For PDF417 it is an Int; valid values are 0 to 8. In all cases, it can also be a String representation of the desired value as well. Note: an Aztec symbol should have a minimum of 25% EC words.

Link copied to clipboard

Specifies what character encoding to use where applicable (type String)

Link copied to clipboard

Specifies margin, in pixels, to use when generating the barcode. The meaning can vary by format; for example it controls margin before and after the barcode horizontally for most 1D formats. Accepts an Int or its String representation.

Link copied to clipboard

Specifies the exact version of QR code to be encoded. Accepts an Int or its String representation.

Link copied to clipboard

Specifies the QR code mask pattern to be used. Allowed values are 0..QRCode.NUM_MASK_PATTERNS-1. By default the code will automatically select the optimal mask pattern. Accepts an Int or its String representation.

Link copied to clipboard

Specifies whether the data should be encoded to the GS1 standard (type Boolean, or "true" or "false" String value).

Properties

Link copied to clipboard

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

Link copied to clipboard
expect val name: String
Link copied to clipboard
expect val ordinal: Int

Functions

Link copied to clipboard

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

Link copied to clipboard

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