barkoder-capacitor

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 [e-mail]

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 [e-mail].

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:
6. Install Capacitor:

   npm install -g @capacitor/cli
   

7. Add Platforms:

   npx cap add ios
   npx cap add android
   

8. Open IDE and Start Coding:
   • Open your chosen IDE or text editor and start building your app using web technologies.
9. Build and Run:
   • Use Capacitor commands to build and run your app on different platforms.

   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

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:

npm install “/your-path/myApp/barkoder-capacitor”

Using the plugin

Angular

In your ts file:

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:

<div id="barkoderView" #barkoderView >

In your scss file set the desired barkoderView height:

#barkoderView {
   height: 400px;
}

API

• initialize(...)
• registerWithLicenseKey(...)
• setZoomFactor(...)
• setFlashEnabled(...)
• startCamera()
• startScanning()
• stopScanning()
• pauseScanning()
• 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(...)
• setDuplicatesDelayMs(...)
• setThresholdBetweenDuplicatesScans(...)
• setUpcEanDeblurEnabled(...)
• setMisshaped1DEnabled(...)
• setEnableVINRestrictions(...)
• setDatamatrixDpmModeEnabled(...)
• setQrDpmModeEnabled(...)
• setQrMicroDpmModeEnabled(...)
• configureBarkoder(...)
• setIdDocumentMasterChecksumEnabled(...)
• setUPCEexpandToUPCA(...)
• setUPCE1expandToUPCA(...)
• setCustomOption(...)
• setScanningIndicatorColor(...)
• setScanningIndicatorWidth(...)
• setScanningIndicatorAnimation(...)
• setScanningIndicatorAlwaysVisible(...)
• setDynamicExposure(...)
• setCentricFocusAndExposure(...)
• setEnableComposite(...)
• setVideoStabilization(...)
• setCamera(...)
• isFlashAvailable()
• isCloseSessionOnResultEnabled()
• isImageResultEnabled()
• isLocationInImageResultEnabled()
• isLocationInPreviewEnabled()
• isPinchToZoomEnabled()
• isRegionOfInterestVisible()
• isBeepOnSuccessEnabled()
• isVibrateOnSuccessEnabled()
• getVersion()
• getLocationLineColorHex()
• getRoiLineColorHex()
• getRoiOverlayBackgroundColorHex()
• getMaxZoomFactor()
• getLocationLineWidth()
• getRoiLineWidth()
• getRegionOfInterest()
• getBarcodeTypeLengthRange(...)
• getMsiChecksumType()
• getCode39ChecksumType()
• getCode11ChecksumType()
• getEncodingCharacterSet()
• getDecodingSpeed()
• getFormattingType()
• getThreadsLimit()
• getMaximumResultsCount()
• getDuplicatesDelayMs()
• isBarcodeTypeEnabled(...)
• getMulticodeCachingEnabled()
• getMulticodeCachingDuration()
• isUpcEanDeblurEnabled()
• isMisshaped1DEnabled()
• isBarcodeThumbnailOnResultEnabled()
• getThresholdBetweenDuplicatesScans()
• isVINRestrictionsEnabled()
• getBarkoderResolution()
• isDatamatrixDpmModeEnabled()
• isQrDpmModeEnabled()
• isQrMicroDpmModeEnabled()
• isIdDocumentMasterChecksumEnabled()
• getScanningIndicatorColorHex()
• getScanningIndicatorWidth()
• getScanningIndicatorAnimation()
• isScanningIndicatorAlwaysVisible()

initialize(...)

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

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

Returns: Promise<any>

---

registerWithLicenseKey(...)

registerWithLicenseKey(options: { licenseKey: string; }) => Promise<any>

Param	Type
options	{ licenseKey: string; }

Returns: Promise<any>

---

setZoomFactor(...)

setZoomFactor(options: { value: number; }) => Promise<any>

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>

---

setFlashEnabled(...)

setFlashEnabled(options: { enabled: boolean; }) => Promise<any>

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

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

startCamera()

startCamera() => Promise<any>

Returns: Promise<any>

---

startScanning()

startScanning() => Promise<any>

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

