Barcode Count View

Defined in package com.scandit.datacapture.barcode.count.ui.view

BarcodeCountViewStyle

Added in version 6.15.0

The style of the BarcodeCountView

ICON

Added in version 6.15.0

Style that draws the highlights as icons and adds an animation for when a code newly appears.

DOT

Added in version 6.15.0

Style that draws the highlights as a dot and adds an animation for when a code newly appears.

BarcodeCountView

class BarcodeCountView : RelativeLayout

Added in version 6.15.0

BarcodeCount comes with a ready-to-use UI. Add BarcodeCountView to the view hierarchy. Please note that this view should be presented full screen.

newInstance(context, dataCaptureContext, mode)

fun BarcodeCountView.newInstance(context: Context,
        dataCaptureContext: DataCaptureContext?,
        mode: BarcodeCount): BarcodeCountView

Added in version 6.15.0

Constructs a new barcode count view.

newInstance(context, dataCaptureContext, mode, style)

fun BarcodeCountView.newInstance(context: Context,
        dataCaptureContext: DataCaptureContext?,
        mode: BarcodeCount,
        style: BarcodeCountViewStyle): BarcodeCountView

Added in version 6.15.0

Constructs a new barcode count view.

newInstance(context, dataCaptureView, mode)

fun BarcodeCountView.newInstance(context: Context,
        dataCaptureView: DataCaptureView,
        mode: BarcodeCount): BarcodeCountView

Added in version 6.15.0

Constructs a new barcode count view. This constructor method should only be used in special cases, and its use is not recommended.

newInstance(context, dataCaptureView, mode, style)

fun BarcodeCountView.newInstance(context: Context,
        dataCaptureView: DataCaptureView,
        mode: BarcodeCount,
        style: BarcodeCountViewStyle): BarcodeCountView

Added in version 6.15.0

Constructs a new barcode count view. This constructor method should only be used in special cases, and its use is not recommended.

newInstanceForMapping(context, dataCaptureContext, mode, style, mappingFlowSettings)

fun BarcodeCountView.newInstanceForMapping(context: Context,
        dataCaptureContext: DataCaptureContext?,
        mode: BarcodeCount,
        style: BarcodeCountViewStyle,
        mappingFlowSettings: BarcodeCountMappingFlowSettings): BarcodeCountView

Added in version 7.1.0

Constructs a new barcode count view to use with the grid mapping flow.

Note

The grid mapping flow only supports grids of 4 rows by 2 columns.

newInstanceForMapping(context, dataCaptureView, mode, style, mappingFlowSettings)

fun BarcodeCountView.newInstanceForMapping(context: Context,
        dataCaptureView: DataCaptureView,
        mode: BarcodeCount,
        style: BarcodeCountViewStyle,
        mappingFlowSettings: BarcodeCountMappingFlowSettings): BarcodeCountView

Added in version 7.1.0

Constructs a new barcode count view to use with the grid mapping flow.

Note

The grid mapping flow only supports grids of 4 rows by 2 columns.

shouldShowUserGuidanceView

var shouldShowUserGuidanceView: Boolean

Added in version 6.15.0

When set to true, user guidance and the loading view will be shown to the user. The user guidance prompts the user to scan, and to move closer or further away from the target barcodes in order to scan them properly.

By default this property is true.

shouldShowListProgressBar

var shouldShowListProgressBar: Boolean

Added in version 6.24.0

When set to true, a progress bar will be shown to the user when a capture list has been set using BarcodeCount.setBarcodeCountCaptureList(), indicating how many of the barcodes in the list have been scanned.

By default this property is true.

shouldShowListButton

var shouldShowListButton: Boolean

Added in version 6.15.0

When set to true, a list button will be shown to the user in the lower left hand corner of the screen. When tapped, this button will freeze the mode unless shouldDisableModeOnExitButtonTapped is set to false. This button triggers a call to BarcodeCountViewUiListener.onListButtonTapped().

By default this property is true.

shouldShowExitButton

var shouldShowExitButton: Boolean

Added in version 6.15.0

When set to true, an exit button will be shown in the lower right hand corner of the screen. The behavior for this button is left entirely to the developer, and does nothing by default. When clicked, this button triggers a call to BarcodeCountViewUiListener.onExitButtonTapped().

