Android Scanbot SDK API reference/io.scanbot.sdk.barcode

Package-level declarations

Types

enum AustraliaPostCustomerFormat : Enum<AustraliaPostCustomerFormat>

Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.

data class BarcodeAccumulationConfiguration(var minConfirmationsStandaloneEAN: Int = 1, var accumulationTime: Int = 500, var removeUnconnectedResults: Boolean = true, var method: BarcodeAccumulationMethod = BarcodeAccumulationMethod.INTERPOLATE_BY_CAMERA) : Parcelable

Configuration for how to accumulate results.

BarcodeAccumulationMethod

enum BarcodeAccumulationMethod : Enum<BarcodeAccumulationMethod>

The method how to display barcodes from previous frames.

BarcodeAutoSnappingController

class BarcodeAutoSnappingController(val cameraView: IScanbotCameraView, frameHandler: FrameHandler)

Controls auto-snapping process by observing document scanning results from BarcodeScannerFrameHandler.

BarcodeCounterFrameHandler

open class BarcodeCounterFrameHandler(barcodeScanner: BarcodeScanner) : FrameHandler

Performs barcode/QR code scanning on camera preview frames. Outputs results via BarcodeCounterFrameHandler.ResultHandler (addResultHandler).

BarcodeDocumentFormat

enum BarcodeDocumentFormat : Enum<BarcodeDocumentFormat>

Type of barcode document format used.

BarcodeDocumentFormats

class BarcodeDocumentFormats : Parcelable

Barcode document formats.

BarcodeEanUpcNoExtensionsFilter

class BarcodeEanUpcNoExtensionsFilter : BarcodeFilter

BarcodeExtensionsFilter

class BarcodeExtensionsFilter : BarcodeFilter

Subclass of BarcodeFilter that only accepts barcodes with extensions.

BarcodeFilter

open class BarcodeFilter : IBarcodeFilter

Basic implementation of IBarcodeFilter that accepts all barcodes except for duplicates.

BarcodeFormat

enum BarcodeFormat : Enum<BarcodeFormat>

Enumerates barcode formats.

BarcodeFormatAustraliaPostConfiguration

data class BarcodeFormatAustraliaPostConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var australiaPostCustomerFormat: AustraliaPostCustomerFormat = AustraliaPostCustomerFormat.ALPHA_NUMERIC) : BarcodeFormatFourStateConfigurationBase, Parcelable

Australia Post barcode configuration. Add to scanner configuration to scan Australia Post barcodes.

BarcodeFormatAztecConfiguration

data class BarcodeFormatAztecConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var gs1Handling: Gs1Handling = Gs1Handling.PARSE) : BarcodeFormatTwoDConfigurationBase, Parcelable

Aztec configuration. Add to scanner configuration to scan Aztec codes.

BarcodeFormatCodabarConfiguration

data class BarcodeFormatCodabarConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var minimumTextLength: Int = 1, var maximumTextLength: Int = 0, var returnStartEnd: Boolean = false) : BarcodeFormatOneDConfigurationBase, Parcelable

Codabar barcode configuration. Add to scanner configuration to scan Codabar barcodes.

BarcodeFormatCode11Configuration

data class BarcodeFormatCode11Configuration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var stripCheckDigits: Boolean = false, var minimumTextLength: Int = 1, var maximumTextLength: Int = 0, var checksum: Boolean = true) : BarcodeFormatOneDConfigurationBase, Parcelable

Code 11 barcode configuration. Add to scanner configuration to scan Code 11 barcodes.

BarcodeFormatCode128Configuration

data class BarcodeFormatCode128Configuration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var gs1Handling: Gs1Handling = Gs1Handling.PARSE, var minimumTextLength: Int = 1, var maximumTextLength: Int = 0) : BarcodeFormatOneDConfigurationBase, Parcelable

Code 128 barcode configuration. Add to scanner configuration to scan Code 128 barcodes.

BarcodeFormatCode2Of5Configuration

data class BarcodeFormatCode2Of5Configuration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var stripCheckDigits: Boolean = false, var minimumTextLength: Int = 1, var maximumTextLength: Int = 0, var iata2of5: Boolean = true, var code25: Boolean = false, var industrial2of5: Boolean = true, var useIATA2OF5Checksum: Boolean = true) : BarcodeFormatOneDConfigurationBase, Parcelable

Configuration for all 2-of-5 barcode types (except Interleaved 2-of-5, which is handled by ItfConfig). Add to scanner configuration to scan Code 25, IATA 2-of-5 and Industrial 2-of-5 barcodes.

BarcodeFormatCode39Configuration

data class BarcodeFormatCode39Configuration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var stripCheckDigits: Boolean = false, var minimumTextLength: Int = 1, var maximumTextLength: Int = 0, var code32: Boolean = false, var code39: Boolean = true, var pzn7: Boolean = true, var pzn8: Boolean = true, var tryCode39ExtendedMode: Boolean = false, var useCode39CheckDigit: Boolean = false) : BarcodeFormatOneDConfigurationBase, Parcelable

Code 39 barcode and derivatives configuration. Add to scanner configuration to scan Code 39, Code 32 (Italian Pharmacode), PZN7 and PZN8 (Pharmazentralnummer) barcodes.

BarcodeFormatCode93Configuration

data class BarcodeFormatCode93Configuration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var stripCheckDigits: Boolean = false, var minimumTextLength: Int = 1, var maximumTextLength: Int = 0) : BarcodeFormatOneDConfigurationBase, Parcelable

Code 93 barcode configuration. Add to scanner configuration to scan Code 93 barcodes.

BarcodeFormatCommonConfiguration

data class BarcodeFormatCommonConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var stripCheckDigits: Boolean = false, var minimumTextLength: Int = 1, var maximumTextLength: Int = 0, var gs1Handling: Gs1Handling = Gs1Handling.PARSE, var strictMode: Boolean = true, var formats: List<BarcodeFormat> = listOf( BarcodeFormat.AZTEC, BarcodeFormat.CODABAR, BarcodeFormat.CODE_39, BarcodeFormat.CODE_93, BarcodeFormat.CODE_128, BarcodeFormat.DATA_MATRIX, BarcodeFormat.DATABAR, BarcodeFormat.DATABAR_EXPANDED, BarcodeFormat.DATABAR_LIMITED, BarcodeFormat.EAN_13, BarcodeFormat.EAN_8, BarcodeFormat.ITF, BarcodeFormat.MICRO_QR_CODE, BarcodeFormat.PDF_417, BarcodeFormat.QR_CODE, BarcodeFormat.UPC_A, BarcodeFormat.UPC_E )) : BarcodeFormatConfigurationBase, Parcelable

Convenience configuration for enabling the scanning of multiple barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple barcodes.

BarcodeFormatCommonFourStateConfiguration

data class BarcodeFormatCommonFourStateConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var formats: List<BarcodeFormat> = listOf( BarcodeFormat.AUSTRALIA_POST, BarcodeFormat.JAPAN_POST, BarcodeFormat.ROYAL_MAIL, BarcodeFormat.ROYAL_TNT_POST, BarcodeFormat.USPS_INTELLIGENT_MAIL )) : BarcodeFormatConfigurationBase, Parcelable

Convenience configuration for enabling the scanning of multiple four-state barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple four-state codes.

BarcodeFormatCommonOneDConfiguration

data class BarcodeFormatCommonOneDConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var stripCheckDigits: Boolean = false, var minimumTextLength: Int = 1, var maximumTextLength: Int = 0, var gs1Handling: Gs1Handling = Gs1Handling.PARSE, var formats: List<BarcodeFormat> = listOf( BarcodeFormat.CODABAR, BarcodeFormat.CODE_11, BarcodeFormat.CODE_25, BarcodeFormat.CODE_32, BarcodeFormat.CODE_39, BarcodeFormat.CODE_93, BarcodeFormat.CODE_128, BarcodeFormat.DATABAR, BarcodeFormat.DATABAR_EXPANDED, BarcodeFormat.DATABAR_LIMITED, BarcodeFormat.EAN_8, BarcodeFormat.EAN_13, BarcodeFormat.IATA_2_OF_5, BarcodeFormat.INDUSTRIAL_2_OF_5, BarcodeFormat.ITF, BarcodeFormat.MSI_PLESSEY, BarcodeFormat.PHARMA_CODE, BarcodeFormat.PZN_7, BarcodeFormat.PZN_8, BarcodeFormat.UPC_A, BarcodeFormat.UPC_E )) : BarcodeFormatConfigurationBase, Parcelable

Convenience configuration for enabling the scanning of multiple linear (1D) barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple linear (1D) barcode formats.

BarcodeFormatCommonTwoDConfiguration

data class BarcodeFormatCommonTwoDConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var gs1Handling: Gs1Handling = Gs1Handling.PARSE, var strictMode: Boolean = true, var formats: List<BarcodeFormat> = listOf( BarcodeFormat.AZTEC, BarcodeFormat.DATA_MATRIX, BarcodeFormat.MAXI_CODE, BarcodeFormat.MICRO_QR_CODE, BarcodeFormat.MICRO_PDF_417, BarcodeFormat.PDF_417, BarcodeFormat.QR_CODE, BarcodeFormat.RMQR_CODE )) : BarcodeFormatConfigurationBase, Parcelable

Convenience configuration for enabling the scanning of multiple 2D codes with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple 2D codes.

BarcodeFormatConfigurationBase

sealed class BarcodeFormatConfigurationBase : Parcelable

Base class for all barcode configurations.

BarcodeFormatDataBarConfiguration

data class BarcodeFormatDataBarConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var gs1Handling: Gs1Handling = Gs1Handling.PARSE) : BarcodeFormatOneDConfigurationBase, Parcelable

GS1 DataBar barcode configuration. Add to scanner configuration to scan GS1 DataBar-14, GS1 DataBar-14 Truncated, GS1 DataBar-14 Stacked and GS1 DataBar-14 Stacked Omnidirectional barcodes.

BarcodeFormatDataBarExpandedConfiguration

data class BarcodeFormatDataBarExpandedConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var gs1Handling: Gs1Handling = Gs1Handling.PARSE) : BarcodeFormatOneDConfigurationBase, Parcelable

GS1 DataBar Expanded barcode configuration. Add to scanner configuration to scan GS1 DataBar Expanded and GS1 DataBar Expanded Stacked barcodes.

BarcodeFormatDataBarLimitedConfiguration

data class BarcodeFormatDataBarLimitedConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var gs1Handling: Gs1Handling = Gs1Handling.PARSE) : BarcodeFormatOneDConfigurationBase, Parcelable

GS1 DataBar Limited barcode configuration. Add to scanner configuration to scan GS1 DataBar Limited barcodes.

BarcodeFormatDataMatrixConfiguration

data class BarcodeFormatDataMatrixConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var gs1Handling: Gs1Handling = Gs1Handling.PARSE) : BarcodeFormatTwoDConfigurationBase, Parcelable

DataMatrix configuration. Add to scanner configuration to scan DataMatrix and DataMatrix rectangular extensions (DMRE) codes.

BarcodeFormatFourStateConfigurationBase

sealed class BarcodeFormatFourStateConfigurationBase : BarcodeFormatConfigurationBase, Parcelable

Base class for all four-state barcode configurations.

BarcodeFormatGs1CompositeConfiguration

data class BarcodeFormatGs1CompositeConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var gs1Handling: Gs1Handling = Gs1Handling.PARSE, var strictMode: Boolean = true) : BarcodeFormatConfigurationBase, Parcelable