Returns: Promise<any>

---

stopScanning()

stopScanning() => Promise<any>

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

Returns: Promise<any>

---

pauseScanning()

pauseScanning() => Promise<any>

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

Returns: Promise<any>

---

scanImage(...)

scanImage(options: { base64: string; }) => Promise<any>

Scan barcodes from base64 string image

Param	Type
options	{ base64: string; }

Returns: Promise<any>

---

setLocationLineColor(...)

setLocationLineColor(options: { value: string; }) => Promise<any>

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>

---

setLocationLineWidth(...)

setLocationLineWidth(options: { value: number; }) => Promise<any>

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

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setRoiLineColor(...)

setRoiLineColor(options: { value: string; }) => Promise<any>

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>

---

setRoiLineWidth(...)

setRoiLineWidth(options: { value: number; }) => Promise<any>

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>

---

setRoiOverlayBackgroundColor(...)

setRoiOverlayBackgroundColor(options: { value: string; }) => Promise<any>

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>

---

setCloseSessionOnResultEnabled(...)

setCloseSessionOnResultEnabled(options: { enabled: boolean; }) => Promise<any>

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

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setImageResultEnabled(...)

setImageResultEnabled(options: { enabled: boolean; }) => Promise<any>

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

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setLocationInImageResultEnabled(...)

setLocationInImageResultEnabled(options: { enabled: boolean; }) => Promise<any>

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

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setRegionOfInterest(...)

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

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>

---

setThreadsLimit(...)

setThreadsLimit(options: { value: number; }) => Promise<any>

Sets the threads limit

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setLocationInPreviewEnabled(...)

setLocationInPreviewEnabled(options: { enabled: boolean; }) => Promise<any>

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

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setPinchToZoomEnabled(...)

setPinchToZoomEnabled(options: { enabled: boolean; }) => Promise<any>

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

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setRegionOfInterestVisible(...)

setRegionOfInterestVisible(options: { value: boolean; }) => Promise<any>

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

Param	Type
options	{ value: boolean; }

Returns: Promise<any>

---

setBarkoderResolution(...)

setBarkoderResolution(options: { value: number; }) => Promise<any>

Sets the resolution for barcode scanning

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setBeepOnSuccessEnabled(...)

setBeepOnSuccessEnabled(options: { enabled: boolean; }) => Promise<any>

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

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setVibrateOnSuccessEnabled(...)

setVibrateOnSuccessEnabled(options: { enabled: boolean; }) => Promise<any>

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

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

showLogMessages(...)

showLogMessages(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setBarcodeTypeLengthRange(...)

setBarcodeTypeLengthRange(options: { type: number; min: number; max: number; }) => Promise<any>

Sets the length range for the specified barcode type

Param	Type
options	{ type: number; min: number; max: number; }

Returns: Promise<any>

---

setEncodingCharacterSet(...)

setEncodingCharacterSet(options: { value: string; }) => Promise<any>

Sets the encoding character set for barcode scanning

Param	Type
options	{ value: string; }

Returns: Promise<any>

---

setDecodingSpeed(...)

setDecodingSpeed(options: { value: number; }) => Promise<any>

Sets the decoding speed for barcode scanning

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setFormattingType(...)

setFormattingType(options: { value: number; }) => Promise<any>

Sets the formatting type for barcode scanning

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setCode11ChecksumType(...)

setCode11ChecksumType(options: { value: number; }) => Promise<any>

Sets the Code11 checksum type

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setMsiChecksumType(...)

setMsiChecksumType(options: { value: number; }) => Promise<any>

Sets the MSI checksum type

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setCode39ChecksumType(...)

setCode39ChecksumType(options: { value: number; }) => Promise<any>

Sets the Code39 checksum type

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setBarcodeTypeEnabled(...)

setBarcodeTypeEnabled(options: { type: number; enabled: boolean; }) => Promise<any>

Sets whether a specific barcode type is enabled

Param	Type
options	{ type: number; enabled: boolean; }

Returns: Promise<any>

---

setMulticodeCachingEnabled(...)

setMulticodeCachingEnabled(options: { enabled: boolean; }) => Promise<any>

Sets whether multi-code caching is enabled

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setMulticodeCachingDuration(...)

setMulticodeCachingDuration(options: { value: number; }) => Promise<any>

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

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setMaximumResultsCount(...)

setMaximumResultsCount(options: { value: number; }) => Promise<any>

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

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setBarcodeThumbnailOnResultEnabled(...)

setBarcodeThumbnailOnResultEnabled(options: { enabled: boolean; }) => Promise<any>

A boolean indicating whether to enable barcode thumbnail on result.

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setDuplicatesDelayMs(...)

setDuplicatesDelayMs(options: { value: number; }) => Promise<any>

Sets the delay in milliseconds for considering duplicate barcodes during scanning

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setThresholdBetweenDuplicatesScans(...)

setThresholdBetweenDuplicatesScans(options: { value: number; }) => Promise<any>

Sets the threshold between duplicate scans

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setUpcEanDeblurEnabled(...)

setUpcEanDeblurEnabled(options: { enabled: boolean; }) => Promise<any>

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

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setMisshaped1DEnabled(...)

setMisshaped1DEnabled(options: { enabled: boolean; }) => Promise<any>

Sets whether the detection of misshaped 1D barcodes is enabled

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setEnableVINRestrictions(...)

setEnableVINRestrictions(options: { value: boolean; }) => Promise<any>

Sets whether Vehicle Identification Number (VIN) restrictions are enabled

Param	Type
options	{ value: boolean; }

Returns: Promise<any>

---

setDatamatrixDpmModeEnabled(...)

setDatamatrixDpmModeEnabled(options: { enabled: boolean; }) => Promise<any>

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

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setQrDpmModeEnabled(...)

setQrDpmModeEnabled(options: { enabled: boolean; }) => Promise<any>

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

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setQrMicroDpmModeEnabled(...)

setQrMicroDpmModeEnabled(options: { enabled: boolean; }) => Promise<any>

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

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

configureBarkoder(...)

configureBarkoder(options: { barkoderConfig: BarkoderConfig; }) => Promise<any>

Configures the Barkoder functionality based on the provided configuration

Param	Type
options	{ barkoderConfig: BarkoderConfig; }

Returns: Promise<any>

---

setIdDocumentMasterChecksumEnabled(...)

setIdDocumentMasterChecksumEnabled(options: { enabled: boolean; }) => Promise<any>

Sets whether Master checksum should be requiered when scanning ID Documents

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setUPCEexpandToUPCA(...)

setUPCEexpandToUPCA(options: { value: boolean; }) => Promise<any>

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

Param	Type
options	{ value: boolean; }

Returns: Promise<any>

---

setUPCE1expandToUPCA(...)

setUPCE1expandToUPCA(options: { value: boolean; }) => Promise<any>

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

Param	Type
options	{ value: boolean; }

Returns: Promise<any>

---

setCustomOption(...)

setCustomOption(options: { option: string; value: number; }) => Promise<any>

Sets a custom option with a string option and integer value

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

Returns: Promise<any>

---

setScanningIndicatorColor(...)

setScanningIndicatorColor(options: { value: string; }) => Promise<any>

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>

---

setScanningIndicatorWidth(...)

setScanningIndicatorWidth(options: { value: number; }) => Promise<any>

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

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setScanningIndicatorAnimation(...)

setScanningIndicatorAnimation(options: { value: number; }) => Promise<any>

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

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setScanningIndicatorAlwaysVisible(...)

setScanningIndicatorAlwaysVisible(options: { value: boolean; }) => Promise<any>

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

Param	Type
options	{ value: boolean; }

Returns: Promise<any>

---

setDynamicExposure(...)

setDynamicExposure(options: { value: number; }) => Promise<any>

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

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setCentricFocusAndExposure(...)

setCentricFocusAndExposure(options: { value: boolean; }) => Promise<any>

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

Param	Type
options	{ value: boolean; }

Returns: Promise<any>

---

setEnableComposite(...)

setEnableComposite(options: { value: number; }) => Promise<any>

Sets wheter Composite Mode should be enabled when scanning

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setVideoStabilization(...)

setVideoStabilization(options: { value: boolean; }) => Promise<any>

Enable or disable video stabilization for smoother video capture

Param	Type
options	{ value: boolean; }

Returns: Promise<any>

---

setCamera(...)

setCamera(options: { value: number; }) => Promise<any>

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

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

isFlashAvailable()

isFlashAvailable() => Promise<any>

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

Returns: Promise<any>

---

isCloseSessionOnResultEnabled()

isCloseSessionOnResultEnabled() => Promise<any>

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

Returns: Promise<any>

---

isImageResultEnabled()

isImageResultEnabled() => Promise<any>

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

Returns: Promise<any>

---

isLocationInImageResultEnabled()

isLocationInImageResultEnabled() => Promise<any>

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

Returns: Promise<any>

---

isLocationInPreviewEnabled()

isLocationInPreviewEnabled() => Promise<any>

Checks if location in preview is enabled

Returns: Promise<any>

---

isPinchToZoomEnabled()

isPinchToZoomEnabled() => Promise<any>

Checks if pinch to zoom is enabled

Returns: Promise<any>

---

isRegionOfInterestVisible()

isRegionOfInterestVisible() => Promise<any>

Checks if the region of interest (ROI) is visible

Returns: Promise<any>

---

isBeepOnSuccessEnabled()

isBeepOnSuccessEnabled() => Promise<any>

Retrieves the value indicating whether a beep sound is played on successful barcode scanning

Returns: Promise<any>

---

isVibrateOnSuccessEnabled()

isVibrateOnSuccessEnabled() => Promise<any>

Retrieves the value indicating whether vibration is enabled on successful barcode scanning

Returns: Promise<any>

---

getVersion()

getVersion() => Promise<any>

Retrieves the version of the Barkoder library

Returns: Promise<any>

---

getLocationLineColorHex()

getLocationLineColorHex() => Promise<any>

Retrieves the hexadecimal color code representing the line color used to indicate the location of detected barcodes

Returns: Promise<any>

---

getRoiLineColorHex()

getRoiLineColorHex() => Promise<any>

Retrieves the hexadecimal color code representing the line color of the Region of Interest (ROI) on the camera preview

Returns: Promise<any>

---

getRoiOverlayBackgroundColorHex()

getRoiOverlayBackgroundColorHex() => Promise<any>

Retrieves the hexadecimal color code representing the background color of the overlay within the Region of Interest (ROI) on the camera preview

Returns: Promise<any>

---

getMaxZoomFactor()

getMaxZoomFactor() => Promise<any>

Retrieves the maximum available zoom factor for the device's camera

Returns: Promise<any>

---

getLocationLineWidth()

getLocationLineWidth() => Promise<any>

Retrieves the current width setting for the lines indicating the location of detected barcodes on the camera feed

Returns: Promise<any>

---

getRoiLineWidth()

getRoiLineWidth() => Promise<any>

Retrieves the current width setting for the lines outlining the Region of Interest (ROI) on the camera preview

Returns: Promise<any>

---

getRegionOfInterest()

getRegionOfInterest() => Promise<any>

Retrieves the region of interest (ROI)

Returns: Promise<any>

---

getBarcodeTypeLengthRange(...)

getBarcodeTypeLengthRange(options: { type: number; }) => Promise<any>

Retrieves the length range of a specific barcode type

Param	Type
options	{ type: number; }

Returns: Promise<any>

---

getMsiChecksumType()

getMsiChecksumType() => Promise<any>

Retrieves the MSI checksum type

Returns: Promise<any>

---

getCode39ChecksumType()

getCode39ChecksumType() => Promise<any>

Retrieves the checksum type for Code 39 barcodes

Returns: Promise<any>

---

getCode11ChecksumType()

getCode11ChecksumType() => Promise<any>

Retrieves the Code11 checksum type

Returns: Promise<any>

---

getEncodingCharacterSet()

getEncodingCharacterSet() => Promise<any>

Retrieves the character set used for encoding barcode data

Returns: Promise<any>

---

getDecodingSpeed()

getDecodingSpeed() => Promise<any>

Retrieves the current decoding speed setting for barcode scanning

Returns: Promise<any>

---

getFormattingType()

getFormattingType() => Promise<any>

Retrieves the formatting type used for presenting decoded barcode data.

Returns: Promise<any>

---

getThreadsLimit()

getThreadsLimit() => Promise<any>

Retrieves the threads limit

Returns: Promise<any>

---

getMaximumResultsCount()

getMaximumResultsCount() => Promise<any>

Retrieves the maximum number of results to be returned from barcode scanning at once

Returns: Promise<any>

---

getDuplicatesDelayMs()

getDuplicatesDelayMs() => Promise<any>

Retrieves the delay in milliseconds for considering duplicate barcodes during scanning

Returns: Promise<any>

---

isBarcodeTypeEnabled(...)

isBarcodeTypeEnabled(options: { type: number; }) => Promise<any>

Checks if a specific barcode type is enabled

Param	Type
options	{ type: number; }

Returns: Promise<any>

---

getMulticodeCachingEnabled()

getMulticodeCachingEnabled() => Promise<any>

Retrieves whether multi-code caching is enabled

Returns: Promise<any>

---

getMulticodeCachingDuration()

getMulticodeCachingDuration() => Promise<any>

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

Returns: Promise<any>

---

isUpcEanDeblurEnabled()

isUpcEanDeblurEnabled() => Promise<any>

Retrieves the value indicating whether deblurring is enabled for UPC/EAN barcodes

Returns: Promise<any>

---

isMisshaped1DEnabled()

isMisshaped1DEnabled() => Promise<any>

Checks if the detection of misshaped 1D barcodes is enabled

Returns: Promise<any>

---

isBarcodeThumbnailOnResultEnabled()

isBarcodeThumbnailOnResultEnabled() => Promise<any>

Retrieve whether to enable barcode thumbnail on result

Returns: Promise<any>

---

getThresholdBetweenDuplicatesScans()

getThresholdBetweenDuplicatesScans() => Promise<any>

Retrieves the threshold between duplicate scans

Returns: Promise<any>

---

isVINRestrictionsEnabled()

isVINRestrictionsEnabled() => Promise<any>

Checks if VIN restrictions are enabled

Returns: Promise<any>

---

getBarkoderResolution()

getBarkoderResolution() => Promise<any>

Retrieves the resolution for barcode scanning

Returns: Promise<any>

---

isDatamatrixDpmModeEnabled()

isDatamatrixDpmModeEnabled() => Promise<any>

Retrieves whether Direct Part Marking (DPM) mode for Datamatrix barcodes is enabled

Returns: Promise<any>

---

isQrDpmModeEnabled()

isQrDpmModeEnabled() => Promise<any>

Retrieves whether Direct Part Marking (DPM) mode for QR barcodes is enabled

Returns: Promise<any>

---

isQrMicroDpmModeEnabled()

isQrMicroDpmModeEnabled() => Promise<any>

Retrieves whether Direct Part Marking (DPM) mode for QR Micro barcodes is enabled

Returns: Promise<any>

---

isIdDocumentMasterChecksumEnabled()

isIdDocumentMasterChecksumEnabled() => Promise<any>

Retrieves whether Master checksum is enabled when scanning ID Documents

Returns: Promise<any>

---

getScanningIndicatorColorHex()

getScanningIndicatorColorHex() => Promise<any>

Retrieves the hexadecimal color code representing the line color of the scanning indicator on the camera preview

Returns: Promise<any>

---

getScanningIndicatorWidth()

getScanningIndicatorWidth() => Promise<any>

Retrieves the current width setting for the scanning indicator on the camera preview

Returns: Promise<any>

---

getScanningIndicatorAnimation()

getScanningIndicatorAnimation() => Promise<any>

Retrieves the current animation setting for the scanning indicator on the camera preview

Returns: Promise<any>

---

isScanningIndicatorAlwaysVisible()

isScanningIndicatorAlwaysVisible() => Promise<any>

Retrieves if the scanning indicator is set to be always visible on the camera preview

Returns: Promise<any>

---