Android Scanbot SDK API reference

7.1.0

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

ScanbotComposeCameraViewModel

open class ScanbotComposeCameraViewModel(initialCameraModule: CameraModule = CameraModule.BACK, initialZoomSteps: List<Double> = listOf(1.0, 2.0, 5.0), defaultZoomFactor: Double = 1.0, initialFlashEnabled: Boolean = false, initialMinFocusDistanceLock: Boolean = false, initialTouchToFocusEnabled: Boolean = false, initialPinchToZoomEnabled: Boolean = true, initialPlayFlashOnSnap: Boolean = true, initialOrientationLockMode: OrientationLockMode = OrientationLockMode.NONE, initialCameraPreviewMode: CameraPreviewMode = CameraPreviewMode.FILL_IN, flashAvailable: Boolean, initialFpsLimit: Int, val captureQualityPrioritization: CapturePhotoQualityPrioritization = CapturePhotoQualityPrioritization.BALANCED)

Inheritors

BaseBarcodeViewModel

BaseCheckScannerViewModel

BaseCreditCardViewModel

DocumentCameraViewModel

BaseDocumentDataExtractorViewModel

BaseMrzViewModel

BaseTextPatternViewModel

BaseVinViewModel

Constructors

ScanbotComposeCameraViewModel

constructor(initialCameraModule: CameraModule = CameraModule.BACK, initialZoomSteps: List<Double> = listOf(1.0, 2.0, 5.0), defaultZoomFactor: Double = 1.0, initialFlashEnabled: Boolean = false, initialMinFocusDistanceLock: Boolean = false, initialTouchToFocusEnabled: Boolean = false, initialPinchToZoomEnabled: Boolean = true, initialPlayFlashOnSnap: Boolean = true, initialOrientationLockMode: OrientationLockMode = OrientationLockMode.NONE, initialCameraPreviewMode: CameraPreviewMode = CameraPreviewMode.FILL_IN, flashAvailable: Boolean, initialFpsLimit: Int, captureQualityPrioritization: CapturePhotoQualityPrioritization = CapturePhotoQualityPrioritization.BALANCED)

Types

object Companion

Properties

val cameraHovered: <Error class: unknown class><Boolean>

The camera is on the screen or went to background somehow.

val cameraModule: <Error class: unknown class>

Which camera module should be used

cameraPreviewMode

val cameraPreviewMode: <Error class: unknown class>

The camera preview mode.

captureQualityPrioritization

val captureQualityPrioritization: CapturePhotoQualityPrioritization

flashButtonEnabled

val flashButtonEnabled: <Error class: unknown class>

Whether the flash is enabled.

val flashEnabled: <Error class: unknown class>

Whether the flash is enabled.

val fpsLimit: <Error class: unknown class>

The limit of detected frames per second

minFocusDistanceLock

val minFocusDistanceLock: <Error class: unknown class>

Lock the focus on minimum possible distance (device specific).

orientationLockMode

val orientationLockMode: <Error class: unknown class>

The orientation lock mode.

permissionEnabled

val permissionEnabled: <Error class: unknown class><Boolean>

Updated whe permission status is clarified

pinchToZoomEnabled

val pinchToZoomEnabled: <Error class: unknown class>

Whether the pinch to zoom is enabled.

val previewEnabled: <Error class: unknown class>

The camera should be enabled.

val screenState: <Error class: unknown class><ScreenState>

snapAnimationEnabled

val snapAnimationEnabled: <Error class: unknown class>

Whether the flash animation on take picture is enabled.

supportedZoomRange

var supportedZoomRange: ZoomRange

takePictureAction

val takePictureAction: <Error class: unknown class><TakePictureClickAction>

touchToFocusEnabled

val touchToFocusEnabled: <Error class: unknown class>

Whether the touch to focus is enabled.

userGuidanceShown

var userGuidanceShown: Boolean

val zoomFactorUi: <Error class: unknown class>

Zoom value of the camera for the ui

val zoomRange: <Error class: unknown class>

val zoomState: <Error class: unknown class>

Zoom value of the camera with application rule

Functions

handleScreenLifecycle

fun ScanbotComposeCameraViewModel.handleScreenLifecycle()

fun onAction(action: UiAction)

open fun onPictureTaken(image: ByteArray, data: CaptureInfo)

fun onPinchToZoom(zoom: Float)

open suspend fun toggleSnap()