GS1 Composite configuration. Add to scanner configuration to scan GS1 Composite barcodes.

BarcodeFormatItfConfiguration

data class BarcodeFormatItfConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var minimumTextLength: Int = 1, var maximumTextLength: Int = 0) : BarcodeFormatOneDConfigurationBase, Parcelable

ITF (Interleaved 2-of-5) barcode configuration. Add to scanner configuration to scan Interleaved 2-of-5 (ITF) barcodes.

BarcodeFormatJapanPostConfiguration

data class BarcodeFormatJapanPostConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false) : BarcodeFormatFourStateConfigurationBase, Parcelable

Japan Post barcode configuration. Add to scanner configuration to scan Japan Post barcodes.

BarcodeFormatMaxiCodeConfiguration

data class BarcodeFormatMaxiCodeConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false) : BarcodeFormatTwoDConfigurationBase, Parcelable

MaxiCode configuration. Add to scanner configuration to scan MaxiCode codes.

BarcodeFormatMicroPdf417Configuration

data class BarcodeFormatMicroPdf417Configuration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var gs1Handling: Gs1Handling = Gs1Handling.PARSE, var strictMode: Boolean = true) : BarcodeFormatTwoDConfigurationBase, Parcelable

MicroPDF417 configuration. Add to scanner configuration to scan MicroPDF417 codes.

BarcodeFormatMsiPlesseyConfiguration

data class BarcodeFormatMsiPlesseyConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var stripCheckDigits: Boolean = false, var minimumTextLength: Int = 1, var maximumTextLength: Int = 0, var checksumAlgorithms: List<MsiPlesseyChecksumAlgorithm> = listOf( MsiPlesseyChecksumAlgorithm.MOD_10 )) : BarcodeFormatOneDConfigurationBase, Parcelable

MSI Plessey barcode configuration. Add to scanner configuration to scan MSI Plessey barcodes.

BarcodeFormatOneDConfigurationBase

sealed class BarcodeFormatOneDConfigurationBase : BarcodeFormatConfigurationBase, Parcelable

Base class for all linear (1D) barcode configurations.

BarcodeFormatPdf417Configuration

data class BarcodeFormatPdf417Configuration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var gs1Handling: Gs1Handling = Gs1Handling.PARSE, var strictMode: Boolean = true) : BarcodeFormatTwoDConfigurationBase, Parcelable

PDF417 configuration. Add to scanner configuration to scan PDF417 codes.

BarcodeFormatPharmaCodeConfiguration

data class BarcodeFormatPharmaCodeConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var minimumValue: Int = 16, var allowNarrowBarsOnly: Boolean = false, var allowWideBarsOnly: Boolean = false) : BarcodeFormatOneDConfigurationBase, Parcelable

PharmaCode barcode configuration. Add to scanner configuration to scan linear (1D) Laetus Pharmacode barcodes. Two-track PharmaCode scanning is configured separately through the PharmaCodeTwoTrackConfig class.

BarcodeFormatPharmaCodeTwoTrackConfiguration

data class BarcodeFormatPharmaCodeTwoTrackConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimumValue: Int = 364) : BarcodeFormatFourStateConfigurationBase, Parcelable

PHARMA_CODE_TWO_TRACK barcode configuration. Add to scanner configuration to scan Laetus two-track PharmaCode barcodes. Linear (i.e. one-track) PharmaCode scanning is configured separately through the PharmaCodeConfig class.

BarcodeFormatQrCodeConfiguration

data class BarcodeFormatQrCodeConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var gs1Handling: Gs1Handling = Gs1Handling.PARSE, var strictMode: Boolean = true, var qr: Boolean = true, var microQr: Boolean = false, var rmqr: Boolean = false) : BarcodeFormatTwoDConfigurationBase, Parcelable

