Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.common/CameraConfiguration

CameraConfiguration

data class CameraConfiguration(var cameraModule: CameraModule = CameraModule.BACK, var zoomSteps: List<Double> = listOf( 1.0, 2.0, 5.0 ), var defaultZoomFactor: Double = 1.0, var flashEnabled: Boolean = false, var minFocusDistanceLock: Boolean = false, var touchToFocusEnabled: Boolean = false, var pinchToZoomEnabled: Boolean = true, var orientationLockMode: OrientationLockMode = OrientationLockMode.NONE, var cameraPreviewMode: CameraPreviewMode = CameraPreviewMode.FILL_IN, var fpsLimit: Int = 20) : Parcelable

Configuration of the camera settings to be used while scanning.

Constructors

CameraConfiguration

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

constructor(json: JSONObject)

constructor(cameraModule: CameraModule = CameraModule.BACK, zoomSteps: List<Double> = listOf( 1.0, 2.0, 5.0 ), defaultZoomFactor: Double = 1.0, flashEnabled: Boolean = false, minFocusDistanceLock: Boolean = false, touchToFocusEnabled: Boolean = false, pinchToZoomEnabled: Boolean = true, orientationLockMode: OrientationLockMode = OrientationLockMode.NONE, cameraPreviewMode: CameraPreviewMode = CameraPreviewMode.FILL_IN, fpsLimit: Int = 20)

Types

Companion

object Companion

Properties

cameraModule

var cameraModule: CameraModule

Determines which camera module to use on start-up.

cameraPreviewMode

var cameraPreviewMode: CameraPreviewMode

Determines which camera preview mode to use.

defaultZoomFactor

var defaultZoomFactor: Double

The default zoom factor on start-up.

flashEnabled

var flashEnabled: Boolean

Determines whether the flash is enabled 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 to lock the focus at the minimum possible distance (device-specific).

orientationLockMode

var orientationLockMode: OrientationLockMode

Determines which mode to use when orientation should be locked to landscape or portrait.

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.