Label Capture Advanced Overlay

Defined in package com.scandit.datacapture.label.ui.overlay

LabelCaptureAdvancedOverlay

class LabelCaptureAdvancedOverlay : FrameLayout, DataCaptureOverlay

Added in version 6.16.0

An overlay for DataCaptureView that allows anchoring a single user-provided View to each captured label.

The provided view is visible on top of the camera preview as long as its captured label is, and during time it retains its relative position to it. This is useful when additional information should be provided to the captured label in real time. For instance, a user may overlay the price of an item or its expiration date for each corresponding label.

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

A user of this class may configure what view is displayed for the given label and the relative position between the two by implementing LabelCaptureAdvancedOverlayListener.

newInstance(mode, view)

static @NonNull LabelCaptureAdvancedOverlay newInstance(
        @NonNull LabelCapture mode,
        @Nullable DataCaptureView view)

Added in version 6.16.0

Constructs a new overlay to visualize the process of label capture. 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().

fromJson(mode, jsonData)

static @NonNull LabelCaptureAdvancedOverlay fromJson(
        @NonNull LabelCapture mode,
        @NonNull String jsonData)

Added in version 6.16.0

Constructs a new label capture advanced overlay with the provided JSON serialization. See Serialization for details.

For the overlay to be displayed on screen, it must be added to a DataCaptureView.

listener

@Nullable LabelCaptureAdvancedOverlayListener getListener()
void setListener(@Nullable LabelCaptureAdvancedOverlayListener value)

Added in version 6.16.0

The listener which is called whenever a view, an anchor point and an offset must be defined for a tracked CapturedLabel.

shouldShowScanAreaGuides

boolean getShouldShowScanAreaGuides()
void setShouldShowScanAreaGuides(boolean value)

Added in version 6.16.0

Whether to show scan area guides on top of the preview. This property is useful during development to visualize the current scan areas on screen. It is not meant to be used for production. By default this property is false.

setViewForCapturedLabel(capturedLabel, view)

void setViewForCapturedLabel(@NonNull CapturedLabel capturedLabel,
        @Nullable View view)

Added in version 6.16.0

The method can be called to change the view drawn for the given tracked label. Setting the view to null will unset the view from the tracked label and will effectively remove it from the overlay. This method is thread-safe, it can be called from any thread. The view set via this method will take precedence over the one set via LabelCaptureAdvancedOverlayListener.viewForCapturedLabel(): in case a view is set before LabelCaptureAdvancedOverlayListener.viewForCapturedLabel() got called, no call to LabelCaptureAdvancedOverlayListener.viewForCapturedLabel() will happen.

setAnchorForCapturedLabel(capturedLabel, anchor)

void setAnchorForCapturedLabel(@NonNull CapturedLabel capturedLabel,
        Anchor anchor)

Added in version 6.16.0

The method can be called to change the anchor point for the view associated with the given tracked label. This method is thread-safe, it can be called from any thread. The anchor set via this method will take precedence over the one set via LabelCaptureAdvancedOverlayListener.anchorForCapturedLabel(): in case a view is set before LabelCaptureAdvancedOverlayListener.anchorForCapturedLabel() got called, no call to LabelCaptureAdvancedOverlayListener.anchorForCapturedLabel() will happen.

setOffsetForCapturedLabel(capturedLabel, offset)

void setOffsetForCapturedLabel(@NonNull CapturedLabel capturedLabel,
        @NonNull PointWithUnit offset)

Added in version 6.16.0

The method can be called to change the offset for the view associated with the given tracked label. This method is thread-safe, it can be called from any thread. The offset set via this method will take precedence over the one set via LabelCaptureAdvancedOverlayListener.offsetForCapturedLabel(): in case a view is set before LabelCaptureAdvancedOverlayListener.offsetForCapturedLabel() got called, no call to LabelCaptureAdvancedOverlayListener.offsetForCapturedLabel() will happen. If the MeasureUnit of the offset is MeasureUnit.FRACTION, the offset is calculated relative to view’s dimensions.

setViewForCapturedLabelField(labelField, capturedLabel, view)

void setViewForCapturedLabelField(@NonNull LabelField labelField,
        @NonNull CapturedLabel capturedLabel,
        @Nullable View view)

Added in version 6.17.0

The method can be called to change the view drawn for the given tracked field of the captured label. Setting the view to null will unset the view from the tracked field of the captured label and will effectively remove it from the overlay. This method is thread-safe, it can be called from any thread. The view set via this method will take precedence over the one set via LabelCaptureAdvancedOverlayListener.viewForCapturedLabelField(): in case a view is set before LabelCaptureAdvancedOverlayListener.viewForCapturedLabelField() got called, no call to LabelCaptureAdvancedOverlayListener.viewForCapturedLabelField() will happen.

setAnchorForCapturedLabelField(labelField, capturedLabel, anchor)

void setAnchorForCapturedLabelField(@NonNull LabelField labelField,
        @NonNull CapturedLabel capturedLabel,
        Anchor anchor)

Added in version 6.17.0

The method can be called to change the anchor point for the view associated with the given tracked field of the captured label. This method is thread-safe, it can be called from any thread. The anchor set via this method will take precedence over the one set via LabelCaptureAdvancedOverlayListener.anchorForCapturedLabelField(): in case a view is set before LabelCaptureAdvancedOverlayListener.anchorForCapturedLabelField() got called, no call to LabelCaptureAdvancedOverlayListener.anchorForCapturedLabelField() will happen.

setOffsetForCapturedLabelField(labelField, capturedLabel, offset)

void setOffsetForCapturedLabelField(@NonNull LabelField labelField,
        @NonNull CapturedLabel capturedLabel,
        @NonNull PointWithUnit offset)

Added in version 6.17.0

The method can be called to change the offset for the view associated with the given tracked field of the captured label. This method is thread-safe, it can be called from any thread. The offset set via this method will take precedence over the one set via LabelCaptureAdvancedOverlayListener.offsetForCapturedLabelField(): in case a view is set before LabelCaptureAdvancedOverlayListener.offsetForCapturedLabelField() got called, no call to LabelCaptureAdvancedOverlayListener.offsetForCapturedLabelField() will happen. If the MeasureUnit of the offset is MeasureUnit.FRACTION, the offset is calculated relative to view’s dimensions.

clearCapturedLabelViews()

void clearCapturedLabelViews()

Added in version 6.16.0

Clears all the views for the currently tracked labels from this overlay. This method is thread-safe, it can be called from any thread.

updateFromJson(jsonData)

void updateFromJson(@NonNull String jsonData)

Added in version 6.16.0

Updates the overlay according to a JSON serialization. See Serialization for details.