QR Code configuration. Add to scanner configuration to scan QR codes, Micro QR codes and rectangular Micro QR (rMQR) codes.

BarcodeFormatRoyalMailConfiguration

data class BarcodeFormatRoyalMailConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var stripCheckDigits: Boolean = false) : BarcodeFormatFourStateConfigurationBase, Parcelable

Royal Mail barcode configuration. Add to scanner configuration to scan Royal Mail (a.k.a. RM4SCC, CBC, BPO 4-State) barcodes.

BarcodeFormatRoyalTntPostConfiguration

data class BarcodeFormatRoyalTntPostConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false) : BarcodeFormatFourStateConfigurationBase, Parcelable

Royal TNT Post barcode configuration. Add to scanner configuration to scan Royal TNT Post (a.k.a. KIX, Klant IndeX) barcodes.

BarcodeFormats

class BarcodeFormats : Parcelable

Lists of barcode formats to decode.

BarcodeFormatTwoDConfigurationBase

sealed class BarcodeFormatTwoDConfigurationBase : BarcodeFormatConfigurationBase, Parcelable

Base class for all 2D barcode configurations.

BarcodeFormatUpcEanConfiguration

data class BarcodeFormatUpcEanConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var stripCheckDigits: Boolean = false, var ean8: Boolean = true, var ean13: Boolean = true, var upca: Boolean = true, var upce: Boolean = true, var extensions: UpcEanExtensionBehavior = UpcEanExtensionBehavior.ALLOW_ANY) : BarcodeFormatOneDConfigurationBase, Parcelable

UPC/EAN barcode configuration. Add to scanner configuration to scan EAN-8, EAN-13, UPC-E and UPC-A barcodes.

BarcodeFormatUspsIntelligentMailConfiguration

data class BarcodeFormatUspsIntelligentMailConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false) : BarcodeFormatFourStateConfigurationBase, Parcelable

USPS Intelligent Mail barcode configuration. Add to scanner configuration to scan USPS Intelligent Mail (a.k.a. USPS OneCode, USPS-STD-11) barcodes.

BarcodeItem

data class BarcodeItem(val text: String, val rawBytes: ByteArray, val rawBytesEncodings: List<RangeEncoding>, val structuredAppendInfo: StructuredAppendInfo?, val format: BarcodeFormat = BarcodeFormat.NONE, val quad: List<Point>, val quadNormalized: List<PointF>, val extendedQuad: List<Point>, val extendedQuadNormalized: List<PointF>, val isUpsideDown: Boolean = false, val sourceImage: ImageRef? = null, val upcEanExtension: String, val isGS1Message: Boolean = false, val isGS1CompositePart: Boolean = false, val dataBarStackSize: Int = 1, val sizeScore: Double = 0.0, val extractedDocument: GenericDocument?, val globalIndex: Int = -1) : AutoCloseable, Parcelable

A single barcode found in the input image. Barcodes with the same content but different locations in the image are considered separate barcodes.

BarcodeRegexFilter

class BarcodeRegexFilter(regex: String) : BarcodeFilter

Subclass of BarcodeFilter that only accepts barcodes matching regex string.

BarcodeScanner

interface BarcodeScanner

Scans bar codes and QR codes.

BarcodeScannerConfiguration

data class BarcodeScannerConfiguration(var barcodeFormatConfigurations: List<BarcodeFormatConfigurationBase> = listOf( BarcodeFormatCommonConfiguration( ) ), var extractedDocumentFormats: List<BarcodeDocumentFormat> = listOf( BarcodeDocumentFormat.AAMVA, BarcodeDocumentFormat.BOARDING_PASS, BarcodeDocumentFormat.DE_MEDICAL_PLAN, BarcodeDocumentFormat.MEDICAL_CERTIFICATE, BarcodeDocumentFormat.ID_CARD_PDF_417, BarcodeDocumentFormat.SEPA, BarcodeDocumentFormat.SWISS_QR, BarcodeDocumentFormat.VCARD, BarcodeDocumentFormat.GS1, BarcodeDocumentFormat.HIBC ), var onlyAcceptDocuments: Boolean = false, var returnBarcodeImage: Boolean = false, var engineMode: BarcodeScannerEngineMode = BarcodeScannerEngineMode.NEXT_GEN, var accumulationConfig: BarcodeAccumulationConfiguration = BarcodeAccumulationConfiguration( ), var optimizedForOverlays: Boolean = false) : Parcelable

