ID Capture Overlay
Defined in library scandit_datacapture_id_ui
- IdLayoutStyle
Added in version 6.11.0
The layout style of the IdCaptureOverlay.
- rounded
Added in version 6.11.0
Layout style with rounded corners.
- square
Added in version 6.11.0
Layout style with square corners.
- TextHintPosition
Added in version 6.22.0
Sets the position of the textual hints.
- aboveViewfinder
Added in version 6.22.0
Places the text hint above viewfinder.
- belowViewfinder
Added in version 6.22.0
Places the text hint below viewfinder.
- IdLayoutLineStyle
Added in version 6.11.0
The style of the lines drawn as part of the IdLayout.
- bold
Added in version 6.11.0
Draws lines with a width of 5 dips/points.
- light
Added in version 6.11.0
Draws lines with a width of 3 dips/points.
- IdCaptureOverlay
class IdCaptureOverlay : DataCaptureOverlay
Added in version 6.11.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_tap_shutter_to_scan
Ask the user to tap the shutter button to let IdCapture start capturing a document
scandit_id_capture_looking_for_document
Tell the user that IdCapture is looking for a document to capture
scandit_id_capture_hold_still
Ask the user to hold still the device so that the document can be captured
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.
- IdCaptureOverlay.withIdCaptureForView(idCapture, view)
IdCaptureOverlay.withIdCaptureForView(IdCapture idCapture, DataCaptureView? view)
Added in version 6.11.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.
- IdCaptureOverlay.withIdCapture(idCapture)
IdCaptureOverlay.withIdCapture(IdCapture idCapture)
Added in version 6.11.0
Constructs a new id capture overlay for the provided id capture instance. For the overlay to be displayed on screen, it must be added to a DataCaptureView.
- setIdLayout(idLayout)
voidsetIdLayout(IdLayout idLayout)Added in version 6.11.0
Sets the kind of UI displayed to assist a user in scanning specific types of personal identification documents.
Deprecated since version 6.17: Layout is computed automatically based on selected ID Document Types
- idLayoutStyle
IdLayoutStyle idLayoutStyle
Added in version 6.11.0
The ID layout style of the overlay. By default this is IdLayoutStyle.rounded.
- textHintPosition
TextHintPosition textHintPosition
Added in version 6.22.0
The text hint position of the overlay. By default this is TextHintPosition.aboveViewfinder.
- showTextHints
bool showTextHints
Added in version 6.22.0
Indicates whether text hints are shown or not. True by default.
- idLayoutLineStyle
IdLayoutLineStyle idLayoutLineStyle
Added in version 6.11.0
The ID layout line style. By default this is IdLayoutLineStyle.light.
- view
DataCaptureView? view
Added in version 6.11.0
The view this data capture overlay is attached to. When the data capture overlay is currently not attached to a view, null is returned.
- capturedBrush
Brush capturedBrush
Added in version 6.11.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 defaultCapturedBrush.
To disable highlights use Brush.transparent().
- localizedBrush
Brush localizedBrush
Added in version 6.11.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 defaultLocalizedBrush.
To disable highlights use Brush.transparent().
- rejectedBrush
Brush rejectedBrush
Added in version 6.11.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 defaultRejectedBrush.
To disable highlights use Brush.transparent().
- defaultCapturedBrush
static Brush get defaultCapturedBrush
Added in version 6.11.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.
- defaultLocalizedBrush
static Brush get defaultLocalizedBrush
Added in version 6.11.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.
- defaultRejectedBrush
static Brush get defaultRejectedBrush
Added in version 6.11.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.