API reference

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

Scanning & session #

getDecodingSpeed #

▸ getDecodingSpeed(): Promise<DecodingSpeed>

Retrieves the current decoding speed setting for barcode scanning.

getMatchFilter #

getMatchFilter(): Promise

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

getThreadsLimit #

▸ getThreadsLimit(): Promise<number>

Retrieves the threads limit.

getVersion #

▸ getVersion(): Promise<string>

Retrieves the version of the Barkoder SDK.

getLibVersion #

▸ getLibVersion(): Promise<string>

Retrieves the version of the Barkoder library.

getDeviceId #

getDeviceId(): Promise

Retrieves the Device ID.

onDataReturned #

onDataReturned(event): void

Parameters:

Android bridge handler used by BarkoderView. Applications should receive decoded results through the callback supplied to startScanning or scanImage, rather than call this handler directly.

pauseScanning #

pauseScanning(): void

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

setDecodingSpeed #

setDecodingSpeed(decodingSpeed): void

Sets the decoding speed for barcode scanning.

setMatchFilter #

setMatchFilter(value): void

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

Parameters:

setThreadsLimit #

▸ setThreadsLimit(threadsLimit): Promise<boolean>

Sets the threads limit.

Parameters:

startScanning #

startScanning(resultsCallback): void

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

Parameters:

stopScanning #

stopScanning(): void

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

freezeScanning #

freezeScanning(): void

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.

getPowerSavingMode #

getPowerSavingMode(): Promise

Retrieves the power saving mode level.

selectVisibleBarcodes #

selectVisibleBarcodes(): void

Selects all barcodes that are currently visible in AR mode.

setDynamicExposure #

setDynamicExposure(intensity): void

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

Parameters:

setUPCEexpandToUPCA #

setUPCEexpandToUPCA(enabled): void

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

Parameters:

setUPCE1expandToUPCA #

setUPCE1expandToUPCA(enabled): void

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

Parameters:

setPowerSavingMode #

setPowerSavingMode(powerSavingMode): void

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:

setVideoStabilization #

setVideoStabilization(value): void

Enable or disable video stabilization for smoother video capture.

Parameters:

unfreezeScanning #

unfreezeScanning(): void

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.

configureBarkoder #

configureBarkoder(barkoderConfig: Barkoder.BarkoderConfig): Promise<boolean>

Configures the Barkoder functionality based on the provided configuration.

Parameters:

Pass a Barkoder.BarkoderConfig instance. The wrapper calls its toJsonString() method before sending the configuration to the native view. Obtain the scanner through BarkoderView's onBarkoderViewCreated callback before configuring it.

Returns: A promise resolving to true on successful configuration. Configuration errors reject the promise; serialization errors may throw synchronously.

Camera #

getBarkoderResolution #

▸ getBarkoderResolution(): Promise<BarkoderResolution>

Retrieves the resolution for barcode scanning.

getMaxZoomFactor #

▸ getMaxZoomFactor(): Promise<number>

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

isFlashAvailable #

▸ isFlashAvailable(): Promise<boolean>

Checks whether the device has a flash (torch) available for illumination during barcode scanning.

isLocationInPreviewEnabled #

▸ isLocationInPreviewEnabled(): Promise<boolean>

Checks whether barcode location information is displayed on the camera preview.

isPinchToZoomEnabled #

▸ isPinchToZoomEnabled(): Promise<boolean>

Checks whether pinch-to-zoom is enabled.

isPreviewMirrored #

▸ isPreviewMirrored(): Promise<boolean>

Retrieves whether the front camera preview is horizontally mirrored.

setBarkoderResolution #

setBarkoderResolution(barkoderResolution): void

Sets the resolution for barcode scanning.

setFlashEnabled #

setFlashEnabled(enabled): void

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

setLocationInPreviewEnabled #

setLocationInPreviewEnabled(enabled): void

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

setPinchToZoomEnabled #

setPinchToZoomEnabled(enabled): void

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

setZoomFactor #

setZoomFactor(zoomFactor): void

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

Parameters:

startCamera #

startCamera(): void

Starts the camera for barcode scanning.

getCurrentZoomFactor #

getCurrentZoomFactor(): Promise

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

setCentricFocusAndExposure #

setCentricFocusAndExposure(value): void

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

Parameters:

setCamera #

setCamera(value): Promise<boolean>

Sets the camera used for scanning: back or front.

Parameters:

