dot-document/com.innovatrics.dot.document.autocapture.ui/BaseDocumentAutoCaptureFragment

BaseDocumentAutoCaptureFragment

abstract class BaseDocumentAutoCaptureFragment(@LayoutRes contentLayoutId: Int = R.layout.dot_document_fragment_base_document_auto_capture) : CameraPreviewFragment

Base UI Document Auto Capture component.

A visual component for capturing good quality document images suitable for optical character recognition. This component primarily focuses on the camera preview functionality. It is intended to be used as a base for custom UI. If you prefer a ready-to-use UI component, use DocumentAutoCaptureFragment instead.

To implement a custom UI, you need to pass your layout resource using a constructor argument contentLayoutId and include a layout from DOT SDK. Use this snippet in your custom layout XML file:

<include layout="@layout/dot_document_fragment_base_document_auto_capture" />

After including the default layout, you can add your custom UI elements (e.g. instructions, buttons, etc.) to your layout XML file.

Inheritors

DocumentAutoCaptureFragment

Constructors

BaseDocumentAutoCaptureFragment

constructor(@LayoutRes contentLayoutId: Int = R.layout.dot_document_fragment_base_document_auto_capture)

Types

Configuration

data class Configuration(val common: CommonConfiguration = CommonConfiguration(), val camera: CameraConfiguration = CameraConfiguration( facing = CameraFacing.BACK, ), val autoCapture: AutoCaptureConfiguration = AutoCaptureConfiguration( minValidSamplesInRowToStartCandidateSelection = DocumentAutoCaptureController.Configuration.DEFAULT_MIN_VALID_SAMPLES_IN_ROW_TO_START_CANDIDATE_SELECTION, candidateSelectionDurationMillis = DocumentAutoCaptureController.Configuration.DEFAULT_CANDIDATE_SELECTION_DURATION_MILLIS, ), val qualityAttributeThresholds: QualityAttributeThresholds = QualityAttributeThresholds.Presets.standard, val validationMode: ValidationMode = ValidationMode.STANDARD, val mrzValidation: MrzValidation = MrzValidation.NONE, val barcodeValidation: BarcodeValidation = BarcodeValidation.NONE)

Configuration for the UI Document Auto Capture component.

Functions

onFinished

open fun onFinished(result: DocumentAutoCaptureResult)

Called only once for the whole process, when the final document image candidate has been chosen. Once this callback is called, the whole process is considered to be over.

onUiStateUpdated

open fun onUiStateUpdated(uiState: UiState)

Called when the UI state is updated. Subclasses can override this method to update custom UI elements.

provideBaseConfiguration

abstract fun provideBaseConfiguration(): BaseDocumentAutoCaptureFragment.Configuration

Provides the Configuration for the component.

requestCapture

fun requestCapture()

Request capture event asynchronously (regardless of whether there is a document detected or not).

start

fun start()

Start the process.

stop

fun stop()

Stop the process.