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

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.

Industrial 2-of-5 barcodes are a subset of Code 25 barcodes. Any valid Industrial 2-of-5 barcode is also a valid Code 25 barcode.

Constructors

constructor(source: Map<String, Any?>)

constructor(json: JSONObject)

constructor(regexFilter: String = "", minimumSizeScore: Double = 0.0, addAdditionalQuietZone: Boolean = false, minimum1DQuietZoneSize: Int = 6, stripCheckDigits: Boolean = false, minimumTextLength: Int = 1, maximumTextLength: Int = 0, iata2of5: Boolean = true, code25: Boolean = false, industrial2of5: Boolean = true, useIATA2OF5Checksum: Boolean = true)

Types

Companion

object Companion

Properties

_type

open override val _type: String

addAdditionalQuietZone

open override var addAdditionalQuietZone: Boolean

If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.

code25

var code25: Boolean

If true, scan and return Code 25 (Code 2-of-5) barcodes. If industrial2of5 is also true, then valid Industrial 2-of-5 barcodes will preferentially be returned as such, instead of Code 25.

iata2of5

var iata2of5: Boolean

If true, scan IATA 2-of-5 barcodes. If useIATA2OF5Checksum is true, only barcodes with a valid checksum are returned.

industrial2of5

var industrial2of5: Boolean

If true, scan and return valid Industrial 2-of-5 barcodes. If false, but code25 is true, Industrial 2-of-5 barcodes will be returned as Code 25 barcodes.

maximumTextLength

var maximumTextLength: Int

Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.

minimum1DQuietZoneSize

open override var minimum1DQuietZoneSize: Int

Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.

minimumSizeScore

open override var minimumSizeScore: Double

Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.

minimumTextLength

var minimumTextLength: Int

Minimum text length. Applied only to linear barcode formats that allow variable length.

regexFilter

open override var regexFilter: String

Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).

stripCheckDigits

var stripCheckDigits: Boolean

If true, the check digits are stripped from the result.

useIATA2OF5Checksum

var useIATA2OF5Checksum: Boolean

If true, return IATA_2_OF_5 barcodes only if they have a valid check digit.

Functions

clone

open override fun clone(): BarcodeFormatCode2Of5Configuration

toJson

open override fun toJson(config: ToJsonConfiguration): JSONObject