barKoder Barcode Scanner SDK plugin for Capacitor

Enterprise-grade barcode scanner SDK plugin for all Capacitor apps

The barKoder Barcode Scanner SDK Capacitor plugin grants an easy to use solution with a great and completely customizable interface that can be instantly integrated in both iOS and Android apps.

The barKoder Barcode Scanner SDK will fully transform the user's smartphones and tablets that deploy your Enterprise and Consumer apps into rugged barcode scanning devices without the need to procure and maintain expensive and sluggish hardware devices that have a very short life span.

Even though the barKoder barcode scanner SDK is a relatively new product, it is already more advanced than other competitor API's. Its robust barcode reading engine can be used to read the content of the most widely used barcodes with lightning fast speed and unprecedented recognition rate:

1D - Codabar, Code 11, Code 25, Code 39, Code 93, Code 128, EAN-8, EAN-13, Interleaved 2 of 5, ITF-14, MSI Plessey, Pharmacode, Telepen, UPC-A & UPC-E
2D - Aztec Code, Aztec Compact, Data Matrix, DotCode, PDF417, Micro PDF417, QR Code & Micro QR Code

The barKoder SDK features multiple algorithms that handle a wide variety of barcode scanning scenarios with unprecedented performance in terms of speed and success rate:
* DPM Mode - Specially designed scanning template for decoding Data Matrix barcodes engraved using any Direct Part Marking (DPM) technique;
* MatrixSight - Proprietary algorithm that can successfully scan QR Codes or Data Matrix barcodes even when they are missing their finder, timing and/or alignment patterns, even part of the data elements;
* Segment Decoding - The advanced barcode localization techniques implemented into the barKoder SDK grants an ability to recognize 1D barcodes that have significant deformations along their Z axis, getting especially handy when trying to recognize barcodes found on test tubes, bottles and other surfaces with rounded, curved, hollowed or otherwise irregular shapes;
* VIN Barcode Scanning Mode - The most advanced VIN barcode scanning mode on the market, utilizing all the special algorithms of the barKoder SDK leading to the ultimate scanning experience of any kind of barcodes used for embedding Vehicle Identification Numbers, including Code 39, Code 128, QR Code and Data Matrix;
* DeBlur Mode - Whether there's lens, motion or focus blur present in EAN or UPC barcodes, the barKoder DeBlur Mode alleviates it fully and doesn't allow the scanning experience to suffer;
* PDF417-LineSight - The robust PDF417 barcode scanner SDK that is offered by barKoder can detect even the most severely damaged PDF417 codes, including missing their start and stop patterns, stop row indicators or even entire data columns, making it the sublime choice for apps that need to reliably scan US or Canadian driver's licenses, South African vehicle license discs or driver's licenses, as well as various types of ID's such as Military, Argentinian, Colombian or South African Smart ID Cards.

You can check out our free demo app Barcode Scanner by barKoder available both via Apple App Store & Google Play Store.

Documentation

You can find full documentation about the barKoder Barcode Reader SDK here: https://docs.barkoder.com/en/capacitor-installation

Trial License

If you run the barKoder Barcode Scanner SDK without a valid trial or production license, all results upon successful barcode scans will be partially masked by asterisks (*). You can get a trial license simply by registering on the barKoder Portal and utilizing the self-service for Evaluation License Generation! Each trial license will be good for an initial duration of 30 days and can be deployed to up to 25 devices. For any custom requirements, contact our sales team via sales@barkoder.com

Note that a trial license is only supposed to be utilized in a development or staging environment. If you decide to publish a trial license along with your app to the App Store, Play Store or any public store we won't be held accountable for any potential consequences.

Free Developer Support

Our support is completely free for integration or testing purposes and granted through the barKoder Portal. After registering and logging into your account, you only need to submit a Support Issue form. Alternatively, you can contact us by email via support@barkoder.com.

Requirements

Capacitor is a cross-platform app runtime that makes it easy to build web apps that run natively on iOS, Android and the web. To get started with building apps using Capacitor, you'll need to meet certain requirements:

1. Node.js and npm:
- Ensure you have Node.js installed on your machine. Capacitor requires Node.js version 10 or later.
- npm (Node Package Manager) is also required. It usually comes with Node.js.
2. Text Editor or IDE:
- Choose a text editor or an integrated development environment (IDE) for coding. Popular choices include Visual Studio Code, Atom, or any other editor of your preference.
3. Git:
- Capacitor projects are often managed with Git, so having Git installed on your machine is recommended.
4. Command Line Interface (CLI):
- Capacitor commands are executed via the command line. Make sure you have a command line interface (CLI) installed and accessible on your system.
5. Mobile Development SDKs:
- To build and run apps on specific platforms, you'll need the corresponding SDKs:
- For iOS development: Xcode (available on macOS)
- For Android development: Android Studio
Capacitor project. Here are the basic steps:
1. Install Capacitor:
``bash npm install -g @capacitor/cli`3. Add Platforms:`bash npx cap add ios npx cap add android`4. Open IDE and Start Coding: - Open your chosen IDE or text editor and start building your app using web technologies. 5. Build and Run: - Use Capacitor commands to build and run your app on different platforms.`bash npx cap open ios npx cap open android`These steps provide a basic overview, and the Capacitor documentation may have been updated since our last knowledge update. It's always a good idea to refer to the official Capacitor documentation for the latest and most accurate information: Capacitor Documentation.

`Install`

`bash npm install barkoder-capacitor npx cap sync`

`Install Manually`


If you would like to install from a local folder you will need to follow these steps:

- Download zip - Unpack zip file - Rename folder to your liking - Paste the folder in app directory ex. myApp/barkoder-capacitor (this is the new name of the download plugin folder) - Finally:`bash npm install “/your-path/myApp/barkoder-capacitor”`

`Using the plugin`


Angular

In your ts file:`bash import { Barkoder, BarkoderResult, BarcodeType } from 'barkoder-capacitor'

@ViewChild('barkoderView') barkoderViewRef!: ElementRef;

constructor() { Barkoder.addListener('barkoderResultEvent', (data: any) => { console.log('barkoderResultEvent was fired'); const barkoderResult = new BarkoderResult(data); if (barkoderResult) { barkoderResult.decoderResults.forEach((result, index) => { console.log(Result ${index + 1}: ${result.textualData}); }); } }); }

ngAfterViewInit() { Barkoder.registerWithLicenseKey({ licenseKey: "YOUR_LICENSE_KEY" }); setTimeout(() => { const boundingRect = this.barkoderViewRef.nativeElement.getBoundingClientRect() as DOMRect; Barkoder.initialize({ width: Math.round(boundingRect.width), height: Math.round(boundingRect.height), x: Math.round(boundingRect.x), y: Math.round(boundingRect.y), }); this.setBarkoderSettings(); this.setActiveBarcodeTypes(); }, 200); }

setActiveBarcodeTypes() { Barkoder.setBarcodeTypeEnabled({ type: BarcodeType.qr, enabled: true }); Barkoder.setBarcodeTypeEnabled({ type: BarcodeType.code128, enabled: true }); Barkoder.setBarcodeTypeEnabled({ type: BarcodeType.ean13, enabled: true }); }

setBarkoderSettings() { Barkoder.setRegionOfInterestVisible({value: true}); Barkoder.setRegionOfInterest({ left: 5, top: 5, width: 90, height: 90 }); Barkoder.setImageResultEnabled({ enabled: true}); Barkoder.setBarcodeThumbnailOnResultEnabled({ enabled: true}); }

startScanning() { Barkoder.startScanning(); }`

In your HTML file add the barkoderView div id:`bash

In your scss file set the desired barkoderView height:`bash #barkoderView { height: 400px; }`

`API`

