Barcode Selection Basic Overlay#

Defined in library scandit_datacapture_barcode_selection_ui

BarcodeSelectionBasicOverlayStyle#

Added in version 6.10.0

The style of the BarcodeSelectionBasicOverlay.

frame#

Added in version 6.10.0

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

dot#

Added in version 6.10.0

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

BarcodeSelectionBasicOverlay#
class BarcodeSelectionBasicOverlay : DataCaptureOverlay

Added in version 6.10.0

An overlay for DataCaptureView that shows a simple augmentation over each selected barcode.

To display the augmentations, this overlay must be attached to a DataCaptureView. This may be done either by creating it with BarcodeSelectionBasicOverlay.withBarcodeSelectionForView() with a non-null view parameter or by passing this overlay to DataCaptureView.addOverlay().

A user of this class may configure the appearance of the augmentations by configuring the brush properties.

BarcodeSelectionBasicOverlay.withBarcodeSelectionForView(barcodeSelection, view)#
BarcodeSelectionBasicOverlay.withBarcodeSelectionForView(
        BarcodeSelection barcodeSelection,
        DataCaptureView? view)

Added in version 6.10.0

Constructs a new barcode selection basic overlay for the barcode selection instance. The overlay is automatically added to the view.

BarcodeSelectionBasicOverlay.withBarcodeSelectionForViewWithStyle(barcodeSelection, view, style)
BarcodeSelectionBasicOverlay.withBarcodeSelectionForViewWithStyle(
        BarcodeSelection barcodeSelection,
        DataCaptureView? view,
        BarcodeSelectionBasicOverlayStyle style)

Added in version 6.10.0

Constructs a new barcode selection basic overlay for the barcode selection instance with the specified style. The overlay is automatically added to the view.

BarcodeSelectionBasicOverlay.withBarcodeSelection(barcodeSelection)#
BarcodeSelectionBasicOverlay.withBarcodeSelection(
        BarcodeSelection barcodeSelection)

Added in version 6.10.0

Constructs a new barcode selection basic overlay for the barcode selection instance. For the overlay to be displayed on screen, it must be added to a DataCaptureView.

view#
DataCaptureView? view

Added in version 6.10.0

The view this barcode selection basic overlay is attached to. When the barcode selection basic overlay is currently not attached to a view, null is returned.

trackedBrush#
Brush trackedBrush

Added in version 6.10.0

The brush applied to recognized tracked barcodes. Setting this brush to Brush.transparent() hides all tracked barcodes.

aimedBrush#
Brush aimedBrush

Added in version 6.10.0

The brush applied to the barcode that is currently being aimed at.

selectedBrush#
Brush selectedBrush

Added in version 6.10.0

The brush applied to selected barcodes. Setting this brush to Brush.transparent() hides all selected barcodes.

selectingBrush#
Brush selectingBrush

Added in version 6.10.0

The brush applied to the barcodes for the short moment when they are being selected.

shouldShowScanAreaGuides#
bool shouldShowScanAreaGuides

Added in version 6.10.0

When set to true, this overlay will visualize the active scan area used for BarcodeSelection. 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.

shouldShowHints#
bool shouldShowHints

Added in version 6.10.0

When set to true, this overlay will visualize some hints explaining how to use barcode selection.

By default this property is true.

viewfinder#
Viewfinder get viewfinder

Added in version 6.10.0

The viewfinder of the overlay. The viewfinder is only visible when the selection type is BarcodeSelectionAimerSelection.

frozenBackgroundColor#
Color frozenBackgroundColor

Added in version 6.13.0

The overlay’s background color when in frozen state. This color will be on top of the video preview but below the highlights. Semitransparent black by default.

style#
final BarcodeSelectionBasicOverlayStyle style

Added in version 6.10.0

The overlay style. Defaults to Frame.