By default this property is true.

shouldShowShutterButton

var shouldShowShutterButton: Boolean

Added in version 6.15.0

When set to true, a shutter button will be shown to the user centered in the bottom of the screen. This button triggers the processing of the current video feed. The same functionality can be triggered by calling BarcodeCount.startScanningPhase().

By default this property is true.

shouldShowHints

var shouldShowHints: Boolean

Added in version 6.15.0

When set to true, this view will show some messages about currently scanned barcodes.

By default this property is true.

shouldShowClearHighlightsButton

var shouldShowClearHighlightsButton: Boolean

Added in version 6.15.0

When set to true, a button will be shown above the default shutter button. This button clears all currently shown barcodes highlights. The same functionality can be triggered by calling clearHighlights().

By default this property is false.

shouldShowSingleScanButton

var shouldShowSingleScanButton: Boolean

Added in version 6.16.0

When set to true, a button will be shown to the user in the lower left corner of the preview. The behavior for this button is left entirely to the developer, and does nothing by default. When clicked, this button triggers a call to BarcodeCountViewUiListener.onSingleScanButtonTapped().

By default this property is false.

shouldShowStatusModeButton

var shouldShowStatusModeButton: Boolean

Added in version 6.17.0

When set to true, a button will be shown to the user in the lower right corner of the preview. This button toggles “status mode”, in which the normal barcode highlights will be replaced by status indicators for each barcode. The status for each barcode must be provided via a BarcodeCountStatusProvider previously set with setStatusProvider().

If no BarcodeCountStatusProvider is set, clicking this button has no effect. If shouldShowStatusIconsOnScan is set to true, this property has no effect, and no button will be shown.

By default this property is false.

Note

The Barcode Count status mode API is still in beta and may change in future versions of Scandit Data Capture SDK.

shouldShowFloatingShutterButton

var shouldShowFloatingShutterButton: Boolean

Added in version 6.15.0

When set to true, a floating shutter button will be visible on screen. This button can be dragged to any position and, when tapped, will trigger the processing of the current video feed.

By default this property is false.

shouldShowToolbar

var shouldShowToolbar: Boolean

Added in version 6.16.0

When set to true, a collapsable toolbar will be visible at the top of the preview. This toolbar contains a set of convenience buttons for easy preference setting during scanning.

By default this property is true.

shouldDisableModeOnExitButtonTapped

var shouldDisableModeOnExitButtonTapped: Boolean

Added in version 6.17.0

When set to true, the mode will disable automatically when the default exit button is tapped.

By default this property is true.

setToolbarSettings(settings)

fun setToolbarSettings(settings: BarcodeCountToolbarSettings)

Added in version 6.16.0

Pass an instance of BarcodeCountToolbarSettings to configure the text and accessibility options for the toolbar.

setStatusProvider(provider)

fun setStatusProvider(provider: BarcodeCountStatusProvider)

Added in version 6.17.0

Sets a BarcodeCountStatusProvider for this view. This provider will be queried when the “status mode” button is clicked.

Note

The Barcode Count status mode API is still in beta and may change in future versions of Scandit Data Capture SDK.

listener

var listener: BarcodeCountViewListener?

Added in version 6.15.0

The listener which is called whenever a new TrackedBarcode is newly tracked or newly recognized.

Note

Using this listener requires the MatrixScan AR add-on.

uiListener

var uiListener: BarcodeCountViewUiListener?

Added in version 6.15.0

The listener which is called whenever the exit or list button of the view did receive a tap.

Note

Using this listener requires the MatrixScan AR add-on.

defaultRecognizedBrush()

fun BarcodeCountView.defaultRecognizedBrush(): Brush

Added in version 6.15.0

Returns the default brush to use for a recognized barcode. When setting a BarcodeCountCaptureList to the mode, this brush will be used for recognized barcodes that are part of the target list. Only used when setting the view style to BarcodeCountViewStyle.DOT.

defaultNotInListBrush()

fun BarcodeCountView.defaultNotInListBrush(): Brush

Added in version 6.15.0

Returns the default brush to use for a recognized barcode that’s not part of the target BarcodeCountCaptureList. Only used when setting the view style to BarcodeCountViewStyle.DOT.

