Cordova

Cordova SDK - API Reference

API reference for barKoder's Cordova Barcode Reader SDK

API function list #

initialize() #

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

Initializes the Barkoder scanner with the specified dimensions and position.

Parameters:

width - The width of the scanner view
height - The height of the scanner view
x - The X position of the scanner view
y - The Y position of the scanner view

registerWithLicenseKey() #

                registerWithLicenseKey(licenseKey: string)

Registers the Barkoder scanner with the specified license key.

Parameters:

licenseKey - The license key to register the Barkoder scanner

startCamera() #

                startCamera()

Starts the camera for barcode scanning preparation.

startScanning() #

                startScanning()

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

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.

captureImage() #

                captureImage()

Captures the latest camera frame.

scanImage() #

                scanImage(base64: string)

Scan barcodes from a base64 string image.

Parameters:

base64 - Base64 encoded image string

setZoomFactor() #

                setZoomFactor(zoomFactor: number)

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

Parameters:

zoomFactor - The zoom factor to set. This should be a positive number

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:

enabled - Set to true to enable the flash, false to disable it

isFlashAvailable() #

                isFlashAvailable()

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

setLocationLineColor() #

                setLocationLineColor(hexColor: string)

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

Parameters:

hexColor - The color to set for the location lines, specified in hexadecimal format (e.g., '#FF0000' for red)

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:

lineWidth - The width of the location lines, in pixels. Must be a positive number

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:

hexColor - The color to set for the ROI lines, in hexadecimal format (e.g., '#FF0000' for red)

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:

lineWidth - The width of the ROI lines, in pixels. This should be a positive number

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:

hexColor - The background color to set for the ROI overlay, in hexadecimal format (e.g., '#FF0000' for red)

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:

left - The left position of the ROI
top - The top position of the ROI
width - The width of the ROI
height - The height of the ROI

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:

regionOfInterestVisible - Set to true to make the region of interest visible, false to hide it

isRegionOfInterestVisible() #

                isRegionOfInterestVisible()

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

setScanningIndicatorColor() #

                setScanningIndicatorColor(hexColor: string)

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

Parameters:

hexColor - The hexadecimal representation of the color

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:

lineWidth - The width of the scanning indicator to set

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:

animation - The animation of the scanning indicator to set

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:

value - A boolean indicating whether the scanning indicator should always remain visible

isScanningIndicatorAlwaysVisible() #

                isScanningIndicatorAlwaysVisible()

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

setCloseSessionOnResultEnabled() #

                setCloseSessionOnResultEnabled(enabled: boolean)

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

Parameters:

enabled - Set to true to enable automatic session closure, false to disable it

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:

enabled - Set to true to include an image in the result, false to exclude it

isImageResultEnabled() #

                isImageResultEnabled()

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

setLocationInImageResultEnabled() #

                setLocationInImageResultEnabled(enabled: boolean)

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

Parameters:

enabled - Set to true to include location information in the image result, false to exclude it

isLocationInImageResultEnabled() #

                isLocationInImageResultEnabled()

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

setLocationInPreviewEnabled() #

                setLocationInPreviewEnabled(enabled: boolean)

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

Parameters:

enabled - Set to true to display location information in the scanning preview, false to hide it

isLocationInPreviewEnabled() #

                isLocationInPreviewEnabled()

Checks if location in preview is enabled.

setBeepOnSuccessEnabled() #

                setBeepOnSuccessEnabled(enabled: boolean)

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

Parameters:

enabled - Set to true to enable the beep sound, false to disable it

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:

enabled - Set to true to enable vibration, false to disable it

isVibrateOnSuccessEnabled() #

                isVibrateOnSuccessEnabled()

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

setPinchToZoomEnabled() #

                setPinchToZoomEnabled(enabled: boolean)

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

Parameters:

enabled - Set to true to enable pinch-to-zoom gesture, false to disable it

isPinchToZoomEnabled() #

                isPinchToZoomEnabled()

Checks if pinch to zoom is enabled.

setThreadsLimit() #

                setThreadsLimit(threadsLimit: number)

Sets the threads limit for decoding operations.

Parameters:

threadsLimit - The maximum number of threads to use for decoding

getThreadsLimit() #

                getThreadsLimit()

Retrieves the threads limit.

setBarkoderResolution() #

                setBarkoderResolution(resolution: number)

Sets the resolution for barcode scanning.

Parameters:

resolution - The resolution to set for the barcode scanner

getBarkoderResolution() #

                getBarkoderResolution()

Retrieves the resolution for barcode scanning.

setDecodingSpeed() #

                setDecodingSpeed(decodingSpeed: number)

Sets the decoding speed for barcode scanning.

Parameters:

decodingSpeed - The decoding speed to set for the barcode scanner

getDecodingSpeed() #

                getDecodingSpeed()

Retrieves the current decoding speed setting for barcode scanning.

setBarcodeTypeEnabled() #

                setBarcodeTypeEnabled(type: number, enabled: boolean)

Sets whether a specific barcode type is enabled.

Parameters:

type - The barcode type to enable or disable
enabled - Set to true to enable the barcode type, false to disable it

isBarcodeTypeEnabled() #

                isBarcodeTypeEnabled(type: number)

Checks if a specific barcode type is enabled.

Parameters:

type - The barcode type to check

setBarcodeTypeLengthRange() #

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

Sets the length range for the specified barcode type.

Parameters:

type - The barcode type to configure
min - The minimum length
max - The maximum length

getBarcodeTypeLengthRange() #

                getBarcodeTypeLengthRange(type: number)

Retrieves the length range of a specific barcode type.

Parameters:

type - The barcode type to check

setEncodingCharacterSet() #

                setEncodingCharacterSet(characterSet: string)

Sets the encoding character set for barcode scanning.

Parameters:

characterSet - The character set to use for encoding data

getEncodingCharacterSet() #

                getEncodingCharacterSet()

Retrieves the character set used for encoding barcode data.

setFormattingType() #

                setFormattingType(formattingType: number)

Sets the formatting type for barcode scanning.

Parameters:

formattingType - The formatting type to set for the barcode scanner

getFormattingType() #

                getFormattingType()

Retrieves the formatting type used for presenting decoded barcode data.

setCode11ChecksumType() #

                setCode11ChecksumType(checksumType: number)

Sets the Code11 checksum type.

Parameters:

checksumType - The checksum type to set for Code 11 barcodes

getCode11ChecksumType() #

                getCode11ChecksumType()

Retrieves the Code11 checksum type.

setMsiChecksumType() #

                setMsiChecksumType(checksumType: number)

Sets the MSI checksum type.

Parameters:

checksumType - The checksum type to set for the MSI barcode scanner

getMsiChecksumType() #

                getMsiChecksumType()

Retrieves the MSI checksum type.

setCode39ChecksumType() #

                setCode39ChecksumType(checksumType: number)

Sets the Code39 checksum type.

Parameters:

checksumType - The checksum type to set for Code 39 barcodes

getCode39ChecksumType() #

                getCode39ChecksumType()

Retrieves the checksum type for Code 39 barcodes.

setMulticodeCachingEnabled() #

                setMulticodeCachingEnabled(enabled: boolean)

Sets whether multi-code caching is enabled.

Parameters:

enabled - Set to true to enable multi-code caching, false to disable it

getMulticodeCachingEnabled() #

                getMulticodeCachingEnabled()

Retrieves whether multi-code caching is enabled.

setMulticodeCachingDuration() #

                setMulticodeCachingDuration(duration: number)

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

Parameters:

duration - The caching duration in milliseconds for multi-code barcode scanning

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:

resultsCount - The maximum number of results to return

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:

thresholdBetweenDuplicatesScans - The threshold between duplicate scans

getThresholdBetweenDuplicatesScans() #

                getThresholdBetweenDuplicatesScans()

Retrieves the threshold between duplicate scans.

setBarcodeThumbnailOnResultEnabled() #

                setBarcodeThumbnailOnResultEnabled(enabled: boolean)

Enables or disables the barcode thumbnail on result.

Parameters:

enabled - Set to true to include the barcode thumbnail in the result, false to exclude it

isBarcodeThumbnailOnResultEnabled() #

                isBarcodeThumbnailOnResultEnabled()

Checks if the barcode thumbnail on result is enabled.

setUpcEanDeblurEnabled() #

                setUpcEanDeblurEnabled(enabled: boolean)

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

Parameters:

enabled - Set to true to enable UPC/EAN deblur, false to disable it

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:

enabled - Set to true to enable detection of misshaped 1D barcodes, false to disable it

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:

enableVINRestrictions - Set to true to enable VIN restrictions, false to disable them

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:

enabled - Set to true to enable Data Matrix DPM mode, false to disable it

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:

enabled - Set to true to enable QR DPM mode, false to disable it

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:

enabled - Set to true to enable QR Micro DPM mode, false to disable it

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:

enabled - Set to true to enable QR multi-part merge, false to disable it

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:

enabled - Set to true to enable Master checksum, false to disable it

isIdDocumentMasterChecksumEnabled() #

                isIdDocumentMasterChecksumEnabled()

Retrieves whether Master checksum is enabled when scanning ID Documents.

setUPCEexpandToUPCA() #

                setUPCEexpandToUPCA(enabled: boolean)

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

Parameters:

enabled - A boolean indicating whether to enable the expansion for UPC-E barcodes

setUPCE1expandToUPCA() #

                setUPCE1expandToUPCA(enabled: boolean)

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

Parameters:

enabled - A boolean indicating whether to enable the expansion for UPC-E1 barcodes

setCustomOption() #

                setCustomOption(option: string, value: number)

Sets a custom option.

Parameters:

option - The string value for the custom option
value - The integer value for the custom option

setCustomOptionGlobal() #

                setCustomOptionGlobal(option: number, value: number)

Sets a custom option globally (must be called before createBarkoderConfig()).

Parameters:

option - The integer value for the custom option
value - The integer value for the custom option

setDynamicExposure() #

                setDynamicExposure(intensity: number)

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

Parameters:

intensity - The integer value for the exposure intensity

setCentricFocusAndExposure() #

                setCentricFocusAndExposure(value: boolean)

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

Parameters:

value - A boolean indicating whether the center of the viewfinder should be used

setVideoStabilization() #

                setVideoStabilization(value: boolean)

Enables or disables video stabilization for smoother video capture.

Parameters:

value - A boolean indicating whether video stabilization should be enabled/disabled

setCamera() #

                setCamera(value: number)

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

Parameters:

value - The value which camera should be used

setEnableComposite() #

                setEnableComposite(value: number)

Sets whether Composite Mode should be enabled when scanning.

Parameters:

value - The integer value if composite mode should be enabled

setShowDuplicatesLocations() #

                setShowDuplicatesLocations(value: boolean)

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

Parameters:

value - A boolean indicating whether to show duplicate locations

getShowDuplicatesLocations() #

                getShowDuplicatesLocations()

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

configureBarkoder() #

                configureBarkoder(barkoderConfig: object)

Configures the Barkoder functionality based on the provided configuration.

Parameters:

barkoderConfig - The configuration object for Barkoder scanner

setARMode() #

                setARMode(value: number)

Sets the AR mode used for barcode scanning visualization.

Parameters:

value - The AR mode (e.g., interactive, non-interactive, off)

getARMode() #

                getARMode()

Retrieves the current AR mode used for barcode scanning.

setARResultDisappearanceDelayMs() #

                setARResultDisappearanceDelayMs(value: number)

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

Parameters:

value - Delay in milliseconds

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:

value - Transition speed value

getARLocationTransitionSpeed() #

                getARLocationTransitionSpeed()

Retrieves the transition speed for AR barcode location overlays.

setAROverlayRefresh() #

                setAROverlayRefresh(value: number)

Sets the refresh mode for the AR overlay.

Parameters:

value - Refresh mode value

getAROverlayRefresh() #

                getAROverlayRefresh()

Retrieves the AR overlay refresh mode.

setARSelectedLocationColor() #

                setARSelectedLocationColor(value: string)

Sets the overlay color for selected barcodes in AR mode.

Parameters:

value - Hex color code

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:

value - Hex color code

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:

value - Width in pixels

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:

value - Width in pixels

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:

value - Location type

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:

enabled - Boolean toggle

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:

enabled - Boolean toggle

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:

enabled - Boolean toggle

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:

value - Maximum results limit

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:

value - Boolean toggle

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:

value - Boolean toggle

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:

value - Height in pixels

getARHeaderHeight() #

                getARHeaderHeight()

Retrieves the header height above barcode in AR mode.

setARHeaderShowMode() #

                setARHeaderShowMode(value: number)

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

Parameters:

value - Show mode

getARHeaderShowMode() #

                getARHeaderShowMode()

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

setARHeaderMaxTextHeight() #

                setARHeaderMaxTextHeight(value: number)

Sets max text height for AR header.

Parameters:

value - Max height in pixels

getARHeaderMaxTextHeight() #

                getARHeaderMaxTextHeight()

Retrieves the maximum text height for AR headers.

setARHeaderMinTextHeight() #

                setARHeaderMinTextHeight(value: number)

Sets min text height for AR header.

Parameters:

value - Min height in pixels

getARHeaderMinTextHeight() #

                getARHeaderMinTextHeight()

Retrieves the minimum text height for AR headers.

setARHeaderTextColorSelected() #

                setARHeaderTextColorSelected(value: string)

Sets text color for selected barcode header.

Parameters:

value - Hex color code

getARHeaderTextColorSelected() #

                getARHeaderTextColorSelected()

Retrieves the header text color for selected barcodes.

setARHeaderTextColorNonSelected() #

                setARHeaderTextColorNonSelected(value: string)

Sets text color for non-selected barcode header.

Parameters:

value - Hex color code

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:

value - Margin in pixels

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:

value - Margin in pixels

getARHeaderVerticalTextMargin() #

                getARHeaderVerticalTextMargin()

Retrieves the vertical margin for AR header text.

setARHeaderTextFormat() #

                setARHeaderTextFormat(value: string)

Sets AR header text format using placeholders.

Parameters:

value - Format string (e.g., [barcode_text])

getARHeaderTextFormat() #

                getARHeaderTextFormat()

Retrieves the format string used for AR header text.

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.

Parameters:

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 empty to use default
backgroundColor - Button background. Hex string. Leave empty to use default
cornerRadius - Corner radius
padding - Inner padding around the glyph
useCustomIcon - Set true to use a provided custom icon
customIcon - Custom icon for the button as a Base64-encoded image string

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:

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 empty to use default
backgroundColor - Button background. Hex string. Leave empty to use default
cornerRadius - Corner radius
padding - Inner padding around the glyph
useCustomIcon - Set true to use provided custom icons
customIconFlashOn - Custom icon for the ON state as a Base64-encoded image string
customIconFlashOff - Custom icon for the OFF state as a Base64-encoded image string

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:

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 empty to use default
backgroundColor - Button background. Hex string. Leave empty to use 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

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.

Cordova - Installation