API reference
Every method, setting, enum and result of the barKoder Android SDK, grouped by what you do with it.
Scanning & session #
GetDeviceId #
static String GetDeviceId()Retrieves the unique device identifier used by the Barkoder SDK.
GetLibVersion #
static String GetLibVersion()Retrieves the version of the native Barkoder library as a string.
GetLicenseInfo #
static Map GetLicenseInfo()Retrieves information about the current license as a map.
GetVersion #
static String GetVersion()Retrieves the current version of the Barkoder SDK as a string.
startScanning #
void startScanning(BarkoderResultCallback)On BarkoderView. Initiates the barcode scanning process, allowing the application to detect and decode barcodes from the device's camera feed. Throws NullPointerException if the BarkoderView config is not set.
stopScanning #
void stopScanning()On BarkoderView. Halts the barcode scanning process, stopping the camera from capturing and processing barcode information.
config #
BarkoderConfig configOn BarkoderView. The BarkoderConfig used by this view to configure the scanning process.
freezeScanning #
void freezeScanning()On BarkoderView. Freezes the AR scanning session by capturing a still image from the camera feed while keeping AR overlays visible. Available only when AR mode is enabled.
pauseScanning #
void pauseScanning()On BarkoderView. Temporarily suspends the barcode scanning process, pausing the camera feed without completely stopping the scanning session.
selectVisibleBarcodes #
void selectVisibleBarcodes()On BarkoderView. Selects all barcodes that are currently visible in AR mode and sends them through the BarkoderResultCallback. Available only when AR mode is enabled.
setDynamicExposure #
void setDynamicExposure(int)On BarkoderView. Configures dynamic exposure compensation based on the provided intensity value. A value between 0 and 10 is expected, where 0 disables dynamic exposure.
setPerformanceCallback #
void setPerformanceCallback(BarkoderPerformanceCallback)On BarkoderView. Sets the callback that receives scanning performance data.
setVideoStabilization #
void setVideoStabilization(boolean)On BarkoderView. Enables or disables video stabilization for the camera preview.
unfreezeScanning #
void unfreezeScanning()On BarkoderView. Unfreezes a previously frozen AR scanning session and resumes live camera scanning and overlay updates. Available only when AR mode is enabled.
getPowerSavingMode #
int getPowerSavingMode()On BarkoderConfig. Retrieves the power saving level. Increasing the level reduces CPU and battery usage by limiting frame processing. 0 - Disabled (full performance), 1 - Light saving, 2 - Medium saving, 3 - High saving, 4 - Maximum saving.
GetThreadsLimit #
static int GetThreadsLimit()On BarkoderConfig. Retrieves the threads limit.
setPowerSavingMode #
void setPowerSavingMode(int)On BarkoderConfig. Sets the power saving level. Increasing the level reduces CPU and battery usage by limiting frame processing. 0 - Disabled (full performance), 1 - Light saving, 2 - Medium saving, 3 - High saving, 4 - Maximum saving.
SetThreadsLimit #
static void SetThreadsLimit(int)On BarkoderConfig. Sets the threads limit. Throws IllegalArgumentException if the value is greater than the maximum threads available on the device.
applyConfigSettingsFromFile #
static void applyConfigSettingsFromFile(BarkoderConfig, String, BarkoderConfigCallback)On BarkoderHelper. Loads configuration properties from a JSON file path and applies them to the provided config.
applyConfigSettingsFromTemplate #
static void applyConfigSettingsFromTemplate(Context, BarkoderConfig, BarkoderConfigTemplate, BarkoderConfigCallback)On BarkoderHelper. Applies configuration parameters from a predefined template.
applyConfigSettingsFromURL #
static void applyConfigSettingsFromURL(BarkoderConfig, String, BarkoderConfigCallback)On BarkoderHelper. Retrieves configuration properties from a URL and applies them to the provided config.
applyJsonToConfig #
static void applyJsonToConfig(BarkoderConfig, JSONObject)On BarkoderHelper. Retrieves config properties from a JSON and applies them to the provided config.
configToJSONString #
static String configToJSONString(BarkoderConfig)On BarkoderHelper. Exports the provided configuration into a JSON string.
Camera #
startCamera #
void startCamera()On BarkoderView. Starts the camera preview only, without decoding.
getMaxZoomFactor #
void getMaxZoomFactor(MaxZoomAvailableCallback)On BarkoderView. Retrieves the maximum available zoom factor for the device's camera. Zoom factor is received in MaxZoomAvailableCallback.
isFlashAvailable #
void isFlashAvailable(FlashAvailableCallback)On BarkoderView. Checks whether the device has a built-in flash (torch) that can be used for illumination during barcode scanning. Result is received in FlashAvailableCallback.
isPreviewMirrored #
boolean isPreviewMirrored()On BarkoderView. Checks whether the camera preview is horizontally mirrored.
setCamera #
void setCamera(BarkoderCameraPosition)On BarkoderView. Sets which camera (front or back) is used for scanning.
setCameraCallback #
void setCameraCallback(CameraCallback)On BarkoderView. Sets the callback that receives camera events such as when the camera is opened, ready or fails to open.
setCentricFocusAndExposure #
void setCentricFocusAndExposure(boolean)On BarkoderView. Configures the camera to use the center of the viewfinder for focus and exposure.
setFlashEnabled #
void setFlashEnabled(boolean)On BarkoderView. Enables or disables the device's flash (torch) for illumination during barcode scanning.
setPreviewFramesCallback #
void setPreviewFramesCallback(BarkoderPreviewFramesCallback)On BarkoderView. Set the camera frames callback if you only want to receive frames/images without decoding them, allowing you to work with the frames directly. Remember to close the image when finished.
setPreviewMirrored #
void setPreviewMirrored(boolean)On BarkoderView. Controls whether the camera preview is horizontally mirrored.
setZoomFactor #
void setZoomFactor(float)On BarkoderView. Sets the zoom factor for the device's camera, adjusting the level of zoom during barcode scanning.
getBarkoderResolution #
BarkoderResolution getBarkoderResolution()On BarkoderConfig. Retrieves the resolution for barcode scanning.
isLocationInPreviewEnabled #
boolean isLocationInPreviewEnabled()On BarkoderConfig. Gets the value of locationInPreviewEnabled which enables or disables the display of barcode location information on the camera preview. If enabled, the scanned barcode will be marked on the preview screen for a short time.
isPinchToZoomEnabled #
boolean isPinchToZoomEnabled()On BarkoderConfig. Checks if pinch to zoom is enabled.
setBarkoderResolution #
void setBarkoderResolution(BarkoderResolution)On BarkoderConfig. Sets the resolution for barcode scanning.
setCameraOpenDelayMs #
void setCameraOpenDelayMs(int)On BarkoderConfig. Sets the delay, in milliseconds, before the camera is opened.
setLocationInPreviewEnabled #
void setLocationInPreviewEnabled(boolean)On BarkoderConfig. Enables or disables the display of barcode location information on the camera preview.
setPinchToZoomEnabled #
void setPinchToZoomEnabled(boolean)On BarkoderConfig. Enables or disables the pinch-to-zoom feature for adjusting the zoom level during barcode scanning.
Barcode types #
GetCustomOption #
static int GetCustomOption(Barkoder.Config, String)Retrieves the value of a custom decoder option by key. See details about available options and their values.
SetCustomOption #
static void SetCustomOption(Barkoder.Config, String, int)Sets a custom decoder option by key. See details about available options and their values.
getDecoderConfig #
Barkoder.Config getDecoderConfig()On BarkoderConfig. Obtain the decoder config object. This object allows you to enable or disable decoders (barcode types) and configure each one individually.
Results #
captureImage #
void captureImage()On BarkoderView. Captures the latest available camera frame and returns it through the BarkoderResultCallback scanningFinished callback (without decoding barcodes).
GetMulticodeCachingDuration #
static int GetMulticodeCachingDuration()On BarkoderConfig. Retrieves the caching duration (in milliseconds) for multi-code results.
getShowDuplicatesLocations #
boolean getShowDuplicatesLocations()On BarkoderConfig. Gets whether duplicate barcode locations are shown on the camera preview when the same code is scanned multiple times as Boolean.
getThresholdBetweenDuplicatesScans #
int getThresholdBetweenDuplicatesScans()On BarkoderConfig. Retrieves the threshold between duplicate scans.
getThumbnailOnResulEnabled #
boolean getThumbnailOnResulEnabled()On BarkoderConfig. Retrieves whether barcode thumbnail on result is enabled.
isBeepOnSuccessEnabled #
boolean isBeepOnSuccessEnabled()On BarkoderConfig. Retrieves the value indicating whether a beep sound is played on successful barcode scanning.
isCloseSessionOnResultEnabled #
boolean isCloseSessionOnResultEnabled()On BarkoderConfig. Checks if the session is closed on result enabled; true if the preview will be closed after a result, false otherwise.
isImageResultEnabled #
boolean isImageResultEnabled()On BarkoderConfig. Checks if the image result is enabled. Image result is received in BarkoderResultCallback as Bitmap.
IsMulticodeCachingEnabled #
static boolean IsMulticodeCachingEnabled()On BarkoderConfig. Retrieves whether multi-code caching is enabled.
isVibrateOnSuccessEnabled #
boolean isVibrateOnSuccessEnabled()On BarkoderConfig. Retrieves the value indicating whether vibration is enabled on successful barcode scanning.
setBeepOnSuccessEnabled #
void setBeepOnSuccessEnabled(boolean)On BarkoderConfig. Enables or disables the audible beep sound upon successfully decoding a barcode.
setCloseSessionOnResultEnabled #
void setCloseSessionOnResultEnabled(boolean)On BarkoderConfig. Enables or disables the automatic closing of the scanning session upon detecting a barcode result.
setImageResultEnabled #
void setImageResultEnabled(boolean)On BarkoderConfig. Enables or disables the capturing and processing of image data when a barcode is successfully detected.
SetMulticodeCachingDuration #
static void SetMulticodeCachingDuration(int)On BarkoderConfig. Sets the caching duration (in milliseconds) for multi-code results.
SetMulticodeCachingEnabled #
static void SetMulticodeCachingEnabled(boolean)On BarkoderConfig. Sets whether multi-code caching is enabled.
setShowDuplicatesLocations #
void setShowDuplicatesLocations(boolean)On BarkoderConfig. Sets whether duplicate barcode locations are shown on the camera preview when the same code is scanned multiple times.
setThresholdBetweenDuplicatesScans #
void setThresholdBetweenDuplicatesScans(int)On BarkoderConfig. Sets the threshold between duplicate scans.
setThumbnailOnResultEnabled #
void setThumbnailOnResultEnabled(boolean)On BarkoderConfig. Sets whether to enable barcode thumbnail on result.
setVibrateOnSuccessEnabled #
void setVibrateOnSuccessEnabled(boolean)On BarkoderConfig. Enables or disables the device vibration upon successfully decoding a barcode.
sadlImage #
static Bitmap sadlImage(Barkoder.BKKeyValue[])On BarkoderHelper. Builds the SADL image as a Bitmap from the provided key-value data.
scanImage #
static void scanImage(Bitmap, BarkoderConfig, BarkoderResultCallback, Context)On BarkoderHelper. Scans barcodes from a bitmap image.
Region & overlay #
getLocationLineColor #
int getLocationLineColor()On BarkoderConfig. Retrieves the color code representing the line color used to indicate the location of detected barcodes.
getLocationLineWidth #
float getLocationLineWidth()On BarkoderConfig. Retrieves the current width setting for the lines indicating the location of detected barcodes on the camera feed.
getRegionOfInterest #
Barkoder.BKRect getRegionOfInterest()On BarkoderConfig. Retrieves the region of interest (ROI).
getRoiCenterMark #
BarkoderRoiCenterMark getRoiCenterMark()On BarkoderConfig. Returns the currently configured ROI center mark.
getRoiLineColor #
int getRoiLineColor()On BarkoderConfig. Retrieves the color code representing the line color of the Region of Interest (ROI) on the camera preview.
getRoiLineWidth #
float getRoiLineWidth()On BarkoderConfig. Retrieves the current width setting for the lines outlining the Region of Interest (ROI) on the camera preview.
getRoiOverlayBackgroundColor #
int getRoiOverlayBackgroundColor()On BarkoderConfig. Retrieves the color code representing the background color of the overlay within the Region of Interest (ROI) on the camera preview.
getScanningIndicatorAnimation #
int getScanningIndicatorAnimation()On BarkoderConfig. Retrieves the scanning indicator animation mode as Int.
getScanningIndicatorColor #
int getScanningIndicatorColor()On BarkoderConfig. Retrieves the color of the scanning indicator as Int.
getScanningIndicatorWidth #
float getScanningIndicatorWidth()On BarkoderConfig. Retrieves the width of the scanning indicator as Float.
isLocationInImageResultEnabled #
boolean isLocationInImageResultEnabled()On BarkoderConfig. Checks if barcode location in the image result is enabled. If enabled, the barcode in the result image will be marked.
isRegionOfInterestVisible #
boolean isRegionOfInterestVisible()On BarkoderConfig. Checks if the region of interest (ROI) is visible.
isScanningIndicatorAlwaysVisible #
boolean isScanningIndicatorAlwaysVisible()On BarkoderConfig. Retrieves whether the scanning indicator is always visible as Boolean.
setLocationInImageResultEnabled #
void setLocationInImageResultEnabled(boolean)On BarkoderConfig. Enables or disables the inclusion of barcode location information within the image data result.
setLocationLineColor #
void setLocationLineColor(int)On BarkoderConfig. Sets the color of the lines used to indicate the location of detected barcodes on the camera feed.
setLocationLineWidth #
void setLocationLineWidth(float)On BarkoderConfig. Sets the width of the lines indicating the location of detected barcodes on the camera feed.
setRegionOfInterest #
void setRegionOfInterest(float, float, float, float)On BarkoderConfig. Defines the Region of Interest (ROI) on the camera preview for barcode scanning, specifying an area where the application focuses on detecting barcodes. Throws IllegalArgumentException if the input params are not valid.
setRegionOfInterestVisible #
void setRegionOfInterestVisible(boolean)On BarkoderConfig. Sets the visibility of the Region of Interest (ROI) on the camera preview.
setRoiCenterMark #
void setRoiCenterMark(BarkoderRoiCenterMark)On BarkoderConfig. Sets the center mark displayed in the scanner's Region of Interest (ROI). The barcode scanner will scan only within the ROI, with the selected center mark indicating the center of the scanning area. Available BarkoderRoiCenterMark modes: POINT - displays a point at the center of the ROI; CROSSHAIR - displays a crosshair at the center of the ROI; NONE - no center mark is displayed.
setRoiLineColor #
void setRoiLineColor(int)On BarkoderConfig. Sets the color of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed.
setRoiLineWidth #
void setRoiLineWidth(float)On BarkoderConfig. Sets the width of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed.
setRoiOverlayBackgroundColor #
void setRoiOverlayBackgroundColor(int)On BarkoderConfig. Sets the background color of the overlay within the Region of Interest (ROI) for barcode scanning on the camera feed.
setScanningIndicatorAlwaysVisible #
void setScanningIndicatorAlwaysVisible(boolean)On BarkoderConfig. Sets whether the scanning indicator is always visible on the camera preview.
setScanningIndicatorAnimation #
void setScanningIndicatorAnimation(int)On BarkoderConfig. Sets the scanning indicator animation mode as Int.
setScanningIndicatorColor #
void setScanningIndicatorColor(int)On BarkoderConfig. Sets the color of the scanning indicator as Int.
setScanningIndicatorWidth #
void setScanningIndicatorWidth(float)On BarkoderConfig. Sets the width of the scanning indicator as Float.
AR mode #
resetArCache #
void resetArCache()On BarkoderView. Clears all cached barcode results from the current AR scanning session. Available only when AR mode is enabled.
arConfig #
BarkoderArConfig arConfigOn BarkoderConfig. Configuration options for AR barcode detection and overlay behavior.
getArConfig #
BarkoderArConfig getArConfig()On BarkoderConfig. Retrieves the configuration options for AR barcode detection and overlay behavior.
arMode #
BarkoderARMode arModeOn BarkoderArConfig. The AR behavior mode.
barcodeThumbnailOnResult #
boolean barcodeThumbnailOnResultOn BarkoderArConfig. Whether barcode thumbnails are included in AR results.
continueScanningOnLimit #
Boolean continueScanningOnLimitOn BarkoderArConfig. Whether scanning continues after reaching the result limit.
displayOnlyMatchedResults #
boolean displayOnlyMatchedResultsOn BarkoderArConfig. Whether only matched results are displayed. If false, all decoded results are displayed, including unmatched results. This option only applies when arMode is MatchFilter and a match filter is active.
doubleTapToFreezeEnabled #
boolean doubleTapToFreezeEnabledOn BarkoderArConfig. Whether double-tap to freeze is enabled.
emitResultsAtSessionEndOnly #
Boolean emitResultsAtSessionEndOnlyOn BarkoderArConfig. Whether results are emitted only when the session ends.
getARMode #
BarkoderARMode getARMode()On BarkoderArConfig. Retrieves the current AR behavior mode.
getContinueScanningOnLimit #
boolean getContinueScanningOnLimit()On BarkoderArConfig. Checks if scanning continues after reaching the result limit.
getDisplayOnlyMatchedResults #
boolean getDisplayOnlyMatchedResults()On BarkoderArConfig. Checks whether only matched results are displayed. If false, all decoded results are displayed, including unmatched results. This option only applies when arMode is MatchFilter and a match filter is active.
getEmitResultsAtSessionEndOnly #
boolean getEmitResultsAtSessionEndOnly()On BarkoderArConfig. Checks if results are emitted only when the session ends.
getHeaderHeight #
float getHeaderHeight()On BarkoderArConfig. Gets the AR header height.
getHeaderHorizontalTextMargin #
float getHeaderHorizontalTextMargin()On BarkoderArConfig. Gets the horizontal text margin inside the header.
getHeaderMaxTextHeight #
float getHeaderMaxTextHeight()On BarkoderArConfig. Gets the maximum header text height.
getHeaderMinTextHeight #
float getHeaderMinTextHeight()On BarkoderArConfig. Gets the minimum header text height.
getHeaderShowMode #
BarkoderARHeaderShowMode getHeaderShowMode()On BarkoderArConfig. Gets when the header text (label above barcodes) is visible in AR mode.
getHeaderTextColorNonSelected #
int getHeaderTextColorNonSelected()On BarkoderArConfig. Gets the header text color when a barcode is not selected.
getHeaderTextColorSelected #
int getHeaderTextColorSelected()On BarkoderArConfig. Gets the header text color when a barcode is selected.
getHeaderTextFormat #
String getHeaderTextFormat()On BarkoderArConfig. Gets the format string used to display header text.
getHeaderVerticalTextMargin #
float getHeaderVerticalTextMargin()On BarkoderArConfig. Gets the vertical text margin inside the header.
getLocationTransitionSpeed #
float getLocationTransitionSpeed()On BarkoderArConfig. Gets the overlay transition smoothing speed.
getLocationType #
BarkoderARLocationType getLocationType()On BarkoderArConfig. Gets the AR overlay location type.
getNonSelectedLocationColor #
int getNonSelectedLocationColor()On BarkoderArConfig. Gets the color used for non-selected barcode overlays.
getNonSelectedLocationLineWidth #
float getNonSelectedLocationLineWidth()On BarkoderArConfig. Gets the line width used for non-selected barcode outlines.
getOverlayRefresh #
BarkoderAROverlayRefresh getOverlayRefresh()On BarkoderArConfig. Gets the overlay refresh mode.
getResultDisappearanceDelayMs #
int getResultDisappearanceDelayMs()On BarkoderArConfig. Gets the delay after which AR results expire and disappear from the view.
getResultLimit #
int getResultLimit()On BarkoderArConfig. Gets the maximum number of results allowed.
getReturnOnlyMatchedResults #
boolean getReturnOnlyMatchedResults()On BarkoderArConfig. Checks whether only matched results are returned. If false, all detected results are returned, while unmatched results have isMatched set to false. This option only applies when arMode is MatchFilter and a match filter is active.
getSelectedLocationColor #
int getSelectedLocationColor()On BarkoderArConfig. Gets the color used for selected barcode outlines.
getSelectedLocationLineWidth #
float getSelectedLocationLineWidth()On BarkoderArConfig. Gets the line width used for selected barcode outlines.
headerHeight #
float headerHeightOn BarkoderArConfig. The AR header height.
headerHorizontalTextMargin #
float headerHorizontalTextMarginOn BarkoderArConfig. The horizontal text margin inside the header.
headerMaxTextHeight #
float headerMaxTextHeightOn BarkoderArConfig. The maximum header text height.
headerMinTextHeight #
float headerMinTextHeightOn BarkoderArConfig. The minimum header text height.
headerShowMode #
BarkoderARHeaderShowMode headerShowModeOn BarkoderArConfig. When the header text (label above barcodes) is visible in AR mode.
headerTextColorNonSelected #
int headerTextColorNonSelectedOn BarkoderArConfig. The header text color when a barcode is not selected.
headerTextColorSelected #
int headerTextColorSelectedOn BarkoderArConfig. The header text color when a barcode is selected.
headerTextFormat #
String headerTextFormatOn BarkoderArConfig. The format string used to display header text.
headerVerticalTextMargin #
float headerVerticalTextMarginOn BarkoderArConfig. The vertical text margin inside the header.
imageResultEnabled #
boolean imageResultEnabledOn BarkoderArConfig. Whether image capturing for selected barcodes is enabled.
isBarcodeThumbnailOnResultEnabled #
boolean isBarcodeThumbnailOnResultEnabled()On BarkoderArConfig. Checks if barcode thumbnails are included in AR results.
isDoubleTapToFreezeEnabled #
boolean isDoubleTapToFreezeEnabled()On BarkoderArConfig. Checks if double-tap to freeze is enabled.
isImageResultEnabled #
boolean isImageResultEnabled()On BarkoderArConfig. Checks if image capturing for selected barcodes is enabled.
locationTransitionSpeed #
float locationTransitionSpeedOn BarkoderArConfig. The overlay transition smoothing speed.
locationType #
BarkoderARLocationType locationTypeOn BarkoderArConfig. The AR overlay location type.
nonSelectedLocationLineColor #
int nonSelectedLocationLineColorOn BarkoderArConfig. The color used for non-selected barcode overlays.
nonSelectedLocationLineWidth #
float nonSelectedLocationLineWidthOn BarkoderArConfig. The line width used for non-selected barcode outlines.
overlayRefresh #
BarkoderAROverlayRefresh overlayRefreshOn BarkoderArConfig. The overlay refresh mode.
resetArCache #
void resetArCache()On BarkoderArConfig. Clears all cached barcode results from the current AR scanning session. Available only when AR mode is enabled.
resultDisappearanceDelayMs #
int resultDisappearanceDelayMsOn BarkoderArConfig. The delay after which AR results expire and disappear from the view.
resultLimit #
int resultLimitOn BarkoderArConfig. The maximum number of results allowed.
returnOnlyMatchedResults #
boolean returnOnlyMatchedResultsOn BarkoderArConfig. Whether only matched results are returned. If false, all detected results are returned, while unmatched results have isMatched set to false. This option only applies when arMode is MatchFilter and a match filter is active.
selectedLocationColor #
int selectedLocationColorOn BarkoderArConfig. The color used for selected barcode outlines.
selectedLocationLineWidth #
float selectedLocationLineWidthOn BarkoderArConfig. The line width used for selected barcode outlines.
setARModeEnabled #
void setARModeEnabled(BarkoderARMode)On BarkoderArConfig. Defines the overall AR behavior mode (InteractiveEnabled, InteractiveDisabled, NonInteractive, MatchFilter or disabled).
setBarcodeThumbnailOnResultEnabled #
void setBarcodeThumbnailOnResultEnabled(boolean)On BarkoderArConfig. Enables or disables thumbnail generation in AR results.
setContinueScanningOnLimit #
void setContinueScanningOnLimit(boolean)On BarkoderArConfig. Sets whether scanning continues after reaching the result limit.
setDisplayOnlyMatchedResults #
void setDisplayOnlyMatchedResults(boolean)On BarkoderArConfig. Controls whether only matched results are displayed. If false, all decoded results are displayed, including unmatched results. This option only applies when arMode is MatchFilter and a match filter is active.
setDoubleTapToFreezeEnabled #
void setDoubleTapToFreezeEnabled(boolean)On BarkoderArConfig. Enables or disables double-tap freeze.
setEmitResultsAtSessionEndOnly #
void setEmitResultsAtSessionEndOnly(boolean)On BarkoderArConfig. Sets whether results are emitted only at session end.
setHeaderHeight #
void setHeaderHeight(float)On BarkoderArConfig. Sets the AR header height.
setHeaderHorizontalTextMargin #
void setHeaderHorizontalTextMargin(float)On BarkoderArConfig. Sets the horizontal text margin inside the header.
setHeaderMaxTextHeight #
void setHeaderMaxTextHeight(float)On BarkoderArConfig. Sets the maximum header text height.
setHeaderMinTextHeight #
void setHeaderMinTextHeight(float)On BarkoderArConfig. Sets the minimum header text height.
setHeaderShowMode #
void setHeaderShowMode(BarkoderARHeaderShowMode)On BarkoderArConfig. Defines when the header text (label above barcodes) should be visible in AR mode.
setHeaderTextColorNonSelected #
void setHeaderTextColorNonSelected(int)On BarkoderArConfig. Sets the header text color for non-selected barcodes.
setHeaderTextColorSelected #
void setHeaderTextColorSelected(int)On BarkoderArConfig. Sets the header text color for selected barcodes.
setHeaderTextFormat #
void setHeaderTextFormat(String)On BarkoderArConfig. Sets the format string used to display header text.
setHeaderVerticalTextMargin #
void setHeaderVerticalTextMargin(float)On BarkoderArConfig. Sets the vertical text margin inside the header.
setImageResultEnabled #
void setImageResultEnabled(boolean)On BarkoderArConfig. Enables or disables image result capturing.
setLocationTransitionSpeed #
void setLocationTransitionSpeed(float)On BarkoderArConfig. Sets the overlay transition smoothing speed.
setLocationType #
void setLocationType(BarkoderARLocationType)On BarkoderArConfig. Sets the AR overlay location type.
setNonSelectedLocationColor #
void setNonSelectedLocationColor(int)On BarkoderArConfig. Sets the color used for non-selected barcode overlays.
setNonSelectedLocationLineWidth #
void setNonSelectedLocationLineWidth(float)On BarkoderArConfig. Sets the line width used for non-selected barcode outlines.
setOverlayRefresh #
void setOverlayRefresh(BarkoderAROverlayRefresh)On BarkoderArConfig. Sets the overlay refresh mode.
setResultDisappearanceDelayMs #
void setResultDisappearanceDelayMs(int)On BarkoderArConfig. Sets the disappearance delay for AR results.
setResultLimit #
void setResultLimit(int)On BarkoderArConfig. Sets the maximum number of results allowed.
setReturnOnlyMatchedResults #
void setReturnOnlyMatchedResults(boolean)On BarkoderArConfig. Controls whether only matched results are returned. If false, all detected results are returned, while unmatched results have isMatched set to false. This option only applies when arMode is MatchFilter and a match filter is active.
setSelectedLocationColor #
void setSelectedLocationColor(int)On BarkoderArConfig. Sets the color used for selected barcode outlines.
setSelectedLocationLineWidth #
void setSelectedLocationLineWidth(float)On BarkoderArConfig. Sets the line width used for selected barcode outlines.
On-screen buttons #
configureCloseButton #
void configureCloseButton(boolean, float[], float, Integer, Integer, float, float, boolean, Bitmap, Runnable)On BarkoderView. Configures the Close button used while scanning.
configureFlashButton #
void configureFlashButton(boolean, float[], float, Integer, Integer, float, float, boolean, Bitmap, Bitmap)On BarkoderView. Configures the Flash (torch) button used while scanning, including position, size, styling and custom icons.
configureZoomButton #
void configureZoomButton(boolean, float[], float, Integer, Integer, float, float, boolean, Bitmap, Bitmap, float, float)On BarkoderView. Configures the Zoom toggle button used while scanning, including position, size, styling, custom icons and zoom factors.
Settings models #
Barkoder.Config #
class, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
AustralianPost | field | Barkoder.AustralianPostConfig AustralianPost |
Aztec | field | Barkoder.AztecConfig Aztec |
AztecCompact | field | Barkoder.AztecCompactConfig AztecCompact |
Codabar | field | Barkoder.CodabarConfig Codabar |
Code11 | field | Barkoder.Code11Config Code11 |
Code128 | field | Barkoder.Code128Config Code128 |
Code25 | field | Barkoder.Code25Config Code25 |
Code32 | field | Barkoder.Code32Config Code32 |
Code39 | field | Barkoder.Code39Config Code39 |
Code93 | field | Barkoder.Code93Config Code93 |
Config | constructor | Config() |
COOP25 | field | Barkoder.COOP25Config COOP25 |
Databar14 | field | Barkoder.Databar14Config Databar14 |
DatabarExpanded | field | Barkoder.DatabarExpandedConfig DatabarExpanded |
DatabarLimited | field | Barkoder.DatabarLimitedConfig DatabarLimited |
Datalogic25 | field | Barkoder.Datalogic25Config Datalogic25 |
Datamatrix | field | Barkoder.DatamatrixConfig Datamatrix |
decodingSpeed | field | Barkoder.DecodingSpeed decodingSpeed |
Dotcode | field | Barkoder.DotcodeConfig Dotcode |
duplicatesDelayMs | field | int duplicatesDelayMs |
Ean13 | field | Barkoder.Ean13Config Ean13 |
Ean8 | field | Barkoder.Ean8Config Ean8 |
enableComposite | field | int enableComposite |
enableMisshaped1D | field | boolean enableMisshaped1D |
enableVINRestrictions | field | boolean enableVINRestrictions |
encodingCharacterSet | field | String encodingCharacterSet |
formattingType | field | Barkoder.FormattingType formattingType |
GetAvailableDecoders | method | Barkoder.DecoderType[] GetAvailableDecoders() |
GetEnabledDecoders | method | Barkoder.DecoderType[] GetEnabledDecoders() |
IATA25 | field | Barkoder.IATA25Config IATA25 |
IDDocument | field | Barkoder.IDDocumentConfig IDDocument |
Interleaved25 | field | Barkoder.Interleaved25Config Interleaved25 |
ITF14 | field | Barkoder.ITF14Config ITF14 |
JapanesePost | field | Barkoder.JapanesePostConfig JapanesePost |
KIX | field | Barkoder.KIXConfig KIX |
matchFilter | field | String matchFilter |
Matrix25 | field | Barkoder.Matrix25Config Matrix25 |
MaxiCode | field | Barkoder.MaxiCodeConfig MaxiCode |
maximumResultsCount | field | int maximumResultsCount |
Msi | field | Barkoder.MsiConfig Msi |
OCRText | field | Barkoder.OCRTextConfig OCRText |
PDF417 | field | Barkoder.PDF417Config PDF417 |
PDF417Micro | field | Barkoder.PDF417MicroConfig PDF417Micro |
Planet | field | Barkoder.PlanetConfig Planet |
PostalIMB | field | Barkoder.PostalIMBConfig PostalIMB |
Postnet | field | Barkoder.PostnetConfig Postnet |
QR | field | Barkoder.QRConfig QR |
QRMicro | field | Barkoder.QRMicroConfig QRMicro |
regionOfInterest | field | Barkoder.BKRect regionOfInterest |
returnOnlyMatchedResults | field | boolean returnOnlyMatchedResults |
RoyalMail | field | Barkoder.RoyalMailConfig RoyalMail |
SetEnabledDecoders | method | void SetEnabledDecoders(Barkoder.DecoderType[]) |
SetRegionOfInterest | method | void SetRegionOfInterest(float, float, float, float) |
Telepen | field | Barkoder.TelepenConfig Telepen |
UpcA | field | Barkoder.UpcAConfig UpcA |
UpcE | field | Barkoder.UpcEConfig UpcE |
UpcE1 | field | Barkoder.UpcE1Config UpcE1 |
upcEanDeblur | field | boolean upcEanDeblur |
Barkoder.SpecificConfig #
class, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
decoderType | field | Barkoder.DecoderType decoderType |
enabled | field | boolean enabled |
expectedCount | field | int expectedCount |
licensed | field | boolean licensed |
maximumLength | field | int maximumLength |
minimumLength | field | int minimumLength |
setLengthRange | method | int setLengthRange(int, int) |
SpecificConfig | constructor | SpecificConfig() |
typeName | field | String typeName |
Barkoder.AustralianPostConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
AustralianPostConfig | constructor | AustralianPostConfig() |
Barkoder.AztecCompactConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
AztecCompactConfig | constructor | AztecCompactConfig() |
Barkoder.AztecConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
AztecConfig | constructor | AztecConfig() |
Barkoder.CodabarConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
CodabarConfig | constructor | CodabarConfig() |
Barkoder.Code11Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
checksumType | field | Barkoder.Code11ChecksumType checksumType |
Code11Config | constructor | Code11Config() |
Barkoder.Code128Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
Code128Config | constructor | Code128Config() |
Barkoder.Code25Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
checksumType | field | Barkoder.StandardChecksumType checksumType |
Code25Config | constructor | Code25Config() |
Barkoder.Code32Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
Code32Config | constructor | Code32Config() |
Barkoder.Code39Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
checksumType | field | Barkoder.Code39ChecksumType checksumType |
Code39Config | constructor | Code39Config() |
Barkoder.Code93Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
Code93Config | constructor | Code93Config() |
Barkoder.COOP25Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
checksumType | field | Barkoder.StandardChecksumType checksumType |
COOP25Config | constructor | COOP25Config() |
Barkoder.Databar14Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
Databar14Config | constructor | Databar14Config() |
Barkoder.DatabarExpandedConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
DatabarExpandedConfig | constructor | DatabarExpandedConfig() |
Barkoder.DatabarLimitedConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
DatabarLimitedConfig | constructor | DatabarLimitedConfig() |
Barkoder.Datalogic25Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
checksumType | field | Barkoder.StandardChecksumType checksumType |
Datalogic25Config | constructor | Datalogic25Config() |
Barkoder.DatamatrixConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
DatamatrixConfig | constructor | DatamatrixConfig() |
dpmMode | field | boolean dpmMode |
Barkoder.DotcodeConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
DotcodeConfig | constructor | DotcodeConfig() |
Barkoder.Ean13Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
Ean13Config | constructor | Ean13Config() |
Barkoder.Ean8Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
Ean8Config | constructor | Ean8Config() |
Barkoder.IATA25Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
checksumType | field | Barkoder.StandardChecksumType checksumType |
IATA25Config | constructor | IATA25Config() |
Barkoder.IDDocumentConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
IDDocumentConfig | constructor | IDDocumentConfig() |
masterChecksumType | field | Barkoder.StandardChecksumType masterChecksumType |
Barkoder.Interleaved25Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
checksumType | field | Barkoder.StandardChecksumType checksumType |
Interleaved25Config | constructor | Interleaved25Config() |
Barkoder.ITF14Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
ITF14Config | constructor | ITF14Config() |
Barkoder.JapanesePostConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
JapanesePostConfig | constructor | JapanesePostConfig() |
Barkoder.KIXConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
KIXConfig | constructor | KIXConfig() |
Barkoder.Matrix25Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
checksumType | field | Barkoder.StandardChecksumType checksumType |
Matrix25Config | constructor | Matrix25Config() |
Barkoder.MaxiCodeConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
MaxiCodeConfig | constructor | MaxiCodeConfig() |
Barkoder.MsiConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
checksumType | field | Barkoder.MsiChecksumType checksumType |
MsiConfig | constructor | MsiConfig() |
Barkoder.OCRTextConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
OCRTextConfig | constructor | OCRTextConfig() |
Barkoder.PDF417Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
PDF417Config | constructor | PDF417Config() |
Barkoder.PDF417MicroConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
PDF417MicroConfig | constructor | PDF417MicroConfig() |
Barkoder.PlanetConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
PlanetConfig | constructor | PlanetConfig() |
Barkoder.PostalIMBConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
PostalIMBConfig | constructor | PostalIMBConfig() |
Barkoder.PostnetConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
PostnetConfig | constructor | PostnetConfig() |
Barkoder.QRConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
dpmMode | field | boolean dpmMode |
multiPartMerge | field | boolean multiPartMerge |
QRConfig | constructor | QRConfig() |
Barkoder.QRMicroConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
dpmMode | field | boolean dpmMode |
QRMicroConfig | constructor | QRMicroConfig() |
Barkoder.RoyalMailConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
RoyalMailConfig | constructor | RoyalMailConfig() |
Barkoder.TelepenConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
TelepenConfig | constructor | TelepenConfig() |
Barkoder.UpcAConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
UpcAConfig | constructor | UpcAConfig() |
Barkoder.UpcE1Config #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
expandToUPCA | field | boolean expandToUPCA |
UpcE1Config | constructor | UpcE1Config() |
Barkoder.UpcEConfig #
class, extends Barkoder.SpecificConfig, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
expandToUPCA | field | boolean expandToUPCA |
UpcEConfig | constructor | UpcEConfig() |
Result models #
Barkoder.BKImageDescriptor #
class, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
BKImageDescriptor | constructor | BKImageDescriptor(Bitmap, String) |
image | field | Bitmap image |
name | field | String name |
Barkoder.BKKeyValue #
class, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
BKKeyValue | constructor | BKKeyValue() |
key | field | String key |
value | field | String value |
Barkoder.BKLocation #
class, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
BKLocation | constructor | BKLocation() |
locationName | field | String locationName |
points | field | Barkoder.BKPoint[] points |
Barkoder.LicenseCheckResult #
class, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
code | field | int code |
message | field | String message |
Barkoder.Result #
class, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
barcodeType | field | Barkoder.BarcodeType barcodeType |
barcodeTypeName | field | String barcodeTypeName |
binaryData | field | byte[] binaryData |
characterSet | field | String characterSet |
extra | field | Barkoder.BKKeyValue[] extra |
images | field | Barkoder.BKImageDescriptor[] images |
isMatched | field | boolean isMatched |
location | field | Barkoder.BKLocation location |
Result | constructor | Result() |
textualData | field | String textualData |
Callbacks & events #
Barkoder.LicenseCheckListener #
interface, package com.barkoder
| Member | Kind | Declaration |
|---|---|---|
onLicenseCheck | method | void onLicenseCheck(Barkoder.LicenseCheckResult) |
interfaces.BarkoderConfigCallback #
interface, package com.barkoder.interfaces
| Member | Kind | Declaration |
|---|---|---|
onFail | method | void onFail(BarkoderException) |
onSuccess | method | void onSuccess() |
interfaces.BarkoderPerformanceCallback #
interface, package com.barkoder.interfaces
| Member | Kind | Declaration |
|---|---|---|
performanceReceived | method | void performanceReceived(float, float) |
interfaces.BarkoderPreviewFramesCallback #
interface, package com.barkoder.interfaces
| Member | Kind | Declaration |
|---|---|---|
previewFrameReceived | method | void previewFrameReceived(byte[], int, int, int, Image) |
interfaces.BarkoderResultCallback #
interface, package com.barkoder.interfaces
| Member | Kind | Declaration |
|---|---|---|
scanningFinished | method | void scanningFinished(Barkoder.Result[], Bitmap[], Bitmap) |
interfaces.CameraCallback #
interface, package com.barkoder.interfaces
| Member | Kind | Declaration |
|---|---|---|
onCameraFailedToOpen | method | void onCameraFailedToOpen(String) |
onCameraOpened | method | void onCameraOpened() |
onCameraReady | method | void onCameraReady() |
interfaces.FlashAvailableCallback #
interface, package com.barkoder.interfaces
| Member | Kind | Declaration |
|---|---|---|
onFlashAvailable | method | void onFlashAvailable(boolean) |
interfaces.MaxZoomAvailableCallback #
interface, package com.barkoder.interfaces
| Member | Kind | Declaration |
|---|---|---|
onMaxZoomAvailable | method | void onMaxZoomAvailable(float) |
Enums #
Barkoder.BarcodeType #
enum, package com.barkoder
| Value |
|---|
Aztec |
AztecCompact |
QR |
QRMicro |
Code128 |
Code93 |
Code39 |
Codabar |
Code11 |
Msi |
UpcA |
UpcE |
UpcE1 |
Ean13 |
Ean8 |
PDF417 |
PDF417Micro |
Datamatrix |
Code25 |
Interleaved25 |
ITF14 |
IATA25 |
Matrix25 |
Datalogic25 |
COOP25 |
Code32 |
Telepen |
Dotcode |
IDDocument |
IDMRZ |
IDPicture |
IDSignature |
Databar14 |
DatabarLimited |
DatabarExpanded |
PostalIMB |
Postnet |
Planet |
AustralianPost |
RoyalMail |
KIX |
JapanesePost |
MaxiCode |
OCRText |
Barkoder.Code11ChecksumType #
enum, package com.barkoder
| Value |
|---|
Disabled |
Single |
Double |
Barkoder.Code39ChecksumType #
enum, package com.barkoder
| Value |
|---|
Disabled |
Enabled |
Barkoder.DecodingSpeed #
enum, package com.barkoder
| Value |
|---|
Fast |
Normal |
Slow |
Rigorous |
Barkoder.FormattingType #
enum, package com.barkoder
| Value |
|---|
Disabled |
Automatic |
GS1 |
AAMVA |
SADL |
BCBP |
Barkoder.MsiChecksumType #
enum, package com.barkoder
| Value |
|---|
Disabled |
Mod10 |
Mod11 |
Mod1010 |
Mod1110 |
Mod11IBM |
Mod1110IBM |
Barkoder.StandardChecksumType #
enum, package com.barkoder
| Value |
|---|
Disabled |
Enabled |
enums.BarkoderARHeaderShowMode #
enum, package com.barkoder.enums
| Value |
|---|
NEVER |
ALWAYS |
ONSELECTED |
enums.BarkoderARLocationType #
enum, package com.barkoder.enums
| Value |
|---|
NONE |
TIGHT |
BOUNDINGBOX |
enums.BarkoderARMode #
enum, package com.barkoder.enums
| Value |
|---|
OFF |
InteractiveDisabled |
InteractiveEnabled |
NonInteractive |
MatchFilter |
enums.BarkoderCameraPosition #
enum, package com.barkoder.enums
| Value |
|---|
BACK |
FRONT |
enums.BarkoderConfigTemplate #
enum, package com.barkoder.enums
| Value |
|---|
ALL |
PDF_OPTIMIZED |
QR |
RETAIL_1D |
INDUSTRIAL_1D |
ALL_2D |
DPM |
VIN |
DOTCODE |
ALL_1D |
MRZ |
GALLERY_SCAN |
COMPOSITE |
POSTAL_CODES |
AR |
| Member | Kind | Declaration |
|---|---|---|
fromKey | method | static BarkoderConfigTemplate fromKey(String) |
getKey | method | String getKey() |
enums.BarkoderResolution #
enum, package com.barkoder.enums
| Value |
|---|
HD |
FHD |
UHD |
NORMAL |
HIGH |
| Member | Kind | Declaration |
|---|---|---|
getHeight | method | int getHeight() |
getWidth | method | int getWidth() |
toString | method | String toString() |
enums.BarkoderRoiCenterMark #
enum, package com.barkoder.enums
| Value |
|---|
NONE |
CROSSHAIR |
POINT |
| Member | Kind | Declaration |
|---|---|---|
fromString | method | static BarkoderRoiCenterMark fromString(String) |
overlaymanager.BarkoderAROverlayRefresh #
enum, package com.barkoder.overlaymanager
| Value |
|---|
SMOOTH |
NORMAL |