Label Capture Validation Flow Overlay

Defined in library scandit_datacapture_label_ui

LabelCaptureValidationFlowOverlay
class LabelCaptureValidationFlowOverlay : DataCaptureOverlay

Added in version 7.5.0

Specialized overlay that provides a guided scanning experience with validation flow capabilities. This overlay enables multi-step scanning for complete label capture, allowing users to scan label fields progressively across multiple scans and providing a user-friendly data review and correction interface.

Key features of the validation flow:

  • Multi-step scanning - Capture several label fields across multiple scans

  • Field-by-field validation - Validate individual fields as they are captured

  • User review interface - Allow users to review and correct captured data

  • Configurable hint messages - Guide users through different scanning stages

  • Manual input support - Enable manual entry for fields that cannot be scanned

The validation flow ensures complete and accurate results by aggregating captured fields into a complete label which is reported through the LabelCaptureValidationFlowListener.

Note

This overlay focuses on validation flow and does not provide barcode or field highlighting. For visual feedback during scanning, use LabelCaptureBasicOverlay alongside this overlay.

Warning

The validation flow overlay only works with a single label definition. This label definition can contain multiple barcodes, text fields, expiry dates, and other field types.

LabelCaptureValidationFlowOverlay.withLabelCapture(labelCapture, view)
factory LabelCaptureValidationFlowOverlay.withLabelCapture(
        LabelCapture labelCapture,
        {DataCaptureView? view})

Added in version 7.5.0

Constructs a new overlay to visualize the label capture validation flow. When view is non-null, the overlay is automatically added to the view. Otherwise, the overlay needs to be added through a call to DataCaptureView.addOverlay().

applySettings(settings)
Future<void> applySettings(LabelCaptureValidationFlowSettings settings)

Added in version 7.5.0

Applies the new settings to the validation flow overlay.

listener
LabelCaptureValidationFlowListener? listener

Added in version 7.5.0

Sets the listener to this overlay instance to observe the label capture mode and get notified when a label has been validated and accepted by the end user.

view
DataCaptureView? view

Added in version 7.5.0

The view this data capture overlay is attached to. When the data capture overlay is currently not attached to a view, null is returned.