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

DocumentScannerCameraConfiguration

data class DocumentScannerCameraConfiguration(var cameraModule: CameraModule = CameraModule.BACK, var defaultZoomFactor: Double = 1.0, var autoCropOnManualSnap: Boolean = true, var flashEnabled: Boolean = false, var minFocusDistanceLock: Boolean = false, var touchToFocusEnabled: Boolean = false, var pinchToZoomEnabled: Boolean = true, var cameraPreviewMode: CameraPreviewMode = CameraPreviewMode.FILL_IN, var captureQualityPrioritization: CapturePhotoQualityPrioritization = CapturePhotoQualityPrioritization.BALANCED, var autoSnappingSensitivity: Double = 0.66, var autoSnappingDelay: Int = 200, var autoSnappingEnabled: Boolean = true, var captureWithHardwareButtonsEnabled: Boolean = true, var fpsLimit: Int = 20) : Parcelable

Configuration of the camera behavior.

Constructors

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

constructor(json: JSONObject)

constructor(cameraModule: CameraModule = CameraModule.BACK, defaultZoomFactor: Double = 1.0, autoCropOnManualSnap: Boolean = true, flashEnabled: Boolean = false, minFocusDistanceLock: Boolean = false, touchToFocusEnabled: Boolean = false, pinchToZoomEnabled: Boolean = true, cameraPreviewMode: CameraPreviewMode = CameraPreviewMode.FILL_IN, captureQualityPrioritization: CapturePhotoQualityPrioritization = CapturePhotoQualityPrioritization.BALANCED, autoSnappingSensitivity: Double = 0.66, autoSnappingDelay: Int = 200, autoSnappingEnabled: Boolean = true, captureWithHardwareButtonsEnabled: Boolean = true, fpsLimit: Int = 20)

Types

Companion

object Companion

Properties

autoCropOnManualSnap

var autoCropOnManualSnap: Boolean

Determines whether the document should be cropped automatically after a manual snap or not.

autoSnappingDelay

var autoSnappingDelay: Int

After a page has been snapped, the delay in milliseconds before auto snapping resumes for the next page.

autoSnappingEnabled

var autoSnappingEnabled: Boolean

Determines if auto snapping is enabled or not.

autoSnappingSensitivity

var autoSnappingSensitivity: Double

Controls the auto snapping speed. The sensitivity must be between 0.0 and 1.0. A value of 1.0 triggers auto snapping immediately, while a value of 0.0 delays the auto snapping by 3 seconds. The default value is 0.66 (2 seconds).

cameraModule

var cameraModule: CameraModule

Determines which camera module to use on start-up.

cameraPreviewMode

var cameraPreviewMode: CameraPreviewMode

Determines which camera preview mode to use.

captureQualityPrioritization

var captureQualityPrioritization: CapturePhotoQualityPrioritization

Determines the prioritization of still image quality and capturing speed.

captureWithHardwareButtonsEnabled

var captureWithHardwareButtonsEnabled: Boolean

When enabled the hardware volume up/down buttons can be used to capture an image if manual snapping is enabled. For iOS version 17.2 or later is required. On iPhones with camera control (iPhone 16 series) this also enables zooming and capturing with the camera control.

defaultZoomFactor

var defaultZoomFactor: Double

The default zoom factor on start-up.

flashEnabled

var flashEnabled: Boolean

Determines whether the flashlight is enabled or not on start-up.

fpsLimit

var fpsLimit: Int

The rate of detections/recognitions per second in normal performance mode. If the number is equal or greater than the video frame rate, no frames will be skipped.

minFocusDistanceLock

var minFocusDistanceLock: Boolean

Determines whether locking the focus at the minimum possible distance is enabled or not (device-specific).

pinchToZoomEnabled

var pinchToZoomEnabled: Boolean

Determines whether pinch-to-zoom is enabled or not.

touchToFocusEnabled

var touchToFocusEnabled: Boolean

Determines whether touch-to-focus is enabled or not. Android only.

Functions

clone

fun clone(): DocumentScannerCameraConfiguration

toJson

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