Barkoder class

Constructors

Barkoder.new()

Properties

getBarkoderResolution → Future<BarkoderResolution>

Retrieves the resolution for barcode scanning.

no setter

getCode11ChecksumType → Future<Code11ChecksumType>

Retrieves the Code11 checksum type.

no setter

getCode39ChecksumType → Future<Code39ChecksumType>

Retrieves the checksum type for Code 39 barcodes.

no setter

getDecodingSpeed → Future<DecodingSpeed>

Retrieves the current decoding speed setting for barcode scanning.

no setter

getEncodingCharacterSet → Future<String>

Retrieves the character set used for encoding barcode data.

no setter

getFormattingType → Future<FormattingType>

Retrieves the formatting type used for presenting decoded barcode data.

no setter

getLibVersion → Future<String>

Retrieves the version of the Barkoder library.

no setter

getLocationLineColorHex → Future<String>

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

no setter

getLocationLineWidth → Future<double>

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

no setter

getMaximumResultsCount → Future<double>

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

no setter

getMsiChecksumType → Future<MsiChecksumType>

Retrieves the MSI checksum type.

no setter

getMulticodeCachingDuration → Future<int>

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

no setter

getMulticodeCachingEnabled → Future<bool>

Retrieves whether multi-code caching is enabled.

no setter

getRegionOfInterest → Future<List<double>>

Retrieves the region of interest (ROI).

no setter

getRoiLineColorHex → Future<String>

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

no setter

getRoiLineWidth → Future<double>

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

no setter

getRoiOverlayBackgroundColorHex → Future<String>

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

no setter

getScanningIndicatorAnimation → Future<int>

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

no setter

getScanningIndicatorColorHex → Future<String>

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

no setter

getScanningIndicatorWidth → Future<double>

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

no setter

getThreadsLimit → Future<int>

Retrieves the threads limit.

no setter

getThresholdBetweenDuplicatesScans → Future<int>

Retrieves the threshold between duplicate scans.

no setter

getVersion → Future<String>

Retrieves the version of the Barkoder SDK.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

isARBarcodeThumbnailOnResultEnabled → Future<bool>

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

no setter

isARImageResultEnabled → Future<bool>

Retrieves whether image result is enabled for AR mode.

no setter

isBarcodeThumbnailOnResultEnabled → Future<bool>

Checks if the barcode thumbnail on result is enabled.

no setter

isBeepOnSuccessEnabled → Future<bool>

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

no setter

isCloseSessionOnResultEnabled → Future<bool>

Checks if the session is closed on result enabled.

no setter

isDatamatrixDpmModeEnabled → Future<bool>

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

no setter

isIdDocumentMasterChecksumEnabled → Future<bool>

Retrieves whether Master checksum is enabled when scanning ID Documents

no setter

isImageResultEnabled → Future<bool>

Checks if image result is enabled.

no setter

isLocationInImageResultEnabled → Future<bool>

Checks if location in image result is enabled.

no setter

isLocationInPreviewEnabled → Future<bool>

Checks if location in preview is enabled.

no setter

isMisshaped1DEnabled → Future<bool>

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

no setter

isPinchToZoomEnabled → Future<bool>

Checks if pinch to zoom is enabled.

no setter

isQrDpmModeEnabled → Future<bool>

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

no setter

isQrMicroDpmModeEnabled → Future<bool>

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

no setter

isRegionOfInterestVisible → Future<bool>

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

no setter

isScanningIndicatorAlwaysVisible → Future<bool>

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

no setter

isUpcEanDeblurEnabled → Future<bool>

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

no setter

isVibrateOnSuccessEnabled → Future<bool>

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

no setter

isVINRestrictionsEnabled → Future<bool>

Checks if VIN restrictions are enabled.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

configureBarkoder(BarkoderConfig barkoderConfig) → Future<void>

Configures the Barkoder functionality based on the provided configuration.

freezeScanning() → Future<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.

getARHeaderHeight() → Future<double>

Retrieves the header height above barcode in AR mode.

getARHeaderHorizontalTextMargin() → Future<double>

Retrieves the horizontal margin for AR header text.

getARHeaderMaxTextHeight() → Future<double>

Retrieves the maximum text height for AR headers.

getARHeaderMinTextHeight() → Future<double>

