Constructor Detail

• DocumentScannerCameraViewModel

  DocumentScannerCameraViewModel(ContourDetector scanner, SaveTakenPictureUseCase saveTakenPictureUseCase, FilterDraftDocumentPageUseCase filterDraftDocumentPageUseCase, RemoveDraftPageUseCase removeDraftPageUseCase, FinalizePagesUseCase finalizePagesUseCase, IDispatchersProvider dispatchersProvider)

Method Detail

• getHardwareButtonKeyCode

   Integer getHardwareButtonKeyCode()

• setHardwareButtonKeyCode

   Unit setHardwareButtonKeyCode(Integer hardwareButtonKeyCode)

• getCameraOpened

   <Error class: unknown class><Boolean> getCameraOpened()

• getStopNewFrames

   <Error class: unknown class><Boolean> getStopNewFrames()

• getFlash

   <Error class: unknown class><Boolean> getFlash()

• getSnappedPages

   <Error class: unknown class><List<Page>> getSnappedPages()

• getAutoSnapping

   <Error class: unknown class><Boolean> getAutoSnapping()

• getDetectionStatus

   <Error class: unknown class><DocumentDetectionStatus> getDetectionStatus()

• getForceUserGuidance

   <Error class: unknown class><Boolean> getForceUserGuidance()

• getRequiredAspectRatio

   <Error class: unknown class><List<AspectRatio>> getRequiredAspectRatio()

• getShutterSoundEnabled

   <Error class: unknown class><Boolean> getShutterSoundEnabled()

• getPictureProcessing

   <Error class: unknown class><Boolean> getPictureProcessing()

• getMultiPage

   <Error class: unknown class><Boolean> getMultiPage()

• getIgnoreBadAspectRatio

   <Error class: unknown class><Boolean> getIgnoreBadAspectRatio()

• getShutterButtonHidden

   Boolean getShutterButtonHidden()

• setShutterButtonHidden

   Unit setShutterButtonHidden(Boolean shutterButtonHidden)

• getSnappedPagesCount

   <Error class: unknown class><Integer> getSnappedPagesCount()

• getParametricFilter

   <Error class: unknown class><ParametricFilter> getParametricFilter()

• getAutosnapSensitivity

   <Error class: unknown class><Float> getAutosnapSensitivity()

• getSnapEvent

   <Error class: unknown class><Unit> getSnapEvent()

• getScanner

   ContourDetector getScanner()

• pause

   final Unit pause()

• onCameraOpened

   Unit onCameraOpened()

  Camera has been opened.

• onCancelClicked

   Unit onCancelClicked()

  User wants to cancel snapping.

• onLicenseInvalid

   Unit onLicenseInvalid()

  License is now invalid.

• onAutoSnappingClicked

   Unit onAutoSnappingClicked()

  User wants to change auto snapping mode.

• onMultiPageClicked

   Unit onMultiPageClicked()

  User wants to change multi page mode.

• onFlashClicked

   Unit onFlashClicked()

  User wants to change flash mode.

• onSavePagesClicked

   Unit onSavePagesClicked()

  User wants to snapped pages.

• onFinishCurrentState

   Unit onFinishCurrentState()

  Triggered when the signal to finish was received from outside.

• pageSnapped

   Unit pageSnapped(ByteArray image, CaptureInfo captureInfo)

  User have snapped an image.

  Parameters:

  image - snapped image

  captureInfo - additional information about the picture

• setAutoSnappingEnabled

   final Unit setAutoSnappingEnabled(Boolean autoSnappingEnabled)

  Enables/Disables autosnapping

• setForceUserGuidance

   final Unit setForceUserGuidance(Boolean forceUserGuidance)

  Enables/Disables forceUserGuidance

• setParametricFilter

   final Unit setParametricFilter(ParametricFilter parametricFilter)

  Enables pages filtration for given ParametricFilter

• setFlashEnabled

   final Unit setFlashEnabled(Boolean flashEnabled)

  Enables/Disables flash

• setShutterSoundEnabled

   final Unit setShutterSoundEnabled(Boolean shutterSoundEnabled)

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

  Parameters:

  shutterSoundEnabled - if shutter sound should be enabled

• setMultiPageEnabled

   final Unit setMultiPageEnabled(Boolean multiPageEnabled)

  Enables/Disables multipage

• setMaxNumberOfPages

   final Unit setMaxNumberOfPages(Integer maxNumberOfPages)

  Set max number of scanned pages

• setImageScale

   final Unit setImageScale(Float imageScale)

  Sets imageScale

• setDocumentImageSizeLimit

   final Unit setDocumentImageSizeLimit(PageStorageProcessor.Configuration.Size documentImageSizeLimit)

  Sets documentImageSizeLimit

• setAcceptedAngleScore

   final Unit setAcceptedAngleScore(Double acceptedAngleScore)

  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.

  Warning: Lower values result in more blurred document images.

• setAcceptedSizeScore

   final Unit setAcceptedSizeScore(Double acceptedSizeScore)

  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.

  Warning: Lower values result in low resolution document images.

• setAcceptedBrightnessThreshold

   final Unit setAcceptedBrightnessThreshold(Double acceptedBrightnessThreshold)

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

• setRequiredAspectRatio

   final Unit setRequiredAspectRatio(List<AspectRatio> requiredPageAspectRatios)

  Set required PageAspectRatio.

• setAutosnappingSensitivity

   final Unit setAutosnappingSensitivity(Float sensitivity)

• onKeyEvent

   final Boolean onKeyEvent(Integer keyCode)

• setIgnoreBadAspectRatio

   Unit setIgnoreBadAspectRatio(Boolean ignoreBadAspectRatio)

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

• updateDetectionStatus

   Unit updateDetectionStatus(DocumentDetectionStatus status)

  Update status of polygon detection from contour detector.