API reference

Every method, setting, enum and result of the barKoder Cordova SDK, grouped by what you do with it.

Scanning & session #

initialize #

initialize(width: number, height: number, x: number, y: number)

Initializes the Barkoder scanner with the specified dimensions and position.

Parameters:

registerWithLicenseKey #

registerWithLicenseKey(licenseKey: string)

Registers the Barkoder scanner with the specified license key.

Parameters:

startScanning #

startScanning(success: (data: any) => void, error: (err: any) => void)

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

Parameters:

stopScanning #

stopScanning()

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

pauseScanning #

pauseScanning()

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

freezeScanning #

freezeScanning()

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.

unfreezeScanning #

unfreezeScanning()

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.

setThreadsLimit #

setThreadsLimit(threadsLimit: number)

Sets the threads limit for decoding operations.

Parameters:

getThreadsLimit #

getThreadsLimit()

Retrieves the threads limit.

setDecodingSpeed #

setDecodingSpeed(decodingSpeed: number)

Sets the decoding speed for barcode scanning.

Parameters:

getDecodingSpeed #

getDecodingSpeed()

Retrieves the current decoding speed setting for barcode scanning.

setMatchFilter #

setMatchFilter(value: string)

Sets a string or regular expression used to match decoded barcode data.

Parameters:

getMatchFilter #

getMatchFilter()

Retrieves the string or regular expression used to match decoded barcode data.

setUPCEexpandToUPCA #

setUPCEexpandToUPCA(enabled: boolean)

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

Parameters:

setUPCE1expandToUPCA #

setUPCE1expandToUPCA(enabled: boolean)

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

Parameters:

setDynamicExposure #

setDynamicExposure(intensity: number)

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

Parameters:

setVideoStabilization #

setVideoStabilization(value: boolean)

Enables or disables video stabilization for smoother video capture.

Parameters:

configureBarkoder #

configureBarkoder(barkoderConfig: object)

Configures the Barkoder functionality based on the provided configuration.

Parameters:

setPowerSavingMode #

setPowerSavingMode(powerSavingMode: number)

Power saving mode level. Higher values reduce CPU/battery usage by limiting frame processing.

Default value is 0. 0 - Disabled (full performance) 1 - Light saving 2 - Medium saving 3 - High saving 4 - Maximum saving

Parameters:

getPowerSavingMode #

getPowerSavingMode()

Retrieves the power saving mode level.

selectVisibleBarcodes #

selectVisibleBarcodes()

Selects all barcodes that are currently visible in AR mode.

getVersion #

getVersion()

Retrieves the version of the Barkoder SDK.

getLibVersion #

getLibVersion()

Retrieves the version of the Barkoder library.

getDeviceId #

getDeviceId()

Retrieves the Device ID.

Camera #

startCamera #

startCamera()

Starts the camera for barcode scanning preparation.

setZoomFactor #

setZoomFactor(zoomFactor: number)

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

Parameters:

getCurrentZoomFactor #

getCurrentZoomFactor()

Retrieves the current zoom factor for the device's camera.

getMaxZoomFactor #

getMaxZoomFactor()

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

setFlashEnabled #

setFlashEnabled(enabled: boolean)

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

Parameters:

isFlashAvailable #

isFlashAvailable()

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

setLocationInPreviewEnabled #

setLocationInPreviewEnabled(enabled: boolean)

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

Parameters:

isLocationInPreviewEnabled #

isLocationInPreviewEnabled()

Checks if location in preview is enabled.

setPinchToZoomEnabled #

setPinchToZoomEnabled(enabled: boolean)

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

Parameters:

isPinchToZoomEnabled #

isPinchToZoomEnabled()

Checks if pinch to zoom is enabled.

setBarkoderResolution #

setBarkoderResolution(resolution: number)

Sets the resolution for barcode scanning.

Parameters:

getBarkoderResolution #

getBarkoderResolution()

Retrieves the resolution for barcode scanning.

setCentricFocusAndExposure #

setCentricFocusAndExposure(value: boolean)

Sets the camera to use the center of the viewfinder for focus and exposure.

Parameters:

setCamera #

setCamera(value: number)

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

Parameters:

setPreviewMirrored #

setPreviewMirrored(value: boolean)

Controls whether the front camera preview is horizontally mirrored.

Parameters:

isPreviewMirrored #

isPreviewMirrored()

Retrieves whether the front camera preview is horizontally mirrored.

Barcode types #

setBarcodeTypeEnabled #

setBarcodeTypeEnabled(type: number, enabled: boolean)

Sets whether a specific barcode type is enabled.

Parameters:

isBarcodeTypeEnabled #

isBarcodeTypeEnabled(type: number)

Checks if a specific barcode type is enabled.

Parameters:

setBarcodeTypeLengthRange #

setBarcodeTypeLengthRange(type: number, min: number, max: number)

Sets the length range for the specified barcode type.

Parameters:

getBarcodeTypeLengthRange #

getBarcodeTypeLengthRange(type: number)

Retrieves the length range of a specific barcode type.

Parameters:

setEncodingCharacterSet #

setEncodingCharacterSet(characterSet: string)

Sets the encoding character set for barcode scanning.

Parameters:

getEncodingCharacterSet #

getEncodingCharacterSet()

Retrieves the character set used for encoding barcode data.

setFormattingType #

setFormattingType(formattingType: number)

Sets the formatting type for barcode scanning.

Parameters:

getFormattingType #

getFormattingType()

Retrieves the formatting type used for presenting decoded barcode data.

setCode11ChecksumType #

setCode11ChecksumType(checksumType: number)

Sets the Code11 checksum type.

Parameters:

getCode11ChecksumType #

getCode11ChecksumType()

Retrieves the Code11 checksum type.

setMsiChecksumType #

setMsiChecksumType(checksumType: number)

Sets the MSI checksum type.

Parameters:

getMsiChecksumType #

getMsiChecksumType()

Retrieves the MSI checksum type.

setCode39ChecksumType #

setCode39ChecksumType(checksumType: number)

Sets the Code39 checksum type.

Parameters:

getCode39ChecksumType #

getCode39ChecksumType()

Retrieves the checksum type for Code 39 barcodes.

setUpcEanDeblurEnabled #

setUpcEanDeblurEnabled(enabled: boolean)

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

Parameters:

isUpcEanDeblurEnabled #

isUpcEanDeblurEnabled()

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

setMisshaped1DEnabled #

setMisshaped1DEnabled(enabled: boolean)

Sets whether the detection of misshaped 1D barcodes is enabled.

Parameters:

isMisshaped1DEnabled #

isMisshaped1DEnabled()

Checks if the detection of misshaped 1D barcodes is enabled.

setEnableVINRestrictions #

setEnableVINRestrictions(enableVINRestrictions: boolean)

Sets whether Vehicle Identification Number (VIN) restrictions are enabled.

Parameters:

isVINRestrictionsEnabled #

isVINRestrictionsEnabled()

Checks if VIN restrictions are enabled.

setDatamatrixDpmModeEnabled #

setDatamatrixDpmModeEnabled(enabled: boolean)

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

Parameters:

isDatamatrixDpmModeEnabled #

isDatamatrixDpmModeEnabled()

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

setQrDpmModeEnabled #

setQrDpmModeEnabled(enabled: boolean)

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

Parameters:

isQrDpmModeEnabled #

isQrDpmModeEnabled()

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

setQrMicroDpmModeEnabled #

setQrMicroDpmModeEnabled(enabled: boolean)

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

Parameters:

isQrMicroDpmModeEnabled #

isQrMicroDpmModeEnabled()

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

setQrMultiPartMergeEnabled #

setQrMultiPartMergeEnabled(enabled: boolean)

Sets whether the QR multi-part merge is enabled.

Parameters:

isQrMultiPartMergeEnabled #

isQrMultiPartMergeEnabled()

Retrieves whether QR multi-part merge is enabled.

setIdDocumentMasterChecksumEnabled #

setIdDocumentMasterChecksumEnabled(enabled: boolean)

Sets whether Master checksum should be required when scanning ID Documents.

Parameters:

isIdDocumentMasterChecksumEnabled #

isIdDocumentMasterChecksumEnabled()

Retrieves whether Master checksum is enabled when scanning ID Documents.

setCustomOption #

setCustomOption(option: string, value: number)

Sets a custom option.

See more details about available options and their values.

Parameters:

setCustomOptionGlobal #

setCustomOptionGlobal(option: string, value: number)

Sets a custom option globally (must be called before initialize(), which creates the native configuration).

Parameters:

setEnableComposite #

setEnableComposite(value: number)

Sets whether Composite Mode should be enabled when scanning.

Parameters:

Results #

captureImage #

captureImage()

Captures the latest camera frame.

scanImage #

scanImage(base64: string, success: (data: any) => void, error: (err: any) => void)

Scan barcodes from a base64 string image.

Parameters:

setCloseSessionOnResultEnabled #

setCloseSessionOnResultEnabled(enabled: boolean)

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

Parameters:

isCloseSessionOnResultEnabled #

isCloseSessionOnResultEnabled()

Checks if the automatic closing of the scanning session upon detection is enabled.

setImageResultEnabled #

setImageResultEnabled(enabled: boolean)

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

Parameters:

isImageResultEnabled #

isImageResultEnabled()

Checks if the capturing and processing of image data when a barcode is successfully detected is enabled.

setBeepOnSuccessEnabled #

setBeepOnSuccessEnabled(enabled: boolean)

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

Parameters:

isBeepOnSuccessEnabled #

isBeepOnSuccessEnabled()

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

setVibrateOnSuccessEnabled #

setVibrateOnSuccessEnabled(enabled: boolean)

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

Parameters:

isVibrateOnSuccessEnabled #

isVibrateOnSuccessEnabled()

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

setReturnOnlyMatchedResults #

setReturnOnlyMatchedResults(value: boolean)

Controls whether only results matching the configured match filter are returned.

If false, all decoded results are returned, including unmatched results.

This option only applies when a match filter is active.

Parameters:

getReturnOnlyMatchedResults #

getReturnOnlyMatchedResults()

Retrieves whether only results matching the configured match filter are returned.

setMulticodeCachingEnabled #

setMulticodeCachingEnabled(enabled: boolean)

Sets whether multi-code caching is enabled.

Parameters:

getMulticodeCachingEnabled #

getMulticodeCachingEnabled()

Retrieves whether multi-code caching is enabled.

setMulticodeCachingDuration #

setMulticodeCachingDuration(duration: number)

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

Parameters:

getMulticodeCachingDuration #

getMulticodeCachingDuration()

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

setMaximumResultsCount #

setMaximumResultsCount(resultsCount: number)

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

Parameters:

getMaximumResultsCount #

getMaximumResultsCount()

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

setThresholdBetweenDuplicatesScans #

setThresholdBetweenDuplicatesScans(thresholdBetweenDuplicatesScans: number)

Sets the threshold between duplicate scans.

Parameters:

getThresholdBetweenDuplicatesScans #

getThresholdBetweenDuplicatesScans()

Retrieves the threshold between duplicate scans.

setBarcodeThumbnailOnResultEnabled #

setBarcodeThumbnailOnResultEnabled(enabled: boolean)

Enables or disables the barcode thumbnail on result.

Parameters:

isBarcodeThumbnailOnResultEnabled #

isBarcodeThumbnailOnResultEnabled()

Checks if the barcode thumbnail on result is enabled.

setShowDuplicatesLocations #

setShowDuplicatesLocations(value: boolean)

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

Parameters:

getShowDuplicatesLocations #

getShowDuplicatesLocations()

Retrieves whether showing duplicate barcode locations in the AR view is enabled.

Region & overlay #

setLocationLineColor #

setLocationLineColor(hexColor: string)

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

Parameters:

getLocationLineColorHex #

getLocationLineColorHex()

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

setLocationLineWidth #

setLocationLineWidth(lineWidth: number)

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

Parameters:

getLocationLineWidth #

getLocationLineWidth()

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

setRoiLineColor #

setRoiLineColor(hexColor: string)

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

Parameters:

getRoiLineColorHex #

getRoiLineColorHex()

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

setRoiLineWidth #

setRoiLineWidth(lineWidth: number)

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

Parameters:

getRoiLineWidth #

getRoiLineWidth()

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

setRoiOverlayBackgroundColor #

setRoiOverlayBackgroundColor(hexColor: string)

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

Parameters:

getRoiOverlayBackgroundColorHex #

getRoiOverlayBackgroundColorHex()

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

setRegionOfInterest #

setRegionOfInterest(left: number, top: number, width: number, height: number)

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

Parameters:

getRegionOfInterest #

getRegionOfInterest()

Retrieves the region of interest (ROI) configuration.

setRegionOfInterestVisible #

setRegionOfInterestVisible(regionOfInterestVisible: boolean)

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

Parameters:

isRegionOfInterestVisible #

isRegionOfInterestVisible()

Checks if the region of interest (ROI) is visible.

setRoiCenterMark #

setRoiCenterMark(value: number)

Sets the visual marker displayed at the center of the Region of Interest (ROI).

Parameters:

getRoiCenterMark #

getRoiCenterMark()

Retrieves the visual marker displayed at the center of the Region of Interest (ROI).

setScanningIndicatorColor #

setScanningIndicatorColor(hexColor: string)

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

Parameters:

getScanningIndicatorColorHex #

getScanningIndicatorColorHex()

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

setScanningIndicatorWidth #

setScanningIndicatorWidth(lineWidth: number)

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

Parameters:

getScanningIndicatorWidth #

getScanningIndicatorWidth()

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

setScanningIndicatorAnimation #

setScanningIndicatorAnimation(animation: number)

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

Parameters:

getScanningIndicatorAnimation #

getScanningIndicatorAnimation()

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

setScanningIndicatorAlwaysVisible #

setScanningIndicatorAlwaysVisible(value: boolean)

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

Parameters:

isScanningIndicatorAlwaysVisible #

isScanningIndicatorAlwaysVisible()

Retrieves whether the scanning indicator is always visible on the camera preview.

setLocationInImageResultEnabled #

setLocationInImageResultEnabled(enabled: boolean)

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

Parameters:

isLocationInImageResultEnabled #

isLocationInImageResultEnabled()

Checks if the inclusion of barcode location information within the image data result is enabled.

AR mode #

setARMode #

setARMode(value: number)

Sets the AR mode used for barcode scanning visualization.

Parameters:

getARMode #

getARMode()

Retrieves the current AR mode used for barcode scanning.

setARReturnOnlyMatchedResults #

setARReturnOnlyMatchedResults(value: boolean)

Controls whether only matched results are returned in AR match filter mode.

If false, all detected results are returned, while unmatched results have isMatched set to false.

This option only applies when AR mode is matchFilter and a match filter is active.

Parameters:

getARReturnOnlyMatchedResults #

getARReturnOnlyMatchedResults()

Retrieves whether only matched results are returned in AR match filter mode.

setARDisplayOnlyMatchedResults #

setARDisplayOnlyMatchedResults(value: boolean)

Controls whether only matched results are displayed in AR match filter mode.

If false, all decoded results are displayed, including unmatched results.

This option only applies when AR mode is matchFilter and a match filter is active.

Parameters:

getARDisplayOnlyMatchedResults #

getARDisplayOnlyMatchedResults()

Retrieves whether only matched results are displayed in AR match filter mode.

setARResultDisappearanceDelayMs #

setARResultDisappearanceDelayMs(value: number)

Sets the delay after which a detected AR result is considered expired.

Parameters:

getARResultDisappearanceDelayMs #

getARResultDisappearanceDelayMs()

Retrieves the delay after which AR results disappear once detected.

setARLocationTransitionSpeed #

setARLocationTransitionSpeed(value: number)

Sets the speed of overlay transition for AR barcode locations.

Parameters:

getARLocationTransitionSpeed #

getARLocationTransitionSpeed()

Retrieves the transition speed for AR barcode location overlays.

setAROverlayRefresh #

setAROverlayRefresh(value: number)

Sets the refresh mode for the AR overlay.

Parameters:

getAROverlayRefresh #

getAROverlayRefresh()

Retrieves the AR overlay refresh mode.

setARSelectedLocationColor #

setARSelectedLocationColor(value: string)

Sets the overlay color for selected barcodes in AR mode.

Parameters:

getARSelectedLocationColor #

getARSelectedLocationColor()

Retrieves the color used for selected barcode overlays in AR mode.

setARNonSelectedLocationColor #

setARNonSelectedLocationColor(value: string)

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

Parameters:

getARNonSelectedLocationColor #

getARNonSelectedLocationColor()

Retrieves the color used for non-selected barcode overlays in AR mode.

setARSelectedLocationLineWidth #

setARSelectedLocationLineWidth(value: number)

Sets line width for selected barcode overlay.

Parameters:

getARSelectedLocationLineWidth #

getARSelectedLocationLineWidth()

Retrieves the line width for selected barcode overlays in AR mode.

setARNonSelectedLocationLineWidth #

setARNonSelectedLocationLineWidth(value: number)

Sets line width for non-selected barcode overlay.

Parameters:

getARNonSelectedLocationLineWidth #

getARNonSelectedLocationLineWidth()

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

setARLocationType #

setARLocationType(value: number)

Sets AR location style (tight, bounding box, none).

Parameters:

getARLocationType #

getARLocationType()

Retrieves the style of AR location overlays (tight, bounding box, none).

setARDoubleTapToFreezeEnabled #

setARDoubleTapToFreezeEnabled(enabled: boolean)

Enables or disables double-tap to freeze scanning in AR mode.

Parameters:

isARDoubleTapToFreezeEnabled #

isARDoubleTapToFreezeEnabled()

Checks whether double-tap to freeze is enabled in AR mode.

setARImageResultEnabled #

setARImageResultEnabled(enabled: boolean)

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

Parameters:

isARImageResultEnabled #

isARImageResultEnabled()

Retrieves whether image result is enabled for AR mode.

setARBarcodeThumbnailOnResultEnabled #

setARBarcodeThumbnailOnResultEnabled(enabled: boolean)

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

Parameters:

isARBarcodeThumbnailOnResultEnabled #

isARBarcodeThumbnailOnResultEnabled()

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

setARResultLimit #

setARResultLimit(value: number)

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

Parameters:

getARResultLimit #

getARResultLimit()

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

setARContinueScanningOnLimit #

setARContinueScanningOnLimit(value: boolean)

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

Parameters:

getARContinueScanningOnLimit #

getARContinueScanningOnLimit()

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

setAREmitResultsAtSessionEndOnly #

setAREmitResultsAtSessionEndOnly(value: boolean)

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

Parameters:

getAREmitResultsAtSessionEndOnly #

getAREmitResultsAtSessionEndOnly()

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

setARHeaderHeight #

setARHeaderHeight(value: number)

Sets height of header label above barcode in AR mode.

Parameters:

getARHeaderHeight #

getARHeaderHeight()

Retrieves the header height above barcode in AR mode.

setARHeaderShowMode #

setARHeaderShowMode(value: number)

Sets header visibility condition (always, on selected, never).

Parameters:

getARHeaderShowMode #

getARHeaderShowMode()

Retrieves the header display mode (always, on selected, never).

setARHeaderMaxTextHeight #

setARHeaderMaxTextHeight(value: number)

Sets max text height for AR header.

Parameters:

getARHeaderMaxTextHeight #

getARHeaderMaxTextHeight()

Retrieves the maximum text height for AR headers.

setARHeaderMinTextHeight #

setARHeaderMinTextHeight(value: number)

Sets min text height for AR header.

Parameters:

getARHeaderMinTextHeight #

getARHeaderMinTextHeight()

Retrieves the minimum text height for AR headers.

setARHeaderTextColorSelected #

setARHeaderTextColorSelected(value: string)

Sets text color for selected barcode header.

Parameters:

getARHeaderTextColorSelected #

getARHeaderTextColorSelected()

Retrieves the header text color for selected barcodes.

setARHeaderTextColorNonSelected #

setARHeaderTextColorNonSelected(value: string)

Sets text color for non-selected barcode header.

Parameters:

getARHeaderTextColorNonSelected #

getARHeaderTextColorNonSelected()

Retrieves the header text color for non-selected barcodes.

setARHeaderHorizontalTextMargin #

setARHeaderHorizontalTextMargin(value: number)

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

Parameters:

getARHeaderHorizontalTextMargin #

getARHeaderHorizontalTextMargin()

Retrieves the horizontal margin for AR header text.

setARHeaderVerticalTextMargin #

setARHeaderVerticalTextMargin(value: number)

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

Parameters:

getARHeaderVerticalTextMargin #

getARHeaderVerticalTextMargin()

Retrieves the vertical margin for AR header text.

setARHeaderTextFormat #

setARHeaderTextFormat(value: string)

Sets AR header text format using placeholders.

Parameters:

getARHeaderTextFormat #

getARHeaderTextFormat()

Retrieves the format string used for AR header text.

resetARCache #

resetARCache()

Clears all cached barcode results from the current AR scanning session.

On-screen buttons #

configureCloseButton #

configureCloseButton(   visible: boolean,   positionX: number,   positionY: number,   iconSize: number,   tintColor: string,   backgroundColor: string,   cornerRadius: number,   padding: number,   useCustomIcon: boolean,   customIcon: string )

Configures the close button displayed during scanning.

To perform an action when the button is tapped, listen for the barkoderCloseButtonTappedEvent

Parameters:

configureFlashButton #

configureFlashButton(   visible: boolean,   positionX: number,   positionY: number,   iconSize: number,   tintColor: string,   backgroundColor: string,   cornerRadius: number,   padding: number,   useCustomIcon: boolean,   customIconFlashOn: string,   customIconFlashOff: string )

Configures the flash (torch) button. Auto-hides if torch is unavailable.

Parameters:

configureZoomButton #

configureZoomButton(   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 )

Configures the zoom button.

Parameters:

Result models #

Scan callbacks return plain objects. Use new BarkoderResult(data) to create the result models below. ? marks an optional property; its fallback value is listed where applicable.

Raw Scan Result #

The object received by the startScanning or scanImage success callback. Images contain JPEG Base64 without a data URL prefix.

Raw Decoder Result #

BarkoderResult #

new BarkoderResult(resultMap: Record<string, any>)

Wraps the callback data and creates a DecoderResult for each decoded barcode.

Image values are prefixed with data:image/jpeg;base64,. Construct this model from raw callback data only; existing prefixes are not detected.

DecoderResult #

new DecoderResult(resultMap: Record<string, any>)

The types above are the helper's declared types. Directly copied fields have no fallback: missing values remain undefined, and null values remain null. MRZ image entries are not filtered; a missing or null encoding produces a data URL ending in undefined or null.

Location Point Shape #

Each entry in locationPoints has these properties:

MRZ Image Shape #

Each image in the DecoderResult.mrzImagesAsBase64 array has these properties:

Callbacks & events #

Barkoder.startScanning(success, error);
Barkoder.scanImage(base64, success, error);

The success callback receives a raw scan result. Convert it with new BarkoderResult(data), as shown below. Use startScanning and scanImage separately; they share the same result callback.

Set closeSessionOnResultEnabled to false to receive further results without closing the session. Call stopScanning() to stop scanning.

For scanImage, pass the image's Base64 content without the data URL prefix. Initialize the scanner first and supply a valid image; invalid input may not invoke an error callback.

captureImage requests a frame; its completion callback does not return the image. Available image data arrives through the scan-result callback. Enable setImageResultEnabled(true) or setBarcodeThumbnailOnResultEnabled(true) to request images or thumbnails. AR scanning uses the corresponding setARImageResultEnabled and setARBarcodeThumbnailOnResultEnabled settings. Images may still be absent.

Result Example #

Run after the platform is ready, the license key is registered, and the scanner is initialized with the required barcode types enabled.

import { BarkoderResult } from 'plugins/barkoder-cordova-plugin/www/BarkoderConfig';

declare var Barkoder: any;

Barkoder.startScanning((data: any) => {
	const barkoderResult = new BarkoderResult(data);
	barkoderResult.decoderResults.forEach((result) => {
		console.log(result.barcodeTypeName, result.textualData);
	});
}, (err: any) => {
	console.error(err);
});

barkoderCloseButtonTappedEvent #

Use this event only when handling taps on the button configured with configureCloseButton(...). It has no custom payload. Register after the platform is ready and remove the handler when the view is disposed.

declare const Barkoder: any;

function onCloseButtonTapped(): void {
	Barkoder.stopScanning();
}

document.addEventListener('barkoderCloseButtonTappedEvent', onCloseButtonTapped);

function removeCloseButtonListener(): void {
	document.removeEventListener('barkoderCloseButtonTappedEvent', onCloseButtonTapped);
}

Call removeCloseButtonListener() when disposing the view.

Enums #

These are the complete exported enums from the TypeScript helper module. Import them from plugins/barkoder-cordova-plugin/www/BarkoderConfig. Members are numeric; names and capitalization below are the public TypeScript spellings. For example, BarkoderCameraPosition.FRONT is 1. Native SDK names are not the JavaScript member names.

DecodingSpeed #

Used by setDecodingSpeed and returned through the success callback of getDecodingSpeed.

FormattingType #

Used by setFormattingType and returned through the success callback of getFormattingType.

MsiChecksumType #

Used by setMsiChecksumType and returned through the success callback of getMsiChecksumType.

Code39ChecksumType #

Used by setCode39ChecksumType and returned through the success callback of getCode39ChecksumType.

Code11ChecksumType #

Used by setCode11ChecksumType and returned through the success callback of getCode11ChecksumType.

BarkoderCameraPosition #

Used by setCamera.

BarkoderResolution #

Used by setBarkoderResolution and returned through the success callback of getBarkoderResolution.

BarkoderRoiCenterMark #

Used by setRoiCenterMark and returned through the success callback of getRoiCenterMark.

BarcodeType #

Used as the type argument of setBarcodeTypeEnabled, isBarcodeTypeEnabled, setBarcodeTypeLengthRange, and getBarcodeTypeLengthRange. Listing a type does not mean every operation supports it, such as length-range configuration for every decoder. The result model's barcodeType is a native result identifier, not a property declared with this enum type; use barcodeTypeName for the returned name.

BarkoderARMode #

Used by setARMode and returned through the success callback of getARMode.

BarkoderAROverlayRefresh #

Used by setAROverlayRefresh and returned through the success callback of getAROverlayRefresh.

BarkoderARLocationType #

Used by setARLocationType and returned through the success callback of getARLocationType.

BarkoderARHeaderShowMode #

Used by setARHeaderShowMode and returned through the success callback of getARHeaderShowMode.

IdDocumentMasterChecksumType #

Used by the TypeScript IdDocumentBarcodeConfig.masterChecksum property.