dot-document/com.innovatrics.dot.document.autocapture/DocumentAutoCaptureFragment

DocumentAutoCaptureFragment

abstract class DocumentAutoCaptureFragment : CameraPreviewFragment

Document Auto Capture UI component.

A visual component for capturing good quality images suitable for optical character recognition.

Constructors

fun DocumentAutoCaptureFragment()

Types

Companion

object Companion

Configuration

data class Configuration @JvmOverloads constructor(val cameraFacing: CameraFacing = CameraFacing.BACK, val cameraPreviewScaleType: CameraPreviewScaleType = CameraPreviewScaleType.FIT, val torchEnabled: Boolean = false, val validationMode: ValidationMode = ValidationMode.STANDARD, val qualityAttributeThresholds: QualityAttributeThresholds = QualityAttributeThresholdPresets.standard, val isDetectionLayerVisible: Boolean = false, val mrzValidation: MrzValidation = MrzValidation.NONE, val sessionToken: String? = null, val placeholderType: PlaceholderType = PlaceholderType.CORNERS_ONLY)

Configuration for the Document Auto Capture UI component.

Functions

onCandidateSelectionStarted

abstract fun onCandidateSelectionStarted()

Called only once for the whole process, when candidate selection has been started.

onCaptured

abstract fun onCaptured(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.

onProcessed

abstract fun onProcessed(detection: DocumentAutoCaptureDetection)

Called when a camera image is processed.

provideConfiguration

open fun provideConfiguration(): DocumentAutoCaptureFragment.Configuration

Subclasses should override this method to provide Configuration for the Document Auto Capture UI component.

requestCapture

fun requestCapture()

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

start

fun start()

Start the process.

stopAsync

fun stopAsync(onStopped: () -> Unit)

Stop the process asynchronously.