Android Scanbot SDK API reference/io.scanbot.sdk.document

Package-level declarations

Types

class DefaultDocumentScanner(initialConfig: DocumentScannerConfiguration) : DocumentScanner

class DocumentAutoSnappingController : BaseDocumentAutoSnappingController, BasePictureCallback

Controls auto-snapping for a document based on it's scanned documents.

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) : Parcelable

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) : Parcelable

The total and partial scores for the detected document contour.

DocumentDetectionStatus

enum DocumentDetectionStatus : Enum<DocumentDetectionStatus>

Status of the document detection.

DocumentScanner

interface DocumentScanner

DocumentScannerConfiguration

data class DocumentScannerConfiguration(var engineMode: DocumentScannerEngineMode = DocumentScannerEngineMode.ML, var parameters: DocumentScannerParameters = DocumentScannerParameters( )) : Parcelable

Configuration for the document scanner.

DocumentScannerEngineMode

enum DocumentScannerEngineMode : Enum<DocumentScannerEngineMode>

Engines for document scanning.

DocumentScannerFrameHandler

class DocumentScannerFrameHandler(context: Context, documentScanner: DocumentScanner) : FrameHandler

Performs document scanning on camera preview frames. Outputs results via DocumentScannerFrameHandler.ResultHandler (.addResultHandler).

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) : Parcelable

Parameters for the document scanner.