jchucomponents-qr/com.jeluchu.qr

Package-level declarations

Types

BarcodeFormat

enum BarcodeFormat : Enum<BarcodeFormat>

Enumerates barcode formats known to this package. Please keep alphabetized.

Binarizer

abstract class Binarizer

BinaryBitmap

class BinaryBitmap(binarizer: Binarizer?)

ChecksumException

class ChecksumException : ReaderException

DecodeHintType

enum DecodeHintType : Enum<DecodeHintType>

Encapsulates a type of hint that a caller may pass to a barcode reader to help it more quickly or accurately decode it. It is up to implementations to decide what, if anything, to do with the information that is supplied.

Dimension

class Dimension(width: Int, height: Int)

Simply encapsulates a width and height.

EncodeHintType

enum EncodeHintType : Enum<EncodeHintType>

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

FormatException

class FormatException : ReaderException

InvertedLuminanceSource

class InvertedLuminanceSource(delegate: LuminanceSource?) : LuminanceSource

LuminanceSource

abstract class LuminanceSource

The purpose of this class hierarchy is to abstract different bitmap implementations across platforms into a standard interface for requesting greyscale luminance values. The interface only provides immutable methods; therefore crop and rotation create copies. This is to ensure that one Reader does not modify the original luminance source and leave it in an unknown state for other Readers in the chain.

NotFoundException

object NotFoundException : ReaderException

Reader

interface Reader

Implementations of this interface can decode an image of a barcode in some format into the String it encodes. For example, com.jeluchu.jchucomponents.utils.zxing.qrcode.QRCodeReader can decode a QR code. The decoder may optionally receive hints from the caller which may help it decode more quickly or accurately.

ReaderException

abstract class ReaderException : Exception

Result

class Result(val text: String, val rawBytes: ByteArray?, val numBits: Int, var resultPoints: Array<ResultPoint?>, val barcodeFormat: BarcodeFormat?, val timestamp: Long)

ResultMetadataType

enum ResultMetadataType : Enum<ResultMetadataType>

ResultPoint

open class ResultPoint(val x: Float, val y: Float)

ResultPointCallback

interface ResultPointCallback

Callback which is invoked when a possible result point (significant point in the barcode image such as a corner) is found.

WriterException

class WriterException : Exception

Functions

generateQr

fun Activity.generateQr(@DrawableRes icon: Int, key: String?, width: Int? = 768, height: Int? = 768): Bitmap?

fun Context.generateQr(@DrawableRes icon: Int, key: String?, width: Int? = 768, height: Int? = 768): Bitmap?