Configuration for the barcode scanner.

BarcodeScannerEngineMode

enum BarcodeScannerEngineMode : Enum<BarcodeScannerEngineMode>

The engine mode for barcode scanning.

BarcodeScannerFrameHandler

open class BarcodeScannerFrameHandler(barcodeScanner: BarcodeScanner) : FrameHandler

Performs barcode/QR code scanning on camera preview frames. Outputs results via BarcodeScannerFrameHandler.ResultHandler (addResultHandler).

BarcodeScannerResult

data class BarcodeScannerResult(val barcodes: List<BarcodeItem>, val success: Boolean) : AutoCloseable, Parcelable

The result of barcode scanning.

BarcodeScanningSdk

interface BarcodeScanningSdk

CharacterEncoding

enum CharacterEncoding : Enum<CharacterEncoding>

Enumerates character encodings.

DefaultBarcodeScanner

class DefaultBarcodeScanner : BarcodeScanner

Manages barcode scanning operations and scanner initialization.

Gs1Handling

enum Gs1Handling : Enum<Gs1Handling>

GS1 message handling options. The GS1 standard defines a key-value format for business-centric data that can be encoded into many 1D and 2D barcode types. https://ref.gs1.org/standards/genspecs/

IBarcodeFilter

interface IBarcodeFilter : Serializable

An interface for a barcode filtering that can be used in barcode scanning RTU-UI components. You can customize the filtering of barcode results coming from RTU-UI barcode scanners by implementing a subclass of this class and pass this class to the barcode scanning RTU-UI component as a part of configuration.

MsiPlesseyChecksumAlgorithm

enum MsiPlesseyChecksumAlgorithm : Enum<MsiPlesseyChecksumAlgorithm>

Checksum algorithm for MSI_PLESSEY.

RangeEncoding

data class RangeEncoding(val start: Int, val end: Int, val encoding: CharacterEncoding) : Parcelable

A character encoding for a given range of bytes.

StructuredAppendInfo

data class StructuredAppendInfo(val count: Int, val index: Int, val id: String) : Parcelable

The structured append mode can be used to split a message across multiple barcodes.

SuccessFrameDebouncer

class SuccessFrameDebouncer(var interval: Long = 0)

Allows to keep track of the interval between successful events

UpcEanExtensionBehavior

enum UpcEanExtensionBehavior : Enum<UpcEanExtensionBehavior>

Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.

Properties

textWithExtension

val BarcodeItem.textWithExtension: String

Functions

create

fun BarcodeScannerConfiguration.Companion.create(barcodeFormats: List<BarcodeFormat> = BarcodeFormatCommonConfiguration.default().formats, extractedDocumentFormats: List<BarcodeDocumentFormat> = BarcodeScannerConfiguration.default().extractedDocumentFormats, onlyAcceptDocuments: Boolean = BarcodeScannerConfiguration.default().onlyAcceptDocuments): BarcodeScannerConfiguration

Simplified create configuration method to set barcode formats and document formats filters.

setBarcodeFormats

fun BarcodeScannerConfiguration.setBarcodeFormats(barcodeFormats: List<BarcodeFormat> = BarcodeFormatCommonConfiguration.default().formats)

Simplified extension configuration function that set the list of barcode formats to scan. By default, the most commonly used formats are enabled. Overrides BarcodeScannerConfiguration.barcodeFormatConfigurations list of configurations.