* initialize(...)*registerWithLicenseKey(...)*setZoomFactor(...)*setFlashEnabled(...)*startCamera()*startScanning()*stopScanning()*pauseScanning()*freezeScanning()*unfreezeScanning()*captureImage()*scanImage(...)*setLocationLineColor(...)*setLocationLineWidth(...)*setRoiLineColor(...)*setRoiLineWidth(...)*setRoiOverlayBackgroundColor(...)*setCloseSessionOnResultEnabled(...)*setImageResultEnabled(...)*setLocationInImageResultEnabled(...)*setRegionOfInterest(...)*setThreadsLimit(...)*setLocationInPreviewEnabled(...)*setPinchToZoomEnabled(...)*setRegionOfInterestVisible(...)*setBarkoderResolution(...)*setBeepOnSuccessEnabled(...)*setVibrateOnSuccessEnabled(...)*showLogMessages(...)*setBarcodeTypeLengthRange(...)*setEncodingCharacterSet(...)*setDecodingSpeed(...)*setFormattingType(...)*setCode11ChecksumType(...)*setMsiChecksumType(...)*setCode39ChecksumType(...)*setBarcodeTypeEnabled(...)*setMulticodeCachingEnabled(...)*setMulticodeCachingDuration(...)*setMaximumResultsCount(...)*setBarcodeThumbnailOnResultEnabled(...)*setThresholdBetweenDuplicatesScans(...)*setUpcEanDeblurEnabled(...)*setMisshaped1DEnabled(...)*setEnableVINRestrictions(...)*setDatamatrixDpmModeEnabled(...)*setQrDpmModeEnabled(...)*setQrMicroDpmModeEnabled(...)*setQrMultiPartMergeEnabled(...)*configureBarkoder(...)*setIdDocumentMasterChecksumEnabled(...)*setUPCEexpandToUPCA(...)*setUPCE1expandToUPCA(...)*setCustomOption(...)*setCustomOptionGlobal(...)*setScanningIndicatorColor(...)*setScanningIndicatorWidth(...)*setScanningIndicatorAnimation(...)*setScanningIndicatorAlwaysVisible(...)*setDynamicExposure(...)*setCentricFocusAndExposure(...)*setEnableComposite(...)*setVideoStabilization(...)*setCamera(...)*setShowDuplicatesLocations(...)*setARMode(...)*setARResultDisappearanceDelayMs(...)*setARLocationTransitionSpeed(...)*setAROverlayRefresh(...)*setARSelectedLocationColor(...)*setARNonSelectedLocationColor(...)*setARSelectedLocationLineWidth(...)*setARNonSelectedLocationLineWidth(...)*setARLocationType(...)*setARDoubleTapToFreezeEnabled(...)*setARImageResultEnabled(...)*setARBarcodeThumbnailOnResultEnabled(...)*setARResultLimit(...)*setARContinueScanningOnLimit(...)*setAREmitResultsAtSessionEndOnly(...)*setARHeaderHeight(...)*setARHeaderShowMode(...)*setARHeaderMaxTextHeight(...)*setARHeaderMinTextHeight(...)*setARHeaderTextColorSelected(...)*setARHeaderTextColorNonSelected(...)*setARHeaderHorizontalTextMargin(...)*setARHeaderVerticalTextMargin(...)*setARHeaderTextFormat(...)*configureCloseButton(...)*configureFlashButton(...)*configureZoomButton(...)*selectVisibleBarcodes()*isFlashAvailable()*isCloseSessionOnResultEnabled()*isImageResultEnabled()*isLocationInImageResultEnabled()*isLocationInPreviewEnabled()*isPinchToZoomEnabled()*isRegionOfInterestVisible()*isBeepOnSuccessEnabled()*isVibrateOnSuccessEnabled()*getVersion()*getLibVersion()*getLocationLineColorHex()*getRoiLineColorHex()*getRoiOverlayBackgroundColorHex()*getMaxZoomFactor()*getCurrentZoomFactor()*getLocationLineWidth()*getRoiLineWidth()*getRegionOfInterest()*getBarcodeTypeLengthRange(...)*getMsiChecksumType()*getCode39ChecksumType()*getCode11ChecksumType()*getEncodingCharacterSet()*getDecodingSpeed()*getFormattingType()*getThreadsLimit()*getMaximumResultsCount()*isBarcodeTypeEnabled(...)*getMulticodeCachingEnabled()*getMulticodeCachingDuration()*isUpcEanDeblurEnabled()*isMisshaped1DEnabled()*isBarcodeThumbnailOnResultEnabled()*getThresholdBetweenDuplicatesScans()*isVINRestrictionsEnabled()*getBarkoderResolution()*isDatamatrixDpmModeEnabled()*isQrDpmModeEnabled()*isQrMicroDpmModeEnabled()*isQrMultiPartMergeEnabled()*isIdDocumentMasterChecksumEnabled()*getScanningIndicatorColorHex()*getScanningIndicatorWidth()*getScanningIndicatorAnimation()*isScanningIndicatorAlwaysVisible()*getShowDuplicatesLocations()*getARMode()*getARResultDisappearanceDelayMs()*getARLocationTransitionSpeed()*getAROverlayRefresh()*getARSelectedLocationColor()*getARNonSelectedLocationColor()*getARSelectedLocationLineWidth()*getARNonSelectedLocationLineWidth()*getARLocationType()*isARDoubleTapToFreezeEnabled()*isARImageResultEnabled()*isARBarcodeThumbnailOnResultEnabled()*getARResultLimit()*getARContinueScanningOnLimit()*getAREmitResultsAtSessionEndOnly()*getARHeaderHeight()*getARHeaderShowMode()*getARHeaderMaxTextHeight()*getARHeaderMinTextHeight()*getARHeaderTextColorSelected()*getARHeaderTextColorNonSelected()*getARHeaderHorizontalTextMargin()*getARHeaderVerticalTextMargin()*getARHeaderTextFormat()* Enums

`$3`

`typescript initialize(options: { width: number; height: number; x: number; y: number; }) => Promise`

| Param | Type | | ------------- | --------------------------------------------------------------------- | |options | { width: number; height: number; x: number; y: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript registerWithLicenseKey(options: { licenseKey: string; }) => Promise`

| Param | Type | | ------------- | ------------------------------------ | |options | { licenseKey: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setZoomFactor(options: { value: number; }) => Promise`

Sets the zoom factor for the device's camera, adjusting the level of zoom during barcode scanning

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setFlashEnabled(options: { enabled: boolean; }) => Promise`

Enables or disables the device's flash (torch) for illumination during barcode scanning

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript startCamera() => Promise`

Returns: Promise<any>

--------------------

`$3`

`typescript startScanning() => Promise`

Initiates the barcode scanning process, allowing the application to detect and decode barcodes from the device's camera feed

Returns: Promise<any>

--------------------

`$3`

`typescript stopScanning() => Promise`

Halts the barcode scanning process, stopping the camera from capturing and processing barcode information

Returns: Promise<any>

--------------------

`$3`

`typescript pauseScanning() => Promise`

Temporarily suspends the barcode scanning process, pausing the camera feed without completely stopping the scanning session

Returns: Promise<any>

--------------------

`$3`

`typescript freezeScanning() => Promise`

Freezes the current AR scanning session by capturing a still image from the camera feed. Use only when AR mode is enabled to temporarily freeze the view while keeping overlays visible.

Returns: Promise<any>

--------------------

`$3`

`typescript unfreezeScanning() => Promise`

Unfreezes the AR scanning session by removing the still image and reactivating the camera and overlays. Use only when AR mode is enabled to restore the live AR view and continue scanning.

Returns: Promise<any>

--------------------

`$3`

`typescript captureImage() => Promise`

Captures the latest camera frame

Returns: Promise<any>

--------------------

`$3`

`typescript scanImage(options: { base64: string; }) => Promise`

Scan barcodes from base64 string image

| Param | Type | | ------------- | -------------------------------- | |options | { base64: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setLocationLineColor(options: { value: string; }) => Promise`

Sets the color of the lines used to indicate the location of detected barcodes on the camera feed

| Param | Type | | ------------- | ------------------------------- | |options | { value: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setLocationLineWidth(options: { value: number; }) => Promise`

Sets the width of the lines indicating the location of detected barcodes on the camera feed

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setRoiLineColor(options: { value: string; }) => Promise`

Sets the color of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed

| Param | Type | | ------------- | ------------------------------- | |options | { value: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setRoiLineWidth(options: { value: number; }) => Promise`

Sets the width of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setRoiOverlayBackgroundColor(options: { value: string; }) => Promise`

Sets the background color of the overlay within the Region of Interest (ROI) for barcode scanning on the camera feed

| Param | Type | | ------------- | ------------------------------- | |options | { value: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setCloseSessionOnResultEnabled(options: { enabled: boolean; }) => Promise`

Enables or disables the automatic closing of the scanning session upon detecting a barcode result

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setImageResultEnabled(options: { enabled: boolean; }) => Promise`

Enables or disables the capturing and processing of image data when a barcode is successfully detected

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setLocationInImageResultEnabled(options: { enabled: boolean; }) => Promise`

Enables or disables the inclusion of barcode location information within the image data result

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setRegionOfInterest(options: { left: number; top: number; width: number; height: number; }) => Promise`

Defines the Region of Interest (ROI) on the camera preview for barcode scanning, specifying an area where the application focuses on detecting barcodes

| Param | Type | | ------------- | -------------------------------------------------------------------------- | |options | { left: number; top: number; width: number; height: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setThreadsLimit(options: { value: number; }) => Promise`

Sets the threads limit

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setLocationInPreviewEnabled(options: { enabled: boolean; }) => Promise`

Enables or disables the display of barcode location information on the camera preview

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setPinchToZoomEnabled(options: { enabled: boolean; }) => Promise`

Enables or disables the pinch-to-zoom feature for adjusting the zoom level during barcode scanning

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setRegionOfInterestVisible(options: { value: boolean; }) => Promise`

Sets the visibility of the Region of Interest (ROI) on the camera preview

| Param | Type | | ------------- | -------------------------------- | |options | { value: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setBarkoderResolution(options: { value: BarkoderResolution; }) => Promise`

Sets the resolution for barcode scanning

| Param | Type | | ------------- | ----------------------------------------------------------------------------- | |options | { value: BarkoderResolution; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setBeepOnSuccessEnabled(options: { enabled: boolean; }) => Promise`

Enables or disables the audible beep sound upon successfully decoding a barcode

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setVibrateOnSuccessEnabled(options: { enabled: boolean; }) => Promise`

Enables or disables the device vibration upon successfully decoding a barcode.

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript showLogMessages(options: { enabled: boolean; }) => Promise`

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setBarcodeTypeLengthRange(options: { type: BarcodeType; min: number; max: number; }) => Promise`

Sets the length range for the specified barcode type

| Param | Type | | ------------- | ---------------------------------------------------------------------------------------- | |options | { type: BarcodeType; min: number; max: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setEncodingCharacterSet(options: { value: string; }) => Promise`

Sets the encoding character set for barcode scanning

| Param | Type | | ------------- | ------------------------------- | |options | { value: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setDecodingSpeed(options: { value: DecodingSpeed; }) => Promise`

Sets the decoding speed for barcode scanning

| Param | Type | | ------------- | ------------------------------------------------------------------- | |options | { value: DecodingSpeed; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setFormattingType(options: { value: FormattingType; }) => Promise`

Sets the formatting type for barcode scanning

| Param | Type | | ------------- | --------------------------------------------------------------------- | |options | { value: FormattingType; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setCode11ChecksumType(options: { value: number; }) => Promise`

Sets the Code11 checksum type

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setMsiChecksumType(options: { value: number; }) => Promise`

Sets the MSI checksum type

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setCode39ChecksumType(options: { value: number; }) => Promise`

Sets the Code39 checksum type

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setBarcodeTypeEnabled(options: { type: BarcodeType; enabled: boolean; }) => Promise`

Sets whether a specific barcode type is enabled

| Param | Type | | ------------- | -------------------------------------------------------------------------------- | |options | { type: BarcodeType; enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setMulticodeCachingEnabled(options: { enabled: boolean; }) => Promise`

Sets whether multi-code caching is enabled

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setMulticodeCachingDuration(options: { value: number; }) => Promise`

Sets the caching duration (in milliseconds) for multi-code results

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setMaximumResultsCount(options: { value: number; }) => Promise`

Sets the maximum number of results to be returned from barcode scanning

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setBarcodeThumbnailOnResultEnabled(options: { enabled: boolean; }) => Promise`

A boolean indicating whether to enable barcode thumbnail on result.

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setThresholdBetweenDuplicatesScans(options: { value: number; }) => Promise`

Sets the threshold between duplicate scans

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setUpcEanDeblurEnabled(options: { enabled: boolean; }) => Promise`

Sets whether the deblurring feature for UPC/EAN barcodes is enabled

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setMisshaped1DEnabled(options: { enabled: boolean; }) => Promise`

Sets whether the detection of misshaped 1D barcodes is enabled

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setEnableVINRestrictions(options: { value: boolean; }) => Promise`

Sets whether Vehicle Identification Number (VIN) restrictions are enabled

| Param | Type | | ------------- | -------------------------------- | |options | { value: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setDatamatrixDpmModeEnabled(options: { enabled: boolean; }) => Promise`

Sets whether the Direct Part Marking (DPM) mode for Datamatrix barcodes is enabled.

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setQrDpmModeEnabled(options: { enabled: boolean; }) => Promise`

Sets whether the Direct Part Marking (DPM) mode for QR barcodes is enabled.

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setQrMicroDpmModeEnabled(options: { enabled: boolean; }) => Promise`

Sets whether the Direct Part Marking (DPM) mode for QR Micro barcodes is enabled.

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setQrMultiPartMergeEnabled(options: { enabled: boolean; }) => Promise`

Sets whether the QR multi-part merge mode is enabled.

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript configureBarkoder(options: { barkoderConfig: BarkoderConfig; }) => Promise`

Configures the Barkoder functionality based on the provided configuration

| Param | Type | | ------------- | ------------------------------------------------ | |options | { barkoderConfig: BarkoderConfig; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setIdDocumentMasterChecksumEnabled(options: { enabled: boolean; }) => Promise`

Sets whether Master checksum should be requiered when scanning ID Documents

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setUPCEexpandToUPCA(options: { value: boolean; }) => Promise`

Sets whether the UPC-E barcodes should be expanded to UPC-A format

| Param | Type | | ------------- | -------------------------------- | |options | { value: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setUPCE1expandToUPCA(options: { value: boolean; }) => Promise`

Sets whether the UPC-E1 barcodes should be expanded to UPC-A format

| Param | Type | | ------------- | -------------------------------- | |options | { value: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setCustomOption(options: { option: string; value: number; }) => Promise`

Sets a custom option with a string option and integer value

| Param | Type | | ------------- | ----------------------------------------------- | |options | { option: string; value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setCustomOptionGlobal(options: { option: string; value: number; }) => Promise`

Sets a custom global option with a string option and integer value

| Param | Type | | ------------- | ----------------------------------------------- | |options | { option: string; value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setScanningIndicatorColor(options: { value: string; }) => Promise`

Sets the color of the lines outlining the scanning indicator for barcode scanning on the camera feed

| Param | Type | | ------------- | ------------------------------- | |options | { value: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setScanningIndicatorWidth(options: { value: number; }) => Promise`

Sets the width of the scanning indicator for barcode scanning on the camera feed

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setScanningIndicatorAnimation(options: { value: number; }) => Promise`

Sets the animation of the scanning indicator for barcode scanning on the camera feed

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setScanningIndicatorAlwaysVisible(options: { value: boolean; }) => Promise`

Sets the scanning indicator to be always shown on the camera feed

| Param | Type | | ------------- | -------------------------------- | |options | { value: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setDynamicExposure(options: { value: number; }) => Promise`

Sets the camera's exposure dynamically based on the provided intensity, cycling through predefined compensation values

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setCentricFocusAndExposure(options: { value: boolean; }) => Promise`

Set the camera to use the center of the viewfinder for focus and exposure

| Param | Type | | ------------- | -------------------------------- | |options | { value: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setEnableComposite(options: { value: number; }) => Promise`

Sets wheter Composite Mode should be enabled when scanning

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setVideoStabilization(options: { value: boolean; }) => Promise`

Enable or disable video stabilization for smoother video capture

| Param | Type | | ------------- | -------------------------------- | |options | { value: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setCamera(options: { value: BarkoderCameraPosition; }) => Promise`

Sets the camera to be used for scanning (back/front)

| Param | Type | | ------------- | ------------------------------------------------------------------------------------- | |options | { value: BarkoderCameraPosition; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setShowDuplicatesLocations(options: { value: boolean; }) => Promise`

Enables or disables showing duplicate barcode locations on the preview overlay.

| Param | Type | | ------------- | -------------------------------- | |options | { value: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARMode(options: { value: BarkoderARMode; }) => Promise`

Sets the AR mode used for barcode scanning visualization (e.g., interactive, non-interactive, or off).

| Param | Type | | ------------- | --------------------------------------------------------------------- | |options | { value: BarkoderARMode; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARResultDisappearanceDelayMs(options: { value: number; }) => Promise`

Sets the delay (in milliseconds) after which a detected AR result is considered expired and removed.

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARLocationTransitionSpeed(options: { value: number; }) => Promise`

Sets the speed at which barcode location overlays transition positions.

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setAROverlayRefresh(options: { value: BarkoderAROverlayRefresh; }) => Promise`

Sets the refresh mode for the AR overlay on the camera preview.

| Param | Type | | ------------- | ----------------------------------------------------------------------------------------- | |options | { value: BarkoderAROverlayRefresh; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARSelectedLocationColor(options: { value: string; }) => Promise`

Sets the color used for drawing the overlay around selected barcodes in AR mode.

| Param | Type | | ------------- | ------------------------------- | |options | { value: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARNonSelectedLocationColor(options: { value: string; }) => Promise`

Sets the color used for drawing the overlay around non-selected barcodes in AR mode.

| Param | Type | | ------------- | ------------------------------- | |options | { value: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARSelectedLocationLineWidth(options: { value: number; }) => Promise`

Sets the line width of the overlay for selected barcodes in AR mode.

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARNonSelectedLocationLineWidth(options: { value: number; }) => Promise`

Sets the line width of the overlay for non-selected barcodes in AR mode.

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARLocationType(options: { value: BarkoderARLocationType; }) => Promise`

Sets the style of location overlays drawn around detected barcodes (tight, bounding box, or none).

| Param | Type | | ------------- | ------------------------------------------------------------------------------------- | |options | { value: BarkoderARLocationType; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARDoubleTapToFreezeEnabled(options: { enabled: boolean; }) => Promise`

Enables or disables the ability to freeze/unfreeze scanning via a double-tap gesture in AR mode.

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARImageResultEnabled(options: { enabled: boolean; }) => Promise`

Enables or disables the capturing and processing of image data when a barcode is selected for AR mode.

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARBarcodeThumbnailOnResultEnabled(options: { enabled: boolean; }) => Promise`

Enables or disables the barcode thumbnail on result for AR mode.

| Param | Type | | ------------- | ---------------------------------- | |options | { enabled: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARResultLimit(options: { value: number; }) => Promise`

Sets the maximum number of results allowed in a single AR scanning session.

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARContinueScanningOnLimit(options: { value: boolean; }) => Promise`

Sets whether scanning continues when the result limit is reached (only in .interactiveDisabled mode).

| Param | Type | | ------------- | -------------------------------- | |options | { value: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setAREmitResultsAtSessionEndOnly(options: { value: boolean; }) => Promise`

Sets whether results are emitted only at AR session end (or when the limit is reached).

| Param | Type | | ------------- | -------------------------------- | |options | { value: boolean; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARHeaderHeight(options: { value: number; }) => Promise`

Sets the height of the header text label shown above the barcode in AR mode.

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARHeaderShowMode(options: { value: BarkoderARHeaderShowMode; }) => Promise`

Sets the condition under which the header text is shown above the barcode (always, on selected, or never).

| Param | Type | | ------------- | ----------------------------------------------------------------------------------------- | |options | { value: BarkoderARHeaderShowMode; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARHeaderMaxTextHeight(options: { value: number; }) => Promise`

Sets the maximum text height used for rendering AR header text above barcodes.

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARHeaderMinTextHeight(options: { value: number; }) => Promise`

Sets the minimum text height used for rendering AR header text above barcodes.

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARHeaderTextColorSelected(options: { value: string; }) => Promise`

Sets the text color of the header when the barcode is in a selected state.

| Param | Type | | ------------- | ------------------------------- | |options | { value: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARHeaderTextColorNonSelected(options: { value: string; }) => Promise`

Sets the text color of the header when the barcode is not selected.

| Param | Type | | ------------- | ------------------------------- | |options | { value: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARHeaderHorizontalTextMargin(options: { value: number; }) => Promise`

Sets the horizontal margin applied to the header text in AR mode, creating equal padding on both sides.

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARHeaderVerticalTextMargin(options: { value: number; }) => Promise`

Sets the vertical margin applied to the header text in AR mode, creating equal padding on both sides.

| Param | Type | | ------------- | ------------------------------- | |options | { value: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript setARHeaderTextFormat(options: { value: string; }) => Promise`

Sets the format string for the AR header text above each barcode, using placeholders like [barcode_text], [barcode_type].

| Param | Type | | ------------- | ------------------------------- | |options | { value: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript configureCloseButton(options: { visible: boolean; positionX: number; positionY: number; iconSize: number; tintColor: string; backgroundColor: string; cornerRadius: number; padding: number; useCustomIcon: boolean; customIcon: string; }) => Promise`

Configures the close button displayed during scanning. visible - Show the button while scanning. positionX - X position in points. positionY - Y position in points. iconSize - Glyph point size. tintColor - Icon tint. Hex string (e.g., "#3472c9"); leave "" to use the default. backgroundColor - Button background. Hex string; default is clear. Leave "" to use the default. cornerRadius - Corner radius. padding - Inner padding around the glyph. useCustomIcon - Set true to use a provided custom icon. customIcon - Custom icon as a Base64-encoded image string.

| Param | Type | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |options | { visible: boolean; positionX: number; positionY: number; iconSize: number; tintColor: string; backgroundColor: string; cornerRadius: number; padding: number; useCustomIcon: boolean; customIcon: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript configureFlashButton(options: { visible: boolean; positionX: number; positionY: number; iconSize: number; tintColor: string; backgroundColor: string; cornerRadius: number; padding: number; useCustomIcon: boolean; customIconFlashOn: string; customIconFlashOff: string; }) => Promise`

Configures the flash (torch) button displayed during scanning; auto-hides if the device torch is unavailable. visible - Show the button while scanning. positionX - X position in points. positionY - Y position in points. iconSize - Glyph point size. tintColor - Icon tint. Hex string (e.g., "#3472c9"); leave "" to use the default. backgroundColor - Button background. Hex string; default is clear. Leave "" to use the default. cornerRadius - Corner radius. padding - Inner padding around the glyph. useCustomIcon - Set true to use provided custom icons. customIconFlashOn - Custom ON-state icon as a Base64-encoded image string. customIconFlashOff - Custom OFF-state icon as a Base64-encoded image string.

| Param | Type | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |options | { visible: boolean; positionX: number; positionY: number; iconSize: number; tintColor: string; backgroundColor: string; cornerRadius: number; padding: number; useCustomIcon: boolean; customIconFlashOn: string; customIconFlashOff: string; } |

Returns: Promise<any>

--------------------

`$3`

`typescript configureZoomButton(options: { visible: boolean; positionX: number; positionY: number; iconSize: number; tintColor: string; backgroundColor: string; cornerRadius: number; padding: number; useCustomIcon: boolean; customIconZoomedIn: string; customIconZoomedOut: string; zoomedInFactor: number; zoomedOutFactor: number; }) => Promise`

Configures the zoom button displayed during scanning. visible - Show the button while scanning. positionX - X position in points. positionY - Y position in points. iconSize - Glyph point size. tintColor - Icon tint. Hex string (e.g., "#3472c9"); leave "" to use the default. backgroundColor - Button background. Hex string; default is clear. Leave "" to use the default. cornerRadius - Corner radius. padding - Inner padding around the glyph. useCustomIcon - Set true to use provided custom icons. customIconZoomedIn - Custom icon for the zoomed-in state as a Base64-encoded image string. customIconZoomedOut - Custom icon for the zoomed-out state as a Base64-encoded image string. zoomedInFactor - Zoom factor when toggled in. zoomedOutFactor - Zoom factor when toggled out.

| Param | Type | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |options | { visible: boolean; positionX: number; positionY: number; iconSize: number; tintColor: string; backgroundColor: string; cornerRadius: number; padding: number; useCustomIcon: boolean; customIconZoomedIn: string; customIconZoomedOut: string; zoomedInFactor: number; zoomedOutFactor: number; } |

Returns: Promise<any>

--------------------

`$3`

`typescript selectVisibleBarcodes() => Promise`

Selects all barcodes that are currently visible in AR mode.

Returns: Promise<any>

--------------------

`$3`

`typescript isFlashAvailable() => Promise`

Checks whether the device has a built-in flash (torch) that can be used for illumination during barcode scanning

Returns: Promise<any>

--------------------

`$3`

`typescript isCloseSessionOnResultEnabled() => Promise``

Enables or disables the automatic c