Advanced Configurations

Customization of the Overlays

Basic Overlay

To customize the appearance of an overlay you can implement a LabelCaptureBasicOverlayListener and/or LabelCaptureAdvancedOverlayListener interface, depending on the overlay(s) you are using.

The method brushForLabel() is called every time a label is captured, and brushForField() is called for each of its fields to determine the brush for the label or field.

overlay.listener = object : LabelCaptureBasicOverlayListener {
    /*
     * Customize the appearance of the overlay for the individual fields.
     */
    override fun brushForField(
        overlay: LabelCaptureBasicOverlay,
        field: LabelField,
        label: CapturedLabel,
    ): Brush? = when (field.name) {
        "<your-barcode-field-name>" -> Brush(Color.CYAN, Color.CYAN, 1f)
        "<your-expiry-date-field-name>" -> Brush(Color.GREEN, Color.GREEN, 1f)
        else -> Brush(Color.TRANSPARENT, Color.TRANSPARENT, 0f)
    }

    /*
     * Customize the appearance of the overlay for the full label.
     * In this example, we disable label overlays by returning null always.
     */
    override fun brushForLabel(
        overlay: LabelCaptureBasicOverlay,
        label: CapturedLabel,
    ): Brush? = null

    override fun onLabelTapped(
        overlay: LabelCaptureBasicOverlay,
        label: CapturedLabel,
    ) { 
        /*
         * Handle the user tap gesture on the label.
         */
    }
}

tip

You can also use LabelCaptureBasicOverlay.setLabelBrush() and LabelCaptureBasicOverlay.setCapturedFieldBrush() to configure the overlay if you don't need to customize the appearance based on the name or content of the fields.

Advanced Overlay

For more advanced use cases, such as adding custom views or implementing Augmented Reality (AR) features, you can use the LabelCaptureAdvancedOverlay. The example below creates an advanced overlay, configuring it to display a styled warning message below expiry date fields when they’re close to expiring, while ignoring other fields.

// Create an advanced overlay that allows for custom views to be added over detected label fields
// This is the key component for implementing Augmented Reality features
val advancedOverlay = LabelCaptureAdvancedOverlay.newInstance(dataCaptureManager.getLabelCapture(), view)

// Configure the advanced overlay with a listener that handles AR content creation and positioning
advancedOverlay.listener = object : LabelCaptureAdvancedOverlayListener {
    
    // This method is called when a label is detected - we return null since we're only adding AR elements to specific fields, not the entire label
    override fun viewForCapturedLabel(
        overlay: LabelCaptureAdvancedOverlay,
        capturedLabel: CapturedLabel,
    ): View? = null

    // This defines where on the detected label the AR view would be anchored 
    override fun anchorForCapturedLabel(
        overlay: LabelCaptureAdvancedOverlay,
        capturedLabel: CapturedLabel,
    ): Anchor = Anchor.CENTER

    // This defines the offset from the anchor point for the label's AR view
    override fun offsetForCapturedLabel(
        overlay: LabelCaptureAdvancedOverlay,
        capturedLabel: CapturedLabel,
        view: View,
    ): PointWithUnit = PointWithUnit(0f, 0f, MeasureUnit.PIXEL)

    // This method is called when a field is detected in a label
    override fun viewForCapturedLabelField(
        overlay: LabelCaptureAdvancedOverlay,
        labelField: LabelField,
    ): View? {
        // We only want to create AR elements for expiry date fields that are text-based
        if (labelField.name.contains("expiry", ignoreCase = true) && labelField.type == LabelFieldType.TEXT) {
        
            //
            // data extraction from expiry date field and days until expiry date calculation
            //
            
            // Check if scanned expiry date is to close to actual date
            if (daysUntilExpiry < dayLimit) {
            
                // Create and configure the AR element - a TextView with appropriate styling
                // This view will appear as an overlay on the camera feed
                return TextView(context).apply {
                
                    text = "Item expires soon!"
                    setTextColor(Color.WHITE)
                    setBackgroundColor(Color.RED)
                    setPadding(16, 8, 16, 8)
                    
                    // Add an icon to the left of the text for visual guidance
                    // This enhances the AR experience by providing clear visual cues
                    val drawable = ContextCompat.getDrawable(context, R.drawable.ic_warning)
                    drawable?.setBounds(0, 0, drawable.intrinsicWidth, drawable.intrinsicHeight)
                    setCompoundDrawables(drawable, null, null, null)
                    compoundDrawablePadding = 16 // Add some padding between icon and text
                }
            }
        }
        // Return null for any fields that aren't expiry dates, which means no AR overlay
        return null
    }
    
    // This defines where on the detected field the AR view should be anchored
    // BOTTOM_CENTER places it right below the expiry date text for better visibility
    override fun anchorForCapturedLabelField(
        overlay: LabelCaptureAdvancedOverlay,
        labelField: LabelField,
    ): Anchor = Anchor.BOTTOM_CENTER

    // This defines the offset from the anchor point
    override fun offsetForCapturedLabelField(
        overlay: LabelCaptureAdvancedOverlay,
        labelField: LabelField,
        view: View,
    ): PointWithUnit = PointWithUnit(0f, 22f, MeasureUnit.DIP)
}

Validation Flow

How It Works

The Validation Flow provides a guided label scanning experience. An always-present checklist shows users exactly which fields have been captured and which are still missing, making the scanning process transparent and efficient. Scanning is the fastest way to capture all label content — whether all fields are visible at once or spread across different sides of a package.

The fields shown in the checklist are driven by your Label Definition — the configuration that tells Label Capture which fields to recognize and extract. See the Label Definitions guide for details on how to set them up.

The Validation Flow overlay is a UI component built on top of Label Capture. To use it, create a LabelCaptureValidationFlowOverlay and add it to your data capture view.

Single-Step Scan	Multi-Step Scan
All fields are visible together	Fields on different sides of the package

// Create the overlay
val validationFlowOverlay = LabelCaptureValidationFlowOverlay.newInstance(
    requireContext(),
    dataCaptureManager.getLabelCapture(),
    view,
)

// Set the listener to receive validation events
validationFlowOverlay.listener = this

Define a Listener

When the user has verified that all fields are correctly captured and presses the finish button, the Validation Flow triggers a callback with the final results. To receive these results, implement the LabelCaptureValidationFlowOverlayListener interface:

// This is called by the validation flow overlay when a label has been fully captured and validated
override fun onValidationFlowLabelCaptured(fields: List<LabelField>) {

    val barcodeData = fields.find { it.name == "<your-barcode-field-name>" }?.barcode?.data

    val expiryDate = fields.find { it.name == "<your-expiry-date-field-name>" }?.text
}

Required and Optional Fields

The Validation Flow clearly indicates which fields must be captured and which are optional. Required fields are visually highlighted and the flow can only be completed once all of them have been successfully scanned or manually entered. Optional fields are shown but do not block the user from finishing.

Required Field	Optional Field
Must be captured to finish the flow	Does not block finishing

Typing Hints

If neither on-device nor cloud-based scanning can capture a field, the user can always manually enter the value. To make manual input easier and reduce errors, you can configure placeholder text (typing hints) that show the expected format directly in the input field.

The field name in the label definition is used as the reference for setting placeholder text:

val validationFlowOverlaySettings = LabelCaptureValidationFlowSettings.newInstance()
validationFlowOverlaySettings.setPlaceholderTextForLabelDefinition(FIELD_EXPIRY_DATE, "MM/DD/YYYY")
validationFlowOverlay.applySettings(validationFlowOverlaySettings)

Customization

All text in the Validation Flow overlay can be adjusted to match your application's needs. This is useful for localization, adapting terminology, or removing text entirely for a minimal interface.

Buttons

The text on the restart, pause, and finish buttons can be customized or removed entirely.

English (Default)	Custom Language	Company Slang	No Text

val validationFlowOverlaySettings = LabelCaptureValidationFlowSettings.newInstance()
validationFlowOverlaySettings.restartButtonText = "Borrar todo"
validationFlowOverlaySettings.pauseButtonText = "Pausar"
validationFlowOverlaySettings.finishButtonText = "Finalizar"

validationFlowOverlay.applySettings(validationFlowOverlaySettings)

Toasts

Toast messages appear at the top of the camera preview to inform the user about a scanning state change. The standby toast is shown when the camera is auto-paused after no label is detected for a long time. The validation toast shows how many fields have been captured so far after a scan.

Standby	Validation

val validationFlowOverlaySettings = LabelCaptureValidationFlowSettings.newInstance()
validationFlowOverlaySettings.standbyHintText = "No label detected, camera paused"
validationFlowOverlaySettings.validationHintText = "data fields collected" // X/Y (X fields out of total Y) is shown in front of this string

validationFlowOverlay.applySettings(validationFlowOverlaySettings)

Field

The field state texts are shown inside the input field itself during different phases of scanning.

Invalid Input	Scanning Text	Adaptive Scanning Text
Shown when manual input does not match the expected format	Shown while the camera is actively scanning	Shown while cloud-based recognition is processing

val validationFlowOverlaySettings = LabelCaptureValidationFlowSettings.newInstance()
validationFlowOverlaySettings.validationErrorText = "Incorrect format."
validationFlowOverlaySettings.scanningText = "Scan in progress"
validationFlowOverlaySettings.adaptiveScanningText = "Processing"

validationFlowOverlay.applySettings(validationFlowOverlaySettings)

Cloud Fallback

Beta

The Adaptive Recognition API is still in beta and may change in future versions of Scandit Data Capture SDK. To enable it on your subscription, please contact support@scandit.com.

The Adaptive Recognition Engine helps making Smart Label Capture more robust and scalable thanks to its larger, more capable model hosted in the cloud. Whenever Smart Label Capture's on-device model fails to capture data, the SDK will automatically trigger the Adaptive Recognition Engine to capture complex, unforeseen data and process it with high accuracy and reliability — avoiding the need for the user to type data manually.

Enable Adaptive Recognition by setting the mode to .auto on the label definition. This is a single extra line added to your existing label definition configuration:

val settings = labelCaptureSettings {
    label(LABEL_TITLE) {
        customBarcode(FIELD_BARCODE) {
            setSymbologies(
                Symbology.EAN13_UPCA,
                Symbology.GS1_DATABAR_EXPANDED,
                Symbology.CODE128
            )
        }
        expiryDateText(FIELD_EXPIRY_DATE) {
            setLabelDateFormat(
                LabelDateFormat(
                    componentFormat = LabelDateComponentFormat.MDY,
                    acceptPartialDates = false,
                )
            )
        }
        adaptiveRecognition(adaptiveRecognitionMode = AdaptiveRecognitionMode.AUTO)
    }
}

See AdaptiveRecognitionMode for available options.