Android Scanbot SDK API reference

7.1.0

Android Scanbot SDK API reference/io.scanbot.sdk.ui.view.camera/DocumentScannerCameraViewModel

DocumentScannerCameraViewModel

class DocumentScannerCameraViewModel(val scanner: DocumentScanner, saveTakenPictureUseCase: SaveTakenPictureUseCase, filterDraftDocumentPageUseCase: FilterDraftDocumentPageUseCase, removeDraftPageUseCase: RemoveDraftPageUseCase, finalizePagesUseCase: FinalizePagesUseCase, dispatchersProvider: IDispatchersProvider) : ICameraView.ViewModel, Router

ViewModel for DocumentScannerCameraView.

Constructors

DocumentScannerCameraViewModel

constructor(scanner: DocumentScanner, saveTakenPictureUseCase: SaveTakenPictureUseCase, filterDraftDocumentPageUseCase: FilterDraftDocumentPageUseCase, removeDraftPageUseCase: RemoveDraftPageUseCase, finalizePagesUseCase: FinalizePagesUseCase, dispatchersProvider: IDispatchersProvider)

Types

object Companion

Properties

open override val autoSnapping: <Error class: unknown class><Boolean>

autosnapSensitivity

open override val autosnapSensitivity: <Error class: unknown class><Float?>

open override val cameraOpened: <Error class: unknown class><Boolean>

detectionStatus

open override val detectionStatus: <Error class: unknown class><DocumentDetectionStatus?>

open override val flash: <Error class: unknown class><Boolean>

forceUserGuidance

open override val forceUserGuidance: <Error class: unknown class><Boolean>

hardwareButtonKeyCode

open override var hardwareButtonKeyCode: Int?

ignoreOrientationMistmatch

open override val ignoreOrientationMistmatch: <Error class: unknown class><Boolean>

open override val multiPage: <Error class: unknown class><Boolean>

parametricFilter

open override val parametricFilter: <Error class: unknown class><ParametricFilter?>

pictureProcessing

open override val pictureProcessing: <Error class: unknown class><Boolean>

requiredAspectRatio

open override val requiredAspectRatio: <Error class: unknown class><List<AspectRatio>>

open override val scanner: DocumentScanner

shutterButtonHidden

open override var shutterButtonHidden: Boolean

shutterSoundEnabled

open override val shutterSoundEnabled: <Error class: unknown class><Boolean>

open override val snapEvent: <Error class: unknown class><Unit>

open override val snappedPages: <Error class: unknown class><List<Page>>

snappedPagesCount

open override val snappedPagesCount: <Error class: unknown class><Int>

open override val stopNewFrames: <Error class: unknown class><Boolean>

Functions

onAutoSnappingClicked

open override fun onAutoSnappingClicked()

User wants to change auto snapping mode.

open override fun onCameraOpened()

Camera has been opened.

onCancelClicked

open override fun onCancelClicked()

User wants to cancel snapping.

onFinishCurrentState

open override fun onFinishCurrentState()

Triggered when the signal to finish was received from outside.

open override fun onFlashClicked()

User wants to change flash mode.

fun onKeyEvent(keyCode: Int): Boolean

onLicenseInvalid

open override fun onLicenseInvalid()

License is now invalid.

onMultiPageClicked

open override fun onMultiPageClicked()

User wants to change multi page mode.

onSavePagesClicked

open override fun onSavePagesClicked()

User wants to snapped pages.

open override fun pageSnapped(image: ByteArray, captureInfo: CaptureInfo)

User have snapped an image.

fun pause()

setAcceptedAngleScore

fun setAcceptedAngleScore(acceptedAngleScore: Double)

The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0. Set lower values to accept more perspective distortion.

setAcceptedBrightnessThreshold

fun setAcceptedBrightnessThreshold(acceptedBrightnessThreshold: Double)

The brightness threshold to accept a detected document in the range of 0 (very dark) to 255 (very bright). Default is 50.

setAcceptedSizeScore

fun setAcceptedSizeScore(acceptedSizeScore: Double)

The minimum size in percent (0 - 100) of the screen size to accept a detected document. It is sufficient that height or width match the score. Default is 80.0.

setAutoSnappingEnabled

fun setAutoSnappingEnabled(autoSnappingEnabled: Boolean)

Enables/Disables autosnapping

setAutosnappingSensitivity

fun setAutosnappingSensitivity(sensitivity: Float)

setDocumentImageSizeLimit

fun setDocumentImageSizeLimit(documentImageSizeLimit: PageStorageProcessor.Configuration.Size)

Sets documentImageSizeLimit

setFlashEnabled

fun setFlashEnabled(flashEnabled: Boolean)

Enables/Disables flash

setForceUserGuidance

fun setForceUserGuidance(forceUserGuidance: Boolean)

Enables/Disables forceUserGuidance

setIgnoreOrientationMistmatch

open override fun setIgnoreOrientationMistmatch(ignoreOrientationMistmatch: Boolean)

Sets flag which enables/disables ignoreOrientationMismatch detection ignoring. Default value is false.

fun setImageScale(imageScale: Float)

Sets imageScale

setMaxNumberOfPages

fun setMaxNumberOfPages(maxNumberOfPages: Int)

Set max number of scanned pages

setMultiPageEnabled

fun setMultiPageEnabled(multiPageEnabled: Boolean)

Enables/Disables multipage

setParametricFilter

fun setParametricFilter(parametricFilter: ParametricFilter)

Enables pages filtration for given ParametricFilter

setRequiredAspectRatio

fun setRequiredAspectRatio(requiredAspectRatios: List<AspectRatio>)

Set required AspectRatio.

setShutterSoundEnabled

fun setShutterSoundEnabled(shutterSoundEnabled: Boolean)

Set camera shutter sound state. {@code true} if a sound should be played when taking a picture, {@code false} - otherwise

updateScanningStatus

open override fun updateScanningStatus(status: DocumentDetectionStatus)

Update status of polygon detection from document scanner.