Retrieves the minimum text height for AR headers.

getARHeaderShowMode() → Future<BarkoderARHeaderShowMode>

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

getARHeaderTextColorNonSelected() → Future<String>

Retrieves the header text color for non-selected barcodes.

getARHeaderTextColorSelected() → Future<String>

Retrieves the header text color for selected barcodes.

getARHeaderTextFormat() → Future<String>

Retrieves the format string used for AR header text.

getARHeaderVerticalTextMargin() → Future<double>

Retrieves the vertical margin for AR header text.

getARLocationTransitionSpeed() → Future<double>

Retrieves the transition speed for AR barcode location overlays.

getARLocationType() → Future<BarkoderARLocationType>

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

getARMode() → Future<BarkoderARMode>

Retrieves the current AR mode used for barcode scanning.

getARNonSelectedLocationColor() → Future<String>

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

getARNonSelectedLocationLineWidth() → Future<double>

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

getAROverlayRefresh() → Future<BarkoderAROverlayRefresh>

Retrieves the AR overlay refresh mode.

getARResultDisappearanceDelayMs() → Future<int>

Retrieves the delay after which AR results disappear once detected.

getARSelectedLocationColor() → Future<String>

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

getARSelectedLocationLineWidth() → Future<double>

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

getBarcodeTypeLengthRange(BarcodeType type) → Future<List<int>>

Retrieves the length range of a specific barcode type.

getCurrentZoomFactor() → Future<double>

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

getMaxZoomFactor() → Future<double>

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

getShowDuplicatesLocations() → Future<bool>

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

isARDoubleTapToFreezeEnabled() → Future<bool>

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

isBarcodeTypeEnabled(BarcodeType type) → Future<bool>

Checks if a specific barcode type is enabled.

isFlashAvailable() → Future<bool>

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pauseScanning() → Future<void>

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

releaseBarkoder() → void

scanImage(void resultsCallback(BarkoderResult), String base64image) → Future<void>

Scan from base64 image string.

setARBarcodeThumbnailOnResultEnabled(bool enabled) → Future<void>

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

setARDoubleTapToFreezeEnabled(bool enabled) → Future<void>

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

setARHeaderHeight(double value) → Future<void>

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

setARHeaderHorizontalTextMargin(double value) → Future<void>

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

setARHeaderMaxTextHeight(double value) → Future<void>

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

setARHeaderMinTextHeight(double value) → Future<void>

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

setARHeaderShowMode(BarkoderARHeaderShowMode value) → Future<void>

Sets the condition under which the header text is shown above the barcode.

setARHeaderTextColorNonSelected(String value) → Future<void>

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

setARHeaderTextColorSelected(String value) → Future<void>

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

setARHeaderTextFormat(String value) → Future<void>

Sets the format string for the AR header text above each barcode.

setARHeaderVerticalTextMargin(double value) → Future<void>

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

setARImageResultEnabled(bool enabled) → Future<void>

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

setARLocationTransitionSpeed(double value) → Future<void>

Sets the speed at which barcode location overlays transition positions.

setARLocationType(BarkoderARLocationType value) → Future<void>

Sets the style of location overlays drawn around detected barcodes.

setARMode(BarkoderARMode value) → Future<void>

Sets the AR mode used for barcode scanning visualization.

setARNonSelectedLocationColor(String value) → Future<void>

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

setARNonSelectedLocationLineWidth(double value) → Future<void>

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

setAROverlayRefresh(BarkoderAROverlayRefresh value) → Future<void>

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

setARResultDisappearanceDelayMs(int value) → Future<void>

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

setARSelectedLocationColor(String value) → Future<void>

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

setARSelectedLocationLineWidth(double value) → Future<void>

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

setBarcodeThumbnailOnResultEnabled(bool enabled) → Future<void>

Sets whether to enable barcode thumbnail on result.

setBarcodeTypeEnabled(BarcodeType type, bool enabled) → Future<void>

Sets whether a specific barcode type is enabled.

setBarcodeTypeLengthRange(BarcodeType type, int min, int max) → Future<void>

Sets the length range for the specified barcode type.

setBarkoderResolution(BarkoderResolution resolution) → Future<void>

Sets the resolution for barcode scanning.

setBeepOnSuccessEnabled(bool enabled) → Future<void>

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

setCamera(BarkoderCameraPosition value) → Future<void>

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

setCentricFocusAndExposure(bool value) → Future<void>

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

setCloseSessionOnResultEnabled(bool enabled) → Future<void>

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

setCode11ChecksumType(Code11ChecksumType checksumType) → Future<void>

Sets the Code11 checksum type.

setCode39ChecksumType(Code39ChecksumType checksumType) → Future<void>

Sets the Code39 checksum type.

setCustomOption(String option, int value) → Future<void>

Setting a custom option.

setDatamatrixDpmModeEnabled(bool enabled) → Future<void>

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

setDecodingSpeed(DecodingSpeed decodingSpeed) → Future<void>

Sets the decoding speed for barcode scanning.

setDynamicExposure(int dynamicExposure) → Future<void>

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

setEnableComposite(int value) → Future<void>

Sets wheter Composite Mode should be enabled when scanning.

setEnableMisshaped1DEnabled(bool enabled) → Future<void>

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

setEnableVINRestrictions(bool enabled) → Future<void>

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

setEncodingCharacterSet(String characterSet) → Future<void>

Sets the encoding character set for barcode scanning.

setFlashEnabled(bool enabled) → Future<void>

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

setFormattingType(FormattingType formattingType) → Future<void>

Sets the formatting type for barcode scanning.

setIdDocumentMasterChecksumEnabled(bool enabled) → Future<void>

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

setImageResultEnabled(bool enabled) → Future<void>

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

setLocationInImageResultEnabled(bool enabled) → Future<void>

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

setLocationInPreviewEnabled(bool enabled) → Future<void>

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

setLocationLineColor(String hexColor) → Future<void>

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

setLocationLineWidth(double lineWidth) → Future<void>

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

setMaximumResultsCount(int maximumResultsCount) → Future<void>

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

setMisshaped1DEnabled(bool enabled) → Future<void>

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

setMsiChecksumType(MsiChecksumType checksumType) → Future<void>

Sets the MSI checksum type.

setMulticodeCachingDuration(int multicodeCachingDuration) → Future<void>

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

setMulticodeCachingEnabled(bool enabled) → Future<void>

Sets whether multi-code caching is enabled.

setPinchToZoomEnabled(bool enabled) → Future<void>

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

setQrDpmModeEnabled(bool enabled) → Future<void>

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

setQrMicroDpmModeEnabled(bool enabled) → Future<void>

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

setRegionOfInterest(double left, double top, double width, double height) → Future<void>

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

setRegionOfInterestVisible(bool visible) → Future<void>

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

setRoiLineColor(String hexColor) → Future<void>

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

setRoiLineWidth(double lineWidth) → Future<void>

Sets the width of the region of interest (ROI) line.

setRoiOverlayBackgroundColor(String hexColor) → Future<void>

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

setScanningIndicatorAlwaysVisible(bool value) → Future<void>

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

setScanningIndicatorAnimation(int animation) → Future<void>

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

setScanningIndicatorColor(String hexColor) → Future<void>

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

setScanningIndicatorWidth(double lineWidth) → Future<void>

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

setShowDuplicatesLocations(bool value) → Future<void>

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

setThreadsLimit(int threadsLimit) → Future<void>

Sets the threads limit.

setThresholdBetweenDuplicatesScans(int thresholdBetweenDuplicatesScans) → Future<void>

Sets the threshold between duplicate scans.

setUPCE1expandToUPCA(bool enabled) → Future<void>

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

setUpcEanDeblurEnabled(bool enabled) → Future<void>

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

setUPCEexpandToUPCA(bool enabled) → Future<void>

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

setVibrateOnSuccessEnabled(bool enabled) → Future<void>

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

setVideoStabilization(bool value) → Future<void>

Enable or disable video stabilization for smoother video capture.

setZoomFactor(double zoomFactor) → Future<void>

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

showLogMessages(bool show) → Future<void>

Sets whether to show log messages.

startCamera() → Future<void>

Starts the camera.

startScanning(void resultsCallback(BarkoderResult)) → Future<void>

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

stopScanning() → Future<void>

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

toString() → String

A string representation of this object.

inherited

unfreezeScanning() → Future<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.

Operators

operator ==(Object other) → bool

The equality operator.

inherited