Text Capture Overlay

Defined in library scandit_datacapture_text_ui

TextCaptureOverlay

class TextCaptureOverlay : DataCaptureOverlay

Added in version 6.11.0

Deprecated since version 6.26.0.

Overlay for the TextCapture capture mode that displays the bounding boxes containing each captured text on top of the video preview. The appearance of bounding boxes can be configured or turned off completely through the brush property.

TextCaptureOverlay.withTextCaptureForView(textCapture, view)

TextCaptureOverlay.withTextCaptureForView(
        TextCapture textCapture,
        DataCaptureView? view)

Added in version 6.11.0

Constructs a new text capture overlay for the provided text capture instance. When passing a non-null view instance, the overlay is automatically added to the view.

TextCaptureOverlay.withTextCapture(textCapture)

TextCaptureOverlay.withTextCapture(TextCapture textCapture)

Added in version 6.11.0

Construct a new text capture overlay for the provided text capture instance. For the overlay to be displayed on screen, it must be added to a DataCaptureView.

viewfinder

Viewfinder? viewfinder

Added in version 6.11.0

Set the viewfinder. By default, the viewfinder is null. Set this to an instance of Viewfinder if you want to draw a viewfinder.

brush

Brush brush

Added in version 6.11.0

The brush used for visualizing a captured text in the UI. To turn off drawing of locations, set the brush to use both a transparent fill and stroke color. By default, the brush has a transparent fill color, a “Scandit”-blue stroke color, and a stroke width of 1.

defaultBrush

static Brush get defaultBrush

Added in version 6.11.0

Returns the default brush used by the overlay.

shouldShowScanAreaGuides

bool shouldShowScanAreaGuides

Added in version 6.11.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.

view

DataCaptureView? view

Added in version 6.11.0

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