kmp-bundle-sdk/io.scanbot.sdk.kmp.documentscanner

Package-level declarations

Types

data class DocumentDetectionResult(val status: DocumentDetectionStatus = DocumentDetectionStatus.NOT_ACQUIRED, val detectionScores: DocumentDetectionScores, val points: List<Point>, val horizontalLines: List<LineSegmentInt>, val verticalLines: List<LineSegmentInt>, val pointsNormalized: List<PointF>, val horizontalLinesNormalized: List<LineSegmentFloat>, val verticalLinesNormalized: List<LineSegmentFloat>, val aspectRatio: Double, val averageBrightness: Int = 0, val displacement: DocumentDisplacement = DocumentDisplacement.NONE, val displacementVector: PointF)

Result of the document contour detection.

DocumentDetectionScores

data class DocumentDetectionScores(val totalScore: Double, val distanceScore: Double, val angleScore: Double, val sizeScore: Double, val aspectRatioScore: Double, val lineCoverageScore: Double, val widthScore: Double, val heightScore: Double)

The total and partial scores for the detected document contour.

DocumentDetectionStatus

enum DocumentDetectionStatus : Enum<DocumentDetectionStatus>

Status of the document detection.

DocumentDisplacement

enum DocumentDisplacement : Enum<DocumentDisplacement>

The direction towards the center of the document if the document is partially visible.

DocumentScannerConfiguration

data class DocumentScannerConfiguration(var engineMode: DocumentScannerEngineMode = DocumentScannerEngineMode.ML, var processingMode: ProcessingMode = ProcessingMode.AUTO, var parameters: DocumentScannerParameters = DocumentScannerParameters( ), var partiallyVisibleDocumentConfiguration: PartiallyVisibleDocumentConfiguration = PartiallyVisibleDocumentConfiguration( ))

Configuration for the document scanner.

DocumentScannerEngineMode

enum DocumentScannerEngineMode : Enum<DocumentScannerEngineMode>

Engines for document scanning.

DocumentScannerParameters

data class DocumentScannerParameters(var acceptedAngleScore: Int = 75, var acceptedSizeScore: Int = 80, var acceptedBrightnessThreshold: Int = 0, var acceptedAspectRatioScore: Int = 85, var aspectRatios: List<AspectRatio> = listOf( ), var ignoreOrientationMismatch: Boolean = false)

Parameters for the document scanner.

DocumentScanningResult

data class DocumentScanningResult(val detectionResult: DocumentDetectionResult, val croppedImage: ImageRef? = null) : AutoCloseable

Result of the document detection followed by cropping of the found document.

PartiallyVisibleDocumentConfiguration

data class PartiallyVisibleDocumentConfiguration(var allowPartiallyVisibleDocuments: Boolean = false, var accumulationDuration: Int = 700, var retentionTime: Int = 1500, var minimumBrightness: Int = 0)

Configuration for handling partially visible documents.