defaultAcceptedBrush()

fun BarcodeCountView.defaultAcceptedBrush(): Brush

Added in version 7.0.0

Returns the default brush to use for accepted barcodes. Only used when setting the view style to BarcodeCountViewStyle.DOT.

defaultRejectedBrush()

fun BarcodeCountView.defaultRejectedBrush(): Brush

Added in version 7.0.0

Returns the default brush to use for rejected barcodes. Only used when setting the view style to BarcodeCountViewStyle.DOT.

recognizedBrush

var recognizedBrush: Brush?

Added in version 6.15.0

The brush applied to recognized tracked barcodes if BarcodeCountViewListener is not implemented. When setting a BarcodeCountCaptureList to the mode, this brush will be used for recognized barcodes that are part of the target list. Setting this brush to null hides all tracked barcodes.

Used only when the view uses the BarcodeCountViewStyle.DOT style.

notInListBrush

var notInListBrush: Brush?

Added in version 6.15.0

The brush applied to recognized tracked barcodes that are not part of the target BarcodeCountCaptureList, and only if BarcodeCountViewListener is not implemented. When BarcodeCountCaptureList is not set, this method will never be called. Setting this brush to null hides all tracked barcodes.

Used only when the view uses the BarcodeCountViewStyle.DOT style.

acceptedBrush

var acceptedBrush: Brush?

Added in version 7.0.0

The brush applied to accepted tracked barcodes if BarcodeCountViewListener is not implemented. Setting this brush to null hides all accepted barcodes.

Used only when the view uses the BarcodeCountViewStyle.DOT style.

rejectedBrush

var rejectedBrush: Brush?

Added in version 7.0.0

The brush applied to rejected tracked barcodes if BarcodeCountViewListener is not implemented. Setting this brush to null hides all rejected barcodes.

Used only when the view uses the BarcodeCountViewStyle.DOT style.

shouldShowScanAreaGuides

var shouldShowScanAreaGuides: Boolean

Added in version 6.15.0

When set to true, this view will visualize the active scan area used for BarcodeCount. This is useful to check margins defined on the DataCaptureView are set correctly. This property is meant for debugging during development and is not intended for use in production.

By default this property is false.

style

val style: BarcodeCountViewStyle

Added in version 6.15.0

The view style. Defaults to BarcodeCountViewStyle.DOT.

setStatusModeButtonContentDescription(text)

fun setStatusModeButtonContentDescription(
        text: String)

Added in version 6.17.0

Use this method to modify the content description for the status mode button provided by the view.

getStatusModeButtonContentDescription()

fun getStatusModeButtonContentDescription(): String

Added in version 6.17.0

Returns the content description for the status mode button provided by the view.

setClearHighlightsButtonText(text)

fun setClearHighlightsButtonText(text: String)

Added in version 6.15.0

Use this method to modify the text of the clear button label provided by the view.

getClearHighlightsButtonText()

fun getClearHighlightsButtonText(): String

Added in version 6.17.0

Returns the text of the clear button label provided by the view.

setListButtonContentDescription(text)

fun setListButtonContentDescription(text: String)

Added in version 6.15.0

Use this method to modify the content description for the list button provided by the view.

getListButtonContentDescription()

fun getListButtonContentDescription(): String

Added in version 6.17.0

Returns the content description for the list button provided by the view.

setExitButtonContentDescription(text)

fun setExitButtonContentDescription(text: String)

Added in version 6.15.0

Use this method to modify the content description for the exit button provided by the view.

getExitButtonContentDescription()

fun getExitButtonContentDescription(): String

Added in version 6.17.0

Returns the content description for the exit button provided by the view.

setShutterButtonContentDescription(text)

fun setShutterButtonContentDescription(text: String)

Added in version 6.15.0

Use this method to modify the content description for the shutter button provided by the view.

getShutterButtonContentDescription()

fun getShutterButtonContentDescription(): String

Added in version 6.17.0

Returns the content description for the shutter button provided by the view.

setClearHighlightsButtonContentDescription(text)

fun setClearHighlightsButtonContentDescription(
        text: String)

Added in version 6.15.0

Use this method to modify the content description for the “clear highlights” button provided by the view.

getClearHighlightsButtonContentDescription()

fun getClearHighlightsButtonContentDescription(): String

Added in version 6.17.0

Returns the content description for the “clear highlights” button provided by the view.

setSingleScanButtonContentDescription(text)

fun setSingleScanButtonContentDescription(
        text: String)

Added in version 6.16.0

Use this method to modify the content description for the “single scan” button provided by the view.

getSingleScanButtonContentDescription()

fun getSingleScanButtonContentDescription(): String

Added in version 6.17.0

Returns the content description for the “single scan” button provided by the view.

setFloatingShutterButtonContentDescription(text)

fun setFloatingShutterButtonContentDescription(
        text: String)

Added in version 6.15.0

Use this method to modify the content description for the floating shutter button provided by the view.

getFloatingShutterButtonContentDescription()

fun getFloatingShutterButtonContentDescription(): String

Added in version 6.17.0

Returns the content description for the floating shutter button provided by the view.

setTextForTapShutterToScanHint(text)

fun setTextForTapShutterToScanHint(text: String)

Added in version 6.15.0

Sets the text of the hint which suggests to tap the shutter button.

getTextForTapShutterToScanHint()

fun getTextForTapShutterToScanHint(): String

Added in version 6.17.0

Returns the text of the hint which suggests to tap the shutter button.

setTextForScanningHint(text)

fun setTextForScanningHint(text: String)

Added in version 6.15.0

Sets the text of the hint displayed while scanning is in progress.

getTextForScanningHint()

fun getTextForScanningHint(): String

Added in version 6.17.0

Returns the text of the hint displayed while scanning is in progress.

setTextForMoveCloserAndRescanHint(text)

fun setTextForMoveCloserAndRescanHint(text: String)

Added in version 6.15.0

Sets the text of the hint displayed when camera should be moved closer to rescan.

getTextForMoveCloserAndRescanHint()

fun getTextForMoveCloserAndRescanHint(): String

Added in version 6.17.0

Returns the text of the hint displayed when camera should be moved closer to rescan.

setTextForMoveFurtherAndRescanHint(text)

fun setTextForMoveFurtherAndRescanHint(text: String)

Added in version 6.15.0

Sets the text of the hint displayed when camera should be further away to rescan.

getTextForMoveFurtherAndRescanHint()

fun getTextForMoveFurtherAndRescanHint(): String

Added in version 6.17.0

Returns the text of the hint displayed when camera should be further away to rescan.

setTextForBarcodesNotInListDetectedHint(text)

fun setTextForBarcodesNotInListDetectedHint(
        text: String)

Added in version 6.23.0

Sets the text of the hint displayed when a barcode not in list is scanned.

getTextForBarcodesNotInListDetectedHint()

fun getTextForBarcodesNotInListDetectedHint(): String

Added in version 6.23.0

Returns the text of the hint displayed when a barcode not in list is scanned.

setTextForScreenCleanedUpHint(text)

fun setTextForScreenCleanedUpHint(text: String)

Added in version 7.2.0

Sets the text of the hint displayed when screen is cleaned.

getTextForScreenCleanedUpHint()

fun getTextForScreenCleanedUpHint(): String

Added in version 7.2.0

Returns the text of the hint displayed when screen is cleaned.

setExitButtonText(text)

fun setExitButtonText(text: String)

Added in version 6.15.0

Use this method to modify the text of the exit button label provided by the view.

getExitButtonText()

fun getExitButtonText(): String

Added in version 6.17.0

Returns the text of the exit button label provided by the view.

filterSettings

var filterSettings: BarcodeFilterHighlightSettings?

Added in version 6.15.0

Use this property to access or modify the current view settings for barcode filtering.

clearHighlights()

fun clearHighlights()

Added in version 6.15.0

Clear all currently shown barcodes highlights. This only affects screen rendering, and all detected barcodes will still be available in the BarcodeCountSession.

setBrushForRecognizedBarcode(barcode, brush)

fun setBrushForRecognizedBarcode(barcode: TrackedBarcode,
        brush: Brush?)

Added in version 6.18.0

Set a Brush to be used for a particular recognized TrackedBarcode. This will override any other applicable brush for this particular barcode.

Used only when the view uses the BarcodeCountViewStyle.DOT style.

setBrushForRecognizedBarcodeNotInList(barcode, brush)

fun setBrushForRecognizedBarcodeNotInList(
        barcode: TrackedBarcode,
        brush: Brush?)

Added in version 6.18.0

Set a Brush to be used for a particular recognized TrackedBarcode that doesn’t belong to the capture list. This will only be applicable when using a capture list, and will override any other applicable brush for this particular barcode.

Used only when the view uses the BarcodeCountViewStyle.DOT style.

setBrushForAcceptedBarcode(barcode, brush)

fun setBrushForAcceptedBarcode(barcode: TrackedBarcode,
        brush: Brush?)

Added in version 7.0.0

Set a Brush to be used for a particular accepted TrackedBarcode. This will override any other applicable brush for this particular barcode.

Used only when the view uses the BarcodeCountViewStyle.DOT style.

setBrushForRejectedBarcode(barcode, brush)

fun setBrushForRejectedBarcode(barcode: TrackedBarcode,
        brush: Brush?)

Added in version 7.0.0

Set a Brush to be used for a particular rejected TrackedBarcode. This will override any other applicable brush for this particular barcode.

Used only when the view uses the BarcodeCountViewStyle.DOT style.

enableHardwareTrigger(hardwareTriggerKeyCode)

fun enableHardwareTrigger(hardwareTriggerKeyCode: Int?)

Added in version 6.23.0

Enables the BarcodeCountView to react to clicks on the hardware button specified in hardwareTriggerKeyCode. Pass a null value to use the default button (The default button will be the dedicated HW button on XCover devices, and KeyEvent.KEYCODE_VOLUME_DOWN for other devices).

Note

This feature is only available on devices with api >= 28. Whether a device supports this can be checked at runtime with the hardwareTriggerSupported flag.

hardwareTriggerSupported

val BarcodeCountView.hardwareTriggerSupported: Boolean

Added in version 6.23.0

Returns whether the device supports listening for hardware button events. This is true for devices with api >= 28.

tapToUncountEnabled

var tapToUncountEnabled: Boolean

Added in version 6.25.0

Enable this feature to be able to deselect items by tapping on the highlights.

By default this property is false.

setTextForTapToUncountHint(text)

fun setTextForTapToUncountHint(text: String)

Added in version 6.25.0

Sets the text of the hint displayed when the user deselects an item.

getTextForTapToUncountHint()

fun getTextForTapToUncountHint(): String

Added in version 6.25.0

Returns the text of the hint displayed when the user deselects an item.

shouldShowTorchControl

var shouldShowTorchControl: Boolean

Added in version 6.26.0

Indicates whether the torch control button should be shown to the user.

Default is false.

torchControlPosition

var torchControlPosition: Anchor

Added in version 6.26.0

Updates the position of the torch control button.

Only Anchor.TOP_LEFT, Anchor.TOP_RIGHT, Anchor.BOTTOM_LEFT and Anchor.BOTTOM_RIGHT, are supported.

Any other value will default to Anchor.TOP_LEFT.

barcodeNotInListActionSettings

var barcodeNotInListActionSettings: BarcodeCountNotInListActionSettings

Added in version 7.0.0

Use this object to customize barcode not in list actions.

setTextForClusteringGestureHint(text)

fun setTextForClusteringGestureHint(text: String)

Added in version 7.1.0

Sets the text of the hint that suggests the user to use gestures to form clusters. Shown only when BarcodeCountSettings.clusteringMode is ClusteringMode.MANUAL or ClusteringMode.AUTO_WITH_MANUAL_CORRECTION.

getTextForClusteringGestureHint()

fun getTextForClusteringGestureHint(): String

Added in version 7.1.0

Gets the text of the hint that suggests the user to use gestures to form clusters.

By default this property is “Swipe or circle codes to group together.”

shouldShowStatusIconsOnScan

var shouldShowStatusIconsOnScan: Boolean

Added in version 7.3.0

When enabled, status icons will be loaded immediately after barcodes are scanned, without requiring manual activation of status mode. The status for each barcode must be provided via a BarcodeCountStatusProvider previously set with setStatusProvider(). When this is enabled, shouldShowStatusModeButton has no effect, and the status mode button will be hidden.

This is the recommended approach for displaying status icons in BarcodeCount.

Default is false.