Interface DetectBarcodesOnImageArguments

interface DetectBarcodesOnImageArguments {
    acceptedDocumentFormats?: BarcodeDocumentFormat[];
    barcodeFormats?: BarcodeFormat[];
    codeDensity?: CodeDensity;
    engineMode?: EngineMode;
    gs1HandlingMode?: Gs1HandlingMode;
    imageFileUri: string;
    lowPowerMode?: boolean;
    maximumTextLength?: number;
    minimum1DBarcodesQuietZone?: number;
    minimumTextLength?: number;
    msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm;
    stripCheckDigits?: boolean;
}

Properties

acceptedDocumentFormats?: BarcodeDocumentFormat[]

An optional array of barcode document formats that act as a detection filter. By default all supported document formats will be detected.

barcodeFormats?: BarcodeFormat[]

Accepted barcode formats

codeDensity?: CodeDensity

The expected density of QR codes in an image.

engineMode?: EngineMode

Barcode scanner engine mode. Default is NEXT_GEN

gs1HandlingMode?: Gs1HandlingMode

The GS1 handling mode. The default value is PARSE.

imageFileUri: string

The input image file URI

lowPowerMode?: boolean

If true, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If false - mode is disabled. The default is false. Android only.

maximumTextLength?: number

Optional maximum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE: This feature works on ITF barcodes only.

minimum1DBarcodesQuietZone?: number

Optional minimum required quiet zone on the barcode. Measured in modules (the size of minimal bar on the barcode). The default is 10. NOTE: This feature works on ITF barcodes only.

minimumTextLength?: number

Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE: This feature works on ITF barcodes only.

msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm

The checksum algorithm for MSI Plessey barcodes. The default value is Mod10.

stripCheckDigits?: boolean

With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is false