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.

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 for the IdCapture capture mode that displays viewfinders based on scanned document type on top of a data capture view.

newInstance(idCapture, view)#
static @NonNull IdCaptureOverlay newInstance(@NonNull IdCapture idCapture,
        @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 IdLayoutStyle.ROUNDED.

idLayoutLineStyle#
IdLayoutLineStyle getIdLayoutLineStyle()
void setIdLayoutLineStyle(IdLayoutLineStyle value)

Added in version 6.8.0

The ID layout line style. By default this is IdLayoutLineStyle.LIGHT.

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.

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.

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.