Android Scanbot SDK/io.scanbot.sdk.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) : 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, val alreadyCroppedScore: Double) : Parcelable

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.

DocumentEnhancer

interface DocumentEnhancer

Interface for DocumentEnhancer API. See class documentation for more details.

DocumentEnhancerFactory

class DocumentEnhancerFactory : IDocumentEnhancerFactory

DocumentScanner

interface DocumentScanner

Interface for DocumentScanner API. See class documentation for more details.

DocumentScannerConfiguration

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

Configuration for the document scanner.

DocumentScannerEngineMode

enum DocumentScannerEngineMode : Enum<DocumentScannerEngineMode>

Engines for document scanning.

DocumentScannerFactory

class DocumentScannerFactory(documentScannerEngineMode: DocumentScannerEngineMode? = null) : IDocumentScannerFactory

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, var alreadyCroppedScoreThreshold: Int = 80) : Parcelable

Parameters for the document scanner.

DocumentScanningResult

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

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

DocumentStraighteningMode

enum DocumentStraighteningMode : Enum<DocumentStraighteningMode>

Type of document straightening to apply.

DocumentStraighteningParameters

data class DocumentStraighteningParameters(var straighteningMode: DocumentStraighteningMode = DocumentStraighteningMode.STRAIGHTEN, var aspectRatios: List<AspectRatio> = listOf( )) : Parcelable

Configuration for document straightening.

DocumentStraighteningResult

data class DocumentStraighteningResult(val straightenedImage: ImageRef? = null) : AutoCloseable, Parcelable

Result of the document straightening.

IDocumentEnhancerFactory

interface IDocumentEnhancerFactory

IDocumentScannerFactory

interface IDocumentScannerFactory

PartiallyVisibleDocumentConfiguration

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

Configuration for handling partially visible documents.

ScanbotSdkDocumentEnhancer

class ScanbotSdkDocumentEnhancer : SelfDisposable, DocumentEnhancer

API for document enhancement.

ScanbotSdkDocumentScanner

class ScanbotSdkDocumentScanner : SelfDisposable, DocumentScanner

API for document detection and scanning.