ID Capture Overlay

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

IdLayoutStyle

Added in version 6.8.0

The layout style of the IdCaptureOverlay.

ROUNDED

Added in version 6.8.0

Layout style with rounded corners.

SQUARE

Added in version 6.8.0

Layout style with square corners.

TextHintPosition

Added in version 6.22.0

Sets the position of the textual hints.

ABOVE_VIEWFINDER

Added in version 6.22.0

Places the text hint above viewfinder.

BELOW_VIEWFINDER

Added in version 6.22.0

Places the text hint below viewfinder.

IdLayoutLineStyle

Added in version 6.8.0

The style of the lines drawn as part of the IdLayout.

BOLD

Added in version 6.8.0

Draws lines with a width of 5 dips/points.

LIGHT

Added in version 6.8.0

Draws lines with a width of 3 dips/points.

IdCaptureOverlay

class IdCaptureOverlay : DataCaptureOverlay

Added in version 6.6.0

Overlay that guides the user through the IdCapture process.

In order to display this overlay, add it to data capture view.

This overlay shows a viewfinder, automatically selected based on IdCaptureSettings.supportedDocuments and IdCaptureSettings.supportedSides, along with animations and textual hints, that allow the user to capture smoothly and avoid common pitfalls. It is designed to work out-of-the-box for a wide range of use-cases.

You can tweak the look of the viewfinder by setting idLayoutStyle and idLayoutLineStyle. Additionally you can configure the brush used to highlight localized, captured, or rejected documents.

You can translate the texts used by the viewfinder into various languages by adding adding string resources with the following ids to your app:

Resource id	Comment
scandit_id_capture_camera_too_far	Document cannot be captured, because the camera is too far.
scandit_id_capture_document_partially_visible	Document cannot be captured, because it’s only partially visible - either covered or not fully fitting the frame of the camera.
scandit_id_capture_show_document	Ask the user to show a document, front of card capture scenario or multiple document types selected.
scandit_id_capture_show_passport	Ask the user to show the passport.
scandit_id_capture_show_front_of_document	Ask the user to show the front side of a document in the front & back capture scenario.
scandit_id_capture_show_back_of_document	Ask the user to show the back side of a document in the front & back capture scenario.
scandit_id_capture_show_barcode_on_document	Ask the user to show the barcode on a document, either when a barcode type is selected or the back side of a document in the front & back capture scenario contains only a barcode.
scandit_id_capture_show_visa	Ask the user to show the visa.

The default texts can also be replaced with custom messages by calling setFrontSideTextHint() and setBackSideTextHint(). setFrontSideTextHint() replaces texts displayed asking the user for the front side of a document, in the front & back capture scenario, but also when only a single side or a part of a document is being captured. setBackSideTextHint() replaces texts displayed asking the user for the back side of the document in the front & back capture scenario. These methods take precedence over the texts set using string resources.

newInstance(mode, view)

static @NonNull IdCaptureOverlay newInstance(IdCapture mode,
        @Nullable DataCaptureView view)

Added in version 6.6.0

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

idLayout

IdLayout getIdLayout()
void setIdLayout(IdLayout value)

Added in version 6.6.0

The kind of UI displayed to assist a user in scanning specific types of personal identification documents.

idLayoutStyle

IdLayoutStyle getIdLayoutStyle()
void setIdLayoutStyle(IdLayoutStyle value)

Added in version 6.8.0

The ID layout style of the overlay. By default this is defaultIdLayoutStyle().

textHintPosition

TextHintPosition getTextHintPosition()
void setTextHintPosition(TextHintPosition value)

Added in version 6.22.0

The text hint position of the overlay. By default this is TextHintPosition.ABOVE_VIEWFINDER.

showTextHints

boolean getShowTextHints()
void setShowTextHints(boolean value)

Added in version 6.22.0

Indicates whether text hints are shown or not. True by default.

idLayoutLineStyle

IdLayoutLineStyle getIdLayoutLineStyle()
void setIdLayoutLineStyle(IdLayoutLineStyle value)

Added in version 6.8.0

The ID layout line style. By default this is defaultIdLayoutLineStyle().

capturedBrush

@NonNull Brush getCapturedBrush()
void setCapturedBrush(@NonNull Brush value)

Added in version 6.10.0

The brush used to draw rectangular highlights around captured personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). By default it equals DEFAULT_CAPTURED_BRUSH.

To disable highlights use Brush.transparent().

localizedBrush

@NonNull Brush getLocalizedBrush()
void setLocalizedBrush(@NonNull Brush value)

Added in version 6.10.0

The brush used to draw rectangular highlights around localized personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). A document or its part is considered localized when it’s detected in a frame, but its data is not yet extracted. By default it equals DEFAULT_LOCALIZED_BRUSH.

To disable highlights use Brush.transparent().

rejectedBrush

@NonNull Brush getRejectedBrush()
void setRejectedBrush(@NonNull Brush value)

Added in version 6.10.0

The brush used to draw rectangular highlights around personal identification documents or their parts (such as barcodes), which were detected in a frame but rejected. For example, data encoded in a barcode may have an unsupported format. By default it equals DEFAULT_REJECTED_BRUSH.

To disable highlights use Brush.transparent().

DEFAULT_CAPTURED_BRUSH

static final @NonNull Brush DEFAULT_CAPTURED_BRUSH

Added in version 6.10.0

The default brush used to draw rectangular highlights around captured personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). By default, the stroke of a highlight is 3dp white and the fill is transparent.

Deprecated since version 6.10.1: Replaced by defaultCapturedBrush().

defaultCapturedBrush()

static Brush defaultCapturedBrush()

Added in version 6.10.0

The default brush used to draw rectangular highlights around captured personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). By default, the stroke of a highlight is 3dp white and the fill is transparent.

DEFAULT_LOCALIZED_BRUSH

static final @NonNull Brush DEFAULT_LOCALIZED_BRUSH

Added in version 6.10.0

The default brush used to draw rectangular highlights around localized personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). A document or its part is considered localized when it’s detected in a frame, but its data is not yet extracted. By default, the fill of the highlight is white (alpha 50%) and the border is transparent.

Deprecated since version 6.10.1: Replaced by defaultLocalizedBrush().

defaultLocalizedBrush()

static Brush defaultLocalizedBrush()

Added in version 6.10.0

The default brush used to draw rectangular highlights around localized personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). A document or its part is considered localized when it’s detected in a frame, but its data is not yet extracted. By default, the fill of the highlight is white (alpha 50%) and the border is transparent.

DEFAULT_REJECTED_BRUSH

static final @NonNull Brush DEFAULT_REJECTED_BRUSH

Added in version 6.10.0

The default brush used to draw rectangular highlights around personal identification documents or their parts (such as barcodes), which were detected in a frame, but rejected. For example, data encoded in a barcode may have an unsupported format. By default, the fill of the highlight is white (alpha 50%) and the border is transparent.

Deprecated since version 6.10.1: Replaced by defaultLocalizedBrush().

defaultRejectedBrush()

static Brush defaultRejectedBrush()

Added in version 6.10.0

The default brush used to draw rectangular highlights around personal identification documents or their parts (such as barcodes), which were detected in a frame, but rejected. For example, data encoded in a barcode may have an unsupported format. By default, the fill of the highlight is white (alpha 50%) and the border is transparent.

defaultIdLayoutStyle()

static IdLayoutStyle defaultIdLayoutStyle()

Added in version 6.14.0

Returns the default value for the ID layout style of the overlay.

defaultIdLayoutLineStyle()

static IdLayoutLineStyle defaultIdLayoutLineStyle()

Added in version 6.14.0

Returns the default value for the ID layout line style of the overlay.

defaultIdLayout()

static IdLayout defaultIdLayout()

Added in version 6.14.0

Returns the default value for the ID layout of the overlay.

setFrontSideTextHint(text)

void setFrontSideTextHint(@NonNull String text)

Added in version 6.17.0

Sets text for textual hint displayed when scanning the front of document.

setBackSideTextHint(text)

void setBackSideTextHint(@NonNull String text)

Added in version 6.17.0

Sets text for textual hint displayed when scanning the back of document.