API reference for barKoder's Capacitor Barcode Reader SDK

API: #

initialize(...) #

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

Returns: Promise<any>

registerWithLicenseKey(...) #

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

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

Returns: Promise<any>

setFlashEnabled(...) #

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

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

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>

freezeScanning() #

                freezeScanning() => Promise<any>
            

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>

unfreezeScanning() #

                unfreezeScanning() => Promise<any>
            

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>

captureImage() #

                captureImage() => Promise<any>
            

Captures the latest camera frame

Returns: Promise<any>

scanImage(...) #

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

Scan barcodes from base64 string image

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

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

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

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

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

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

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

Returns: Promise<any>

setLocationInImageResultEnabled(...) #

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

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

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

Returns: Promise<any>

setThreadsLimit(...) #

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

Sets the threads limit

Returns: Promise<any>

setLocationInPreviewEnabled(...) #

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

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

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

Returns: Promise<any>

setRegionOfInterestVisible(...) #

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

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

Returns: Promise<any>

setBarkoderResolution(...) #

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

Sets the resolution for barcode scanning

Returns: Promise<any>

setBeepOnSuccessEnabled(...) #

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

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

Returns: Promise<any>

setVibrateOnSuccessEnabled(...) #

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

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

Returns: Promise<any>

showLogMessages(...) #

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

Returns: Promise<any>

setBarcodeTypeLengthRange(...) #

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

Sets the length range for the specified barcode type

Returns: Promise<any>

setEncodingCharacterSet(...) #

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

Sets the encoding character set for barcode scanning

Returns: Promise<any>

setDecodingSpeed(...) #

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

Sets the decoding speed for barcode scanning

Returns: Promise<any>

setFormattingType(...) #

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

Sets the formatting type for barcode scanning

Returns: Promise<any>

setCode11ChecksumType(...) #

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

Sets the Code11 checksum type

Returns: Promise<any>

setMsiChecksumType(...) #

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

Sets the MSI checksum type

Returns: Promise<any>

setCode39ChecksumType(...) #

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

Sets the Code39 checksum type

Returns: Promise<any>

setBarcodeTypeEnabled(...) #

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

Sets whether a specific barcode type is enabled

Returns: Promise<any>

setMulticodeCachingEnabled(...) #

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

Sets whether multi-code caching is enabled

Returns: Promise<any>

setMulticodeCachingDuration(...) #

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

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

Returns: Promise<any>

setMaximumResultsCount(...) #

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

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

Returns: Promise<any>

setBarcodeThumbnailOnResultEnabled(...) #

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

A boolean indicating whether to enable barcode thumbnail on result.

Returns: Promise<any>

setThresholdBetweenDuplicatesScans(...) #

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

Sets the threshold between duplicate scans

Returns: Promise<any>

setUpcEanDeblurEnabled(...) #

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

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

Returns: Promise<any>

setMisshaped1DEnabled(...) #

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

Sets whether the detection of misshaped 1D barcodes is enabled

Returns: Promise<any>

setEnableVINRestrictions(...) #

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

Sets whether Vehicle Identification Number (VIN) restrictions are enabled

Returns: Promise<any>

setDatamatrixDpmModeEnabled(...) #

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

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

Returns: Promise<any>

setQrDpmModeEnabled(...) #

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

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

Returns: Promise<any>

setQrMicroDpmModeEnabled(...) #

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

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

Returns: Promise<any>

setQrMultiPartMergeEnabled(...) #

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

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

Returns: Promise<any>

configureBarkoder(...) #

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

Configures the Barkoder functionality based on the provided configuration

Returns: Promise<any>

setIdDocumentMasterChecksumEnabled(...) #

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

Sets whether Master checksum should be requiered when scanning ID Documents

Returns: Promise<any>

setUPCEexpandToUPCA(...) #

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

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

Returns: Promise<any>

setUPCE1expandToUPCA(...) #

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

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

Returns: Promise<any>

setCustomOption(...) #

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

Sets a custom option with a string option and integer value

Returns: Promise<any>

setCustomOptionGlobal(...) #

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

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

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

Returns: Promise<any>

setScanningIndicatorWidth(...) #

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

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

Returns: Promise<any>

setScanningIndicatorAnimation(...) #

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

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

Returns: Promise<any>

setScanningIndicatorAlwaysVisible(...) #

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

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

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

Returns: Promise<any>

setCentricFocusAndExposure(...) #

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

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

Returns: Promise<any>

setEnableComposite(...) #

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

Sets wheter Composite Mode should be enabled when scanning

Returns: Promise<any>

setVideoStabilization(...) #

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

Enable or disable video stabilization for smoother video capture

Returns: Promise<any>

setCamera(...) #

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

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

Returns: Promise<any>

setShowDuplicatesLocations(...) #

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

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

Returns: Promise<any>

setARMode(...) #

                setARMode(options: { value: BarkoderARMode; }) => Promise<any>
            

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

Returns: Promise<any>

setARResultDisappearanceDelayMs(...) #

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

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

Returns: Promise<any>

setARLocationTransitionSpeed(...) #

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

Sets the speed at which barcode location overlays transition positions.

Returns: Promise<any>

setAROverlayRefresh(...) #

                setAROverlayRefresh(options: { value: BarkoderAROverlayRefresh; }) => Promise<any>
            

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

Returns: Promise<any>

setARSelectedLocationColor(...) #

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

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

Returns: Promise<any>

setARNonSelectedLocationColor(...) #

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

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

Returns: Promise<any>

setARSelectedLocationLineWidth(...) #

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

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

Returns: Promise<any>

setARNonSelectedLocationLineWidth(...) #

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

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

Returns: Promise<any>

setARLocationType(...) #

                setARLocationType(options: { value: BarkoderARLocationType; }) => Promise<any>
            

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

Returns: Promise<any>

setARDoubleTapToFreezeEnabled(...) #

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

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

Returns: Promise<any>

setARImageResultEnabled(...) #

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

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

Returns: Promise<any>

setARBarcodeThumbnailOnResultEnabled(...) #

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

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

Returns: Promise<any>

setARResultLimit(...) #

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

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

Returns: Promise<any>

setARContinueScanningOnLimit(...) #

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

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

Returns: Promise<any>

setAREmitResultsAtSessionEndOnly(...) #

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

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

Returns: Promise<any>

setARHeaderHeight(...) #

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

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

Returns: Promise<any>

setARHeaderShowMode(...) #

                setARHeaderShowMode(options: { value: BarkoderARHeaderShowMode; }) => Promise<any>
            

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

Returns: Promise<any>

setARHeaderMaxTextHeight(...) #

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

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

Returns: Promise<any>

setARHeaderMinTextHeight(...) #

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

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

Returns: Promise<any>

setARHeaderTextColorSelected(...) #

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

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

Returns: Promise<any>

setARHeaderTextColorNonSelected(...) #

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

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

Returns: Promise<any>

setARHeaderHorizontalTextMargin(...) #

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

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

Returns: Promise<any>

setARHeaderVerticalTextMargin(...) #

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

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

Returns: Promise<any>

setARHeaderTextFormat(...) #

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

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

Returns: Promise<any>

configureCloseButton(...) #

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

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.

Returns: Promise<any>

configureFlashButton(...) #

                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<any>
            

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.

Returns: Promise<any>

configureZoomButton(...) #

                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<any>
            

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.

Returns: Promise<any>

selectVisibleBarcodes() #

                selectVisibleBarcodes() => Promise<any>
            

Selects all barcodes that are currently visible in AR mode.

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 SDK

Returns: Promise<any>

getLibVersion() #

                getLibVersion() => 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>

getCurrentZoomFactor() #

                getCurrentZoomFactor() => Promise<any>
            

Retrieves the current 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

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>

isBarcodeTypeEnabled(...) #

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

Checks if a specific barcode type is enabled

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>

isQrMultiPartMergeEnabled() #

                isQrMultiPartMergeEnabled() => Promise<any>
            

Retrieves whether the QR multi-part merge mode 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>

getShowDuplicatesLocations() #

                getShowDuplicatesLocations() => Promise<any>
            

Retrieves whether showing duplicate barcode locations is enabled.

Returns: Promise<any>

getARMode() #

                getARMode() => Promise<any>
            

Retrieves the current AR mode used for barcode scanning.

Returns: Promise<any>

getARResultDisappearanceDelayMs() #

                getARResultDisappearanceDelayMs() => Promise<any>
            

Retrieves the delay (in milliseconds) after which AR results disappear once detected.

Returns: Promise<any>

getARLocationTransitionSpeed() #

                getARLocationTransitionSpeed() => Promise<any>
            

Retrieves the transition speed for moving AR barcode locations on the screen.

Returns: Promise<any>

getAROverlayRefresh() #

                getAROverlayRefresh() => Promise<any>
            

Retrieves the current AR overlay refresh mode.

Returns: Promise<any>

getARSelectedLocationColor() #

                getARSelectedLocationColor() => Promise<any>
            

Retrieves the color used to highlight selected barcode locations in AR mode.

Returns: Promise<any>

getARNonSelectedLocationColor() #

                getARNonSelectedLocationColor() => Promise<any>
            

Retrieves the color used to highlight non-selected barcode locations in AR mode.

Returns: Promise<any>

getARSelectedLocationLineWidth() #

                getARSelectedLocationLineWidth() => Promise<any>
            

Retrieves the line width used for selected barcode locations in AR mode.

Returns: Promise<any>

getARNonSelectedLocationLineWidth() #

                getARNonSelectedLocationLineWidth() => Promise<any>
            

Retrieves the line width used for non-selected barcode locations in AR mode.

Returns: Promise<any>

getARLocationType() #

                getARLocationType() => Promise<any>
            

Retrieves the location type style used for drawing AR overlays (tight, bounding box, or none).

Returns: Promise<any>

isARDoubleTapToFreezeEnabled() #

                isARDoubleTapToFreezeEnabled() => Promise<any>
            

Checks if the double-tap-to-freeze feature is enabled in AR mode.

Returns: Promise<any>

isARImageResultEnabled() #

                isARImageResultEnabled() => Promise<any>
            

Retrieves whether image result is enabled for AR mode.

Returns: Promise<any>

isARBarcodeThumbnailOnResultEnabled() #

                isARBarcodeThumbnailOnResultEnabled() => Promise<any>
            

Retrieves whether barcode thumbnail on result is enabled for AR mode.

Returns: Promise<any>

getARResultLimit() #

                getARResultLimit() => Promise<any>
            

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

Returns: Promise<any>

getARContinueScanningOnLimit() #

                getARContinueScanningOnLimit() => Promise<any>
            

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

Returns: Promise<any>

getAREmitResultsAtSessionEndOnly() #

                getAREmitResultsAtSessionEndOnly() => Promise<any>
            

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

Returns: Promise<any>

getARHeaderHeight() #

                getARHeaderHeight() => Promise<any>
            

Retrieves the height of the header text shown above barcodes in AR mode.

Returns: Promise<any>

getARHeaderShowMode() #

                getARHeaderShowMode() => Promise<any>
            

Retrieves the display mode for AR header text (always, on selected, or never).

Returns: Promise<any>

getARHeaderMaxTextHeight() #

                getARHeaderMaxTextHeight() => Promise<any>
            

Retrieves the maximum height for AR header text.

Returns: Promise<any>

getARHeaderMinTextHeight() #

                getARHeaderMinTextHeight() => Promise<any>
            

Retrieves the minimum height for AR header text.

Returns: Promise<any>

getARHeaderTextColorSelected() #

                getARHeaderTextColorSelected() => Promise<any>
            

Retrieves the color used for header text when a barcode is selected in AR mode.

Returns: Promise<any>

getARHeaderTextColorNonSelected() #

                getARHeaderTextColorNonSelected() => Promise<any>
            

Retrieves the color used for header text when a barcode is not selected in AR mode.

Returns: Promise<any>

getARHeaderHorizontalTextMargin() #

                getARHeaderHorizontalTextMargin() => Promise<any>
            

Retrieves the horizontal margin applied to the AR header text.

Returns: Promise<any>

getARHeaderVerticalTextMargin() #

                getARHeaderVerticalTextMargin() => Promise<any>
            

Retrieves the vertical margin applied to the AR header text.

Returns: Promise<any>

getARHeaderTextFormat() #

                getARHeaderTextFormat() => Promise<any>
            

Retrieves the format string used for rendering AR header text above barcodes.

Returns: Promise<any>