Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.document.configuration/UserGuidanceStates

UserGuidanceStates

data class UserGuidanceStates(var noDocumentFound: String = "?cameraUserGuidanceNoDocumentFound", var badAspectRatio: String = "?cameraUserGuidanceBadAspectRatio", var badAngles: String = "?cameraUserGuidanceBadAngles", var orientationMismatch: String = "?cameraUserGuidanceOrientationMismatch", var textHintOffCenter: String = "?cameraUserGuidanceTextHintOffCenter", var tooSmall: String = "?cameraUserGuidanceTooSmall", var tooNoisy: String = "?cameraUserGuidanceTooNoisy", var tooDark: String = "?cameraUserGuidanceTooDark", var energySaveMode: String = "?cameraUserGuidanceEnergySaveMode", var readyToCapture: String = "?cameraUserGuidanceReadyToCapture", var capturing: String = "?cameraUserGuidanceReadyToCapture", var captureManual: String = "?cameraUserGuidanceReadyToCaptureManual") : Parcelable

Configure the titles of the user guidance hints for different states.

Constructors

UserGuidanceStates

constructor(source: Map<String, Any?>)

constructor(json: JSONObject)

constructor(noDocumentFound: String = "?cameraUserGuidanceNoDocumentFound", badAspectRatio: String = "?cameraUserGuidanceBadAspectRatio", badAngles: String = "?cameraUserGuidanceBadAngles", orientationMismatch: String = "?cameraUserGuidanceOrientationMismatch", textHintOffCenter: String = "?cameraUserGuidanceTextHintOffCenter", tooSmall: String = "?cameraUserGuidanceTooSmall", tooNoisy: String = "?cameraUserGuidanceTooNoisy", tooDark: String = "?cameraUserGuidanceTooDark", energySaveMode: String = "?cameraUserGuidanceEnergySaveMode", readyToCapture: String = "?cameraUserGuidanceReadyToCapture", capturing: String = "?cameraUserGuidanceReadyToCapture", captureManual: String = "?cameraUserGuidanceReadyToCaptureManual")

Types

Companion

object Companion

Properties

badAngles

var badAngles: String

The user guidance text displayed when the document pitch/skew angle is unacceptable.

badAspectRatio

var badAspectRatio: String

The user guidance text displayed a detected documents aspect ratio is not within the acceptable range.

captureManual

var captureManual: String

The user guidance text displayed when the document is ready to be captured in 'manual snapping' mode.

capturing

var capturing: String

The user guidance text displayed when the document is being captured and user needs to hold the device still.

energySaveMode

var energySaveMode: String

The user guidance text displayed when the device is in energy saving mode. iOS only.

noDocumentFound

var noDocumentFound: String

The user guidance text displayed when no document is found.

orientationMismatch

var orientationMismatch: String

The user guidance text displayed when a landscape document is detected when the camera is in portrait mode (and vice versa).

readyToCapture

var readyToCapture: String

The user guidance text displayed when the document is ready to be captured in 'auto snapping' mode.

textHintOffCenter

var textHintOffCenter: String

The user guidance text displayed when the document is not centered in the finder view.

tooDark

var tooDark: String

The user guidance text displayed when it is too dark to capture an adequate image.

tooNoisy

var tooNoisy: String

The user guidance text displayed when the background is too noisy.

tooSmall

var tooSmall: String

The user guidance text displayed when the document is too far from camera.

Functions

clone

fun clone(): UserGuidanceStates

toJson

fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject