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

DetectedFrame

Document scanning results alongside with information about frame

Constructors

constructor(detectionStatus: DocumentDetectionStatus, polygon: List<PointF>?, frameOrientation: Int, frameWidth: Int, frameHeight: Int)

constructor(detectionStatus: DocumentDetectionStatus, polygon: List<PointF>?, frameOrientation: Int, frameWidth: Int, frameHeight: Int, detectionScores: DocumentDetectionScores?, finderRect: Rect?)

Properties

detectionScores

@JvmField

val detectionScores: DocumentDetectionScores?

Scores of detected frame as double values in [0.0, 100.0].

detectionStatus

@JvmField

val detectionStatus: DocumentDetectionStatus

Document scanning result status. Typically used to decide whether document scanning was successful or not and what can be improved from user side.

finderRect

@JvmField

val finderRect: Rect?

frameHeight

@JvmField

val frameHeight: Int

Height of the frame before rotation

frameOrientation

@JvmField

val frameOrientation: Int

Rotation of the frame in degrees relatively to what is seen on the screen. Frames might come in different orientation from the camera, that's why this value is needed. You might use it to compensate rotation of .polygon.

frameWidth

@JvmField

val frameWidth: Int

Width of the frame before rotation

polygon

@JvmField

val polygon: List<PointF>

Detected polygon. If no polygon was detected - empty list. Points of polygon are normalized values between 0 and 1 relatively to the size of the frame.