NativeScript Barcode Scanner SDK

Continuous scanning

Keep the camera session open

Scan item after item without restarting the scanner. The duplicate threshold controls repeats: -1 reads each barcode once, 0 reads it again with no delay, and a value above 0 waits that many seconds.

            this.barkoderView.setCloseSessionOnResultEnabled(false)
            this.barkoderView.setThresholdBetweenDuplicatesScans(0) // it can take values -1, or n > 0
          

Batch MultiScan

Many barcodes in one camera view

Read several barcodes without stopping after each one, with result caching and a maximum results count. The docs recommend normal decoding speed and resolution for this mode.

            private setMultiScan() : void {
            this.barkoderView.setRegionOfInterestVisible(true)
            this.barkoderView.setCloseSessionOnResultEnabled(false)
            this.barkoderView.setRegionOfInterestVisible(true)
            this.barkoderView.setMulticodeCachingEnabled(true)
            this.barkoderView.setMulticodeCachingDuration(3000)
            this.barkoderView.setMaximumResultsCount(200)
            this.barkoderView.setDecodingSpeed(BarkoderConstants.DecodingSpeed.Normal)
            this.barkoderView.setBarkoderResolution(BarkoderConstants.BarkoderResolution.NORMAL)
            }
          

MRZ scanning

Passports, ID cards and visas

Enable the IDDocument type to read the machine-readable zone of travel and identity documents. Results include data such as name, nationality, passport number and expiration date, and the docs show how to get the document, picture and signature images.

            private setBarcodeTypeEnabled(): void {
            this.barkoderView.setBarcodeTypeEnabled([
            BarkoderConstants.DecoderType.IDDocument
            ]);
            }
          

VIN scanning with OCR fallback

Code 39, Code 128, Data Matrix and QR

The VIN setup enables the four barcode types a VIN can use, VIN restrictions, slow decoding and high resolution. With an OCR-enabled license, the SDK falls back to the printed VIN text when the barcode can't be decoded. OCR VIN is available from version 1.6.7, and on Android it needs the ML Kit text recognition dependency shown in the docs.

DPM mode

Codes etched or printed on parts

Direct Part Marking puts a Data Matrix code straight onto metal or plastic. The DPM setup enables Data Matrix with DPM mode, slow decoding, FHD resolution and a small region of interest.

            private setDpmMode() : void {
            this.barkoderView.setBarcodeTypeEnabled(
            [BarkoderConstants.DecoderType.Datamatrix]
            )
            this.barkoderView.setRegionOfInterestVisible(true)
            this.barkoderView.setDatamatrixDpmModeEnabled(true)
            this.barkoderView.setRegionOfInterestVisible(true)
            this.barkoderView.setDecodingSpeed(BarkoderConstants.DecodingSpeed.Slow)
            this.barkoderView.setBarkoderResolution(BarkoderConstants.BarkoderResolution.FHD)
            this.barkoderView.setRegionOfInterest(40, 40, 20, 10);
            }
          

South African driving licenses

PDF417 with on-device parsing

Enable PDF417 and the SADL formatting type to parse South African driving licenses. Two custom options add parsing for South African ID cards and vehicle license discs.

            // Enable PDF417 symbology and South African Driving License parser
            barkoderView.setBarcodeTypeEnabled([
            BarkoderConstants.DecoderType.PDF417
            ]);
            barkoderView.setFormattingType(BarkoderConstants.FormattingType.SADL)
            // Parsers for data in South African IDs and South African Vehicle License Discs
            barkoderView.setCustomOption("SADL_decode_ID", 1)
            barkoderView.setCustomOption("SADL_decode_vehicle_disk", 1)
          

Damaged and difficult barcodes

The same decoding engine as the native SDKs

• MatrixSight® reads QR and Data Matrix codes with missing finder, timing or alignment patterns.
• Segment Decoding® reads 1D barcodes on curved or irregular surfaces such as bottles and test tubes.
• DeBlur reads EAN and UPC codes with motion, lens or focus blur.
• PDF417-LineSight® reads PDF417 barcodes with missing start or stop patterns and data columns.

AR Mode and gallery scan

Overlays on the preview, and images from the photo library

• AR Mode draws boxes and barcode status on the camera preview, with interactive and non-interactive modes and your own colors.
• Gallery scan decodes BMP, PNG and JPG images that users pick from the photo library, through scanImage.

Targets and requirements

• NativeScript apps for Android and iOS. The package declares NativeScript platform runtime 6 or later, and the official demo app runs on NativeScript 9.
• Android 5.0 (API 21) or later.
• iOS 15.0 or later for version 1.7.2. Building for iOS needs macOS with Xcode.
• Camera: at least 1280×720. Devices with an 8 MP autofocus camera are recommended.
• Scanning runs on the device. The SDK goes online only for the license check, and each device must reach the licensing server at least once every 30 days.

Barcode types

1D barcodes

Codabar, Code 11, Code 25, Code 32, Code 39, Code 93, Code 128, COOP 2 of 5, Datalogic 2 of 5, GS1 DataBar, GS1 Composite, EAN-8, EAN-13, IATA 2 of 5, Interleaved 2 of 5, ITF-14, Matrix 2 of 5, MSI Plessey, Postal Barcodes, Telepen, UPC-A, UPC-E and UPC-E1.

2D barcodes

Aztec Code, Aztec Compact, Data Matrix, DotCode, MaxiCode, PDF417, Micro PDF417, QR Code and Micro QR Code.