setPreviewMirrored #

setPreviewMirrored(value): void

Controls whether the front camera preview is horizontally mirrored.

Parameters:

Barcode types #

getBarcodeTypeLengthRange #

▸ getBarcodeTypeLengthRange(barcodeType): Promise<number[]>

Retrieves the length range of the specified barcode type.

Parameters:

getCode11ChecksumType #

▸ getCode11ChecksumType(): Promise<Code11ChecksumType>

Retrieves the checksum type for Code 11 barcodes.

getCode39ChecksumType #

▸ getCode39ChecksumType(): Promise<Code39ChecksumType>

Retrieves the checksum type for Code 39 barcodes.

getEncodingCharacterSet #

▸ getEncodingCharacterSet(): Promise<string>

Retrieves the character set used for encoding barcode data.

getFormattingType #

getFormattingType(): Promise<FormattingType>

Retrieves the formatting type used for presenting decoded barcode data.

getMsiChecksumType #

▸ getMsiChecksumType(): Promise<MsiChecksumType>

Retrieves the MSI checksum type.

isBarcodeTypeEnabled #

▸ isBarcodeTypeEnabled(barcodeType): Promise<boolean>

Checks whether the specified barcode type is enabled.

Parameters:

isMisshaped1DEnabled #

▸ isMisshaped1DEnabled(): Promise<boolean>

Checks whether detection of misshaped 1D barcodes is enabled.

isUpcEanDeblurEnabled #

▸ isUpcEanDeblurEnabled(): Promise<boolean>

Checks whether deblurring is enabled for UPC/EAN barcodes.

isVINRestrictionsEnabled #

▸ isVINRestrictionsEnabled(): Promise<boolean>

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

setBarcodeTypeEnabled #

setBarcodeTypeEnabled(barcodeType, enabled): void

Enables or disables the specified barcode type for scanning.

Parameters:

setBarcodeTypeLengthRange #

▸ setBarcodeTypeLengthRange(barcodeType, min, max): Promise<boolean>

Sets the length range for the specified barcode type.

Parameters:

setCode11ChecksumType #

setCode11ChecksumType(code11ChecksumType): void

Sets the checksum type for Code 11 barcodes.

Parameters:

setCode39ChecksumType #

setCode39ChecksumType(code39ChecksumType): void

Sets the checksum type for Code 39 barcodes.

Parameters:

setDatamatrixDpmModeEnabled #

setDatamatrixDpmModeEnabled(enabled): void

Enables or disables Direct Part Marking (DPM) mode for Datamatrix barcodes.

Parameters:

setEnableMisshaped1DEnabled #

setEnableMisshaped1DEnabled(enabled): void

Enables or disables detection of misshaped 1D barcodes.

Parameters:

setEnableVINRestrictions #

setEnableVINRestrictions(enabled): void

Enables or disables Vehicle Identification Number (VIN) restrictions.

Parameters:

setEncodingCharacterSet #

setEncodingCharacterSet(encodingCharacterSet): void

Sets the encoding character set for barcode scanning

setFormattingType #

setFormattingType(formatting): void

Sets the formatting type for decoded barcode data.

Parameters:

setMsiChecksumType #

setMsiChecksumType(msiChecksumType): void

Sets the MSI checksum type.

Parameters:

setUpcEanDeblurEnabled #

setUpcEanDeblurEnabled(enabled): void

Enables or disables deblurring for UPC/EAN barcodes.

Parameters:

isIdDocumentMasterChecksumEnabled #

isIdDocumentMasterChecksumEnabled(): Promise

Retrieves whether Master checksum is enabled when scanning ID Documents.

isQrDpmModeEnabled #

isQrDpmModeEnabled(): Promise

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

isQrMicroDpmModeEnabled #

isQrMicroDpmModeEnabled(): Promise

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

isQrMultiPartMergeEnabled #

isQrMultiPartMergeEnabled(): Promise

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

setCustomOption #

setCustomOption(string, int): void

Setting custom option.

See more details about available options and their values.

Parameters:

setEnableComposite #

setEnableComposite(value): void

Sets whether Composite Mode is enabled for scanning.

Parameters:

setIdDocumentMasterChecksumEnabled #

setIdDocumentMasterChecksumEnabled(enabled): void

Sets whether the master checksum is required when scanning ID documents.

Parameters:

setQrDpmModeEnabled #

setQrDpmModeEnabled(enabled): void

Enables or disables Direct Part Marking (DPM) mode for QR barcodes.

Parameters:

setQrMicroDpmModeEnabled #

setQrMicroDpmModeEnabled(enabled): void

Enables or disables Direct Part Marking (DPM) mode for QR Micro barcodes.

Parameters:

setQrMultiPartMergeEnabled #

setQrMultiPartMergeEnabled(enabled): void

Enables or disables QR multi-part merge mode.

Parameters:

isDatamatrixDpmModeEnabled #

isDatamatrixDpmModeEnabled(): Promise<boolean>

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

Returns: A promise resolving to whether Datamatrix DPM mode is enabled.

Results #

getReturnOnlyMatchedResults #

▸ getReturnOnlyMatchedResults(): Promise<boolean>

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

getMaximumResultsCount #

▸ getMaximumResultsCount(): Promise<number>

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

getMulticodeCachingDuration #

▸ getMulticodeCachingDuration(): Promise<number>

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

getMulticodeCachingEnabled #

▸ getMulticodeCachingEnabled(): Promise<boolean>

Retrieves whether multi-code caching is enabled.

getThresholdBetweenDuplicatesScans #

▸ getThresholdBetweenDuplicatesScans(): Promise<number>

Retrieves the threshold between duplicate scans.

isBarcodeThumbnailOnResultEnabled #

▸ isBarcodeThumbnailOnResultEnabled(): Promise<boolean>

Checks whether barcode thumbnails are enabled in scanning results.

isBeepOnSuccessEnabled #

▸ isBeepOnSuccessEnabled(): Promise<boolean>

Checks whether an audible beep is enabled on successful barcode scanning.

isCloseSessionOnResultEnabled #

▸ isCloseSessionOnResultEnabled(): Promise<boolean>

Checks whether the scanning session closes automatically when a barcode result is detected.

isImageResultEnabled #

▸ isImageResultEnabled(): Promise<boolean>

Checks whether image data is enabled in scanning results.

isVibrateOnSuccessEnabled #

▸ isVibrateOnSuccessEnabled(): Promise<boolean>

Checks whether vibration is enabled on successful barcode scanning.

setBarcodeThumbnailOnResultEnabled #

setBarcodeThumbnailOnResultEnabled(enabled): void

Enables or disables barcode thumbnails in scanning results.

Parameters:

setBeepOnSuccessEnabled #

setBeepOnSuccessEnabled(enabled): void

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

Parameters:

setCloseSessionOnResultEnabled #

setCloseSessionOnResultEnabled(enabled): void

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

Parameters:

setReturnOnlyMatchedResults #

setReturnOnlyMatchedResults(value): void

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:

setImageResultEnabled #

setImageResultEnabled(enabled): void

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

setMaximumResultsCount #

setMaximumResultsCount(maximumResultsCount): void

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

Parameters:

setMulticodeCachingDuration #

setMulticodeCachingDuration(multicodeCachingDuration): any

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

Parameters:

setMulticodeCachingEnabled #

setMulticodeCachingEnabled(multicodeCachingEnabled): any

Enables or disables multi-code caching.

Parameters:

setThresholdBetweenDuplicatesScans #

setThresholdBetweenDuplicatesScans(thresholdBetweenDuplicatesScans): void

Sets the threshold between duplicate scans.

Parameters:

setVibrateOnSuccessEnabled #

setVibrateOnSuccessEnabled(enabled): void

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

Parameters:

captureImage #

captureImage(): void

Captures the latest camera frame.

getShowDuplicatesLocations #

getShowDuplicatesLocations(): Promise

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

scanImage #

scanImage(base64, resultsCallback): void

Scan barcodes from base64 string image.

Parameters:

setShowDuplicatesLocations #

setShowDuplicatesLocations(value): void

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

Parameters:

Region & overlay #

getLocationLineColorHex #

▸ getLocationLineColorHex(): Promise<string>

Retrieves the hexadecimal color code of the lines indicating detected barcode locations.

getLocationLineWidth #

▸ getLocationLineWidth(): Promise<number>

Retrieves the width of the lines indicating detected barcode locations on the camera preview.

getRegionOfInterest #

▸ getRegionOfInterest(): Promise<number[]>

Retrieves the Region of Interest (ROI).

getRoiLineColorHex #

▸ getRoiLineColorHex(): Promise<string>

Retrieves the hexadecimal color code of the lines outlining the Region of Interest (ROI).

getRoiLineWidth #

▸ getRoiLineWidth(): Promise<number>

Retrieves the width of the lines outlining the Region of Interest (ROI).

getRoiOverlayBackgroundColorHex #

▸ getRoiOverlayBackgroundColorHex(): Promise<string>

Retrieves the hexadecimal background color of the Region of Interest (ROI) overlay.

isLocationInImageResultEnabled #

▸ isLocationInImageResultEnabled(): Promise<boolean>

Checks whether barcode location information is included in the image result.

isRegionOfInterestVisible #

▸ isRegionOfInterestVisible(): Promise<boolean>

Checks whether the Region of Interest (ROI) is visible on the camera preview.

getRoiCenterMark #

getRoiCenterMark(): Promise

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

setLocationInImageResultEnabled #

setLocationInImageResultEnabled(enabled): void

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

setLocationLineColor #

**setLocationLineColor**(hexColor): Promise<boolean>

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

Parameters:

setLocationLineWidth #

setLocationLineWidth(lineWidth): void

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

Parameters:

setRegionOfInterest #

**setRegionOfInterest**(left, top, width, height): Promise<boolean>

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

Parameters:

setRegionOfInterestVisible #

setRegionOfInterestVisible(visible): void

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

Parameters:

setRoiCenterMark #

setRoiCenterMark(value): void

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

Parameters:

setRoiLineColor #

**setRoiLineColor**(hexColor): Promise<boolean>

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

Parameters:

setRoiLineWidth #

setRoiLineWidth(lineWidth): void

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

Parameters:

setRoiOverlayBackgroundColor #

**setRoiOverlayBackgroundColor**(hexColor): Promise<boolean>

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

Parameters:

getScanningIndicatorColorHex #

getScanningIndicatorColorHex(): Promise

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

getScanningIndicatorWidth #

getScanningIndicatorWidth(): Promise

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

getScanningIndicatorAnimation #

getScanningIndicatorAnimation(): Promise

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

isScanningIndicatorAlwaysVisible #

isScanningIndicatorAlwaysVisible(): Promise

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

setScanningIndicatorAlwaysVisible #

setScanningIndicatorAlwaysVisible(value): void

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

Parameters:

setScanningIndicatorColor #

setScanningIndicatorColor(hexColor): Promise<boolean>

Sets the scanning indicator color on the camera preview.

Parameters:

setScanningIndicatorWidth #

setScanningIndicatorWidth(lineWidth): void

Sets the scanning indicator width on the camera preview.

Parameters:

setScanningIndicatorAnimation #

setScanningIndicatorAnimation(animation): void

Sets the scanning indicator animation on the camera preview.

Parameters:

AR mode #

getARMode #

getARMode(): Promise

Retrieves the current AR mode used for barcode scanning.

getARReturnOnlyMatchedResults #

getARReturnOnlyMatchedResults(): Promise

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

getARDisplayOnlyMatchedResults #

getARDisplayOnlyMatchedResults(): Promise

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

getARResultDisappearanceDelayMs #

getARResultDisappearanceDelayMs(): Promise

Retrieves the delay after which AR results disappear once detected.

getARLocationTransitionSpeed #

getARLocationTransitionSpeed(): Promise

Retrieves the transition speed for AR barcode location overlays.

getAROverlayRefresh #

▸ getAROverlayRefresh(): Promise<BarkoderAROverlayRefresh>

Retrieves the AR overlay refresh mode.

getARSelectedLocationColor #

getARSelectedLocationColor(): Promise

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

getARNonSelectedLocationColor #

getARNonSelectedLocationColor(): Promise

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

getARSelectedLocationLineWidth #

getARSelectedLocationLineWidth(): Promise

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

getARNonSelectedLocationLineWidth #

getARNonSelectedLocationLineWidth(): Promise

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

getARLocationType #

▸ getARLocationType(): Promise<BarkoderARLocationType>

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

getARResultLimit #

getARResultLimit(): Promise

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

getARContinueScanningOnLimit #

getARContinueScanningOnLimit(): Promise

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

getAREmitResultsAtSessionEndOnly #

getAREmitResultsAtSessionEndOnly(): Promise

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

getARHeaderHeight #

getARHeaderHeight(): Promise

Retrieves the header height above barcode in AR mode.

getARHeaderShowMode #

▸ getARHeaderShowMode(): Promise<BarkoderARHeaderShowMode>

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

getARHeaderMaxTextHeight #

getARHeaderMaxTextHeight(): Promise

Retrieves the maximum text height for AR headers.

getARHeaderMinTextHeight #

getARHeaderMinTextHeight(): Promise

Retrieves the minimum text height for AR headers.

getARHeaderTextColorSelected #

getARHeaderTextColorSelected(): Promise

Retrieves the header text color for selected barcodes.

getARHeaderTextColorNonSelected #

getARHeaderTextColorNonSelected(): Promise

Retrieves the header text color for non-selected barcodes.

getARHeaderHorizontalTextMargin #

getARHeaderHorizontalTextMargin(): Promise

Retrieves the horizontal margin for AR header text.

getARHeaderVerticalTextMargin #

getARHeaderVerticalTextMargin(): Promise

Retrieves the vertical margin for AR header text.

getARHeaderTextFormat #

getARHeaderTextFormat(): Promise

Retrieves the format string used for AR header text.

isARDoubleTapToFreezeEnabled #

isARDoubleTapToFreezeEnabled(): Promise

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

isARImageResultEnabled #

isARImageResultEnabled(): Promise

Retrieves whether image result is enabled for AR mode.

isARBarcodeThumbnailOnResultEnabled #

isARBarcodeThumbnailOnResultEnabled(): Promise

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

resetARCache #

resetARCache(): void

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

setARMode #

setARMode(value): void

Sets the AR mode used for barcode scanning visualization.

Parameters:

setARReturnOnlyMatchedResults #

setARReturnOnlyMatchedResults(value): void

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:

setARDisplayOnlyMatchedResults #

setARDisplayOnlyMatchedResults(value): void

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:

setARResultDisappearanceDelayMs #

setARResultDisappearanceDelayMs(value): void

Sets the delay, in milliseconds, after which a detected AR result is removed.

Parameters:

setARLocationTransitionSpeed #

setARLocationTransitionSpeed(value): void

Sets the transition speed of barcode location overlays in AR mode.

Parameters:

setAROverlayRefresh #

setAROverlayRefresh(value): void

Sets the AR overlay refresh mode.

Parameters:

setARSelectedLocationColor #

setARSelectedLocationColor(hexColor): Promise<boolean>

Sets the color of selected barcode location overlays in AR mode.

Parameters:

setARNonSelectedLocationColor #

setARNonSelectedLocationColor(hexColor): Promise<boolean>

Sets the color of non-selected barcode location overlays in AR mode.

Parameters:

setARSelectedLocationLineWidth #

setARSelectedLocationLineWidth(value): void

Sets the line width of selected barcode location overlays in AR mode.

Parameters:

setARNonSelectedLocationLineWidth #

setARNonSelectedLocationLineWidth(value): void

Sets the line width of non-selected barcode location overlays in AR mode.

Parameters:

setARLocationType #

setARLocationType(value): void

Sets the style of barcode location overlays in AR mode: tight, bounding box, or none.

Parameters:

setARDoubleTapToFreezeEnabled #

setARDoubleTapToFreezeEnabled(enabled): void

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

Parameters:

setARImageResultEnabled #

setARImageResultEnabled(enabled): void

Enables or disables capturing image data when a barcode is selected in AR mode.

Parameters:

setARBarcodeThumbnailOnResultEnabled #

setARBarcodeThumbnailOnResultEnabled(enabled): void

Enables or disables barcode thumbnails in AR scanning results.

Parameters:

setARResultLimit #

setARResultLimit(value): void

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

Parameters:

setARContinueScanningOnLimit #

setARContinueScanningOnLimit(value): void

Sets whether scanning continues when the result limit is reached in interactiveDisabled AR mode.

Parameters:

setAREmitResultsAtSessionEndOnly #

setAREmitResultsAtSessionEndOnly(value): void

Sets whether results are emitted only at the end of an AR session or when the result limit is reached.

Parameters:

setARHeaderHeight #

setARHeaderHeight(value): void

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

Parameters:

setARHeaderShowMode #

setARHeaderShowMode(value): void

Sets when the AR header is displayed: always, on selected barcodes, or never.

Parameters:

setARHeaderMaxTextHeight #

setARHeaderMaxTextHeight(value): void

Sets the maximum height of AR header text.

Parameters:

setARHeaderMinTextHeight #

setARHeaderMinTextHeight(value): void

Sets the minimum height of AR header text.

Parameters:

setARHeaderTextColorSelected #

setARHeaderTextColorSelected(hexColor): Promise<boolean>

Sets the header text color for selected barcodes in AR mode.

Parameters:

setARHeaderTextColorNonSelected #

setARHeaderTextColorNonSelected(hexColor): Promise<boolean>

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

Parameters:

setARHeaderHorizontalTextMargin #

setARHeaderHorizontalTextMargin(value): void

Sets the horizontal margin on both sides of AR header text.

Parameters:

setARHeaderVerticalTextMargin #

setARHeaderVerticalTextMargin(value): void

Sets the vertical margin above and below AR header text.

Parameters:

setARHeaderTextFormat #

setARHeaderTextFormat(value): void

Sets the format string used for AR header text.

Parameters:

On-screen buttons #

configureCloseButton #

configureCloseButton(visible, positionX, positionY, iconSize, tintColor, backgroundColor, cornerRadius, padding, useCustomIcon, customIcon): void

Configures the close button shown during scanning. To perform an action when the button is tapped, register a callback using onCloseButtonTapped

Parameters:

configureFlashButton #

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

Configures the flash (torch) button shown during scanning; auto-hides if the device torch is unavailable.

Parameters:

configureZoomButton #

configureZoomButton(visible, positionX, positionY, iconSize, tintColor, backgroundColor, cornerRadius, padding, useCustomIcon, customIconZoomedIn, customIconZoomedOut, zoomedInFactor, zoomedOutFactor): void

Configures the zoom button shown during scanning.

Parameters:

onCloseButtonTapped #

onCloseButtonTapped(callback): void

Registers a callback for the SDK Close button during scanning. This is triggered when the user taps the Close button configured via configureCloseButton

Parameters:

Result models #

startScanning(resultsCallback) and scanImage(base64, resultsCallback) deliver a Barkoder.BarkoderResult to resultsCallback. Its callback type is (result: Barkoder.BarkoderResult) => void; ResultCallback is not a separately exported type. Neither method returns the decoded result synchronously or as a promise.

The tables below describe wrapper/model values, not raw native event payloads. A ? after a property name means that the property is optional in the TypeScript declaration. The description states the value assigned by the model constructor when native data is missing. null and undefined are distinct values.

Barkoder.BarkoderResult #

The image and thumbnail fields depend on images supplied by the native SDK. Enable setImageResultEnabled(true) and setBarcodeThumbnailOnResultEnabled(true) for regular scanning, or the corresponding setARImageResultEnabled(true) and setARBarcodeThumbnailOnResultEnabled(true) settings for AR results. Enabling a setting does not make an image field unconditional.

Barkoder.DecoderResult #

Required scalar fields are copied as supplied; the wrapper does not validate their types or synthesize missing values.

Named MRZ Image #

Each entry in mrzImagesAsBase64 has the following properties.

Both bridges populate named MRZ images only when the native barcodeTypeName equals MRZ and native images are available. Other results receive [] from the wrapper. Image extraction and encoding can omit entries.

Location Point #

Each entry in locationPoints has the following properties.

On iOS, the serializer reads four points when the native location pointer is present. On Android, it serializes the supplied native point array. The wrapper does not normalize coordinates, reorder points, or enforce a point count.

Enums #

The enums below are exported through the Barkoder namespace. For example, use Barkoder.BarcodeType.qr and Barkoder.BarkoderCameraPosition.FRONT. Member names are case-sensitive. Values are the plugin's numeric enum values, not default settings.

Barkoder.DecodingSpeed #

Barkoder.FormattingType #

Barkoder.MsiChecksumType #

Barkoder.Code39ChecksumType #

Barkoder.Code11ChecksumType #

Barkoder.BarkoderCameraPosition #

Barkoder.BarkoderResolution #

Barkoder.BarkoderRoiCenterMark #

Barkoder.BarkoderARMode #

Barkoder.BarkoderAROverlayRefresh #

Barkoder.BarkoderARLocationType #

Barkoder.BarkoderARHeaderShowMode #

Barkoder.BarcodeType #

Barkoder.IdDocumentMasterChecksumType #

BarkoderView And Usage #

Import the named exports from barkoder-react-native. Render BarkoderView and obtain its scanner instance from onBarkoderViewCreated; do not construct a scanner with an application-created native-view reference.

Application Props #

ViewStyle is a React Native type. Register the SDK close-button callback with barkoder.onCloseButtonTapped(callback) after initialization.