All Implemented Interfaces:


public class ScanbotComposeCameraViewModel

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`ScanbotComposeCameraViewModel.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final <Error class: unknown class><TakePictureClickAction>`	`takePictureAction`
`private final <Error class: unknown class><Boolean>`	`permissionEnabled`
`private final <Error class: unknown class>`	`zoomState`
`private Boolean`	`userGuidanceShown`
`private final <Error class: unknown class>`	`zoomRange`
`private ZoomRange`	`supportedZoomRange`
`private final <Error class: unknown class>`	`zoomFactorUi`
`private final <Error class: unknown class>`	`flashEnabled`
`private final <Error class: unknown class>`	`snapAnimationEnabled`
`private final <Error class: unknown class>`	`flashButtonEnabled`
`private final <Error class: unknown class>`	`cameraModule`
`private final <Error class: unknown class>`	`minFocusDistanceLock`
`private final <Error class: unknown class>`	`touchToFocusEnabled`
`private final <Error class: unknown class>`	`pinchToZoomEnabled`
`private final <Error class: unknown class>`	`orientationLockMode`
`private final <Error class: unknown class>`	`cameraPreviewMode`
`private final <Error class: unknown class><Boolean>`	`cameraHovered`
`private final <Error class: unknown class><ScreenState>`	`screenState`
`private final <Error class: unknown class>`	`previewEnabled`
`private FrameHandler.Frame`	`currentFrameSize`
`private final <Error class: unknown class><FrameHandler.Frame>`	`frameSizeFlow`
`private final FrameHandler`	`screenSizeFrameHandler`
`private final CapturePhotoQualityPrioritization`	`captureQualityPrioritization`
`public final static ScanbotComposeCameraViewModel.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`ScanbotComposeCameraViewModel(CameraModule initialCameraModule, List<Double> initialZoomSteps, Double defaultZoomFactor, Boolean initialFlashEnabled, Boolean initialMinFocusDistanceLock, Boolean initialTouchToFocusEnabled, Boolean initialPinchToZoomEnabled, Boolean initialPlayFlashOnSnap, OrientationLockMode initialOrientationLockMode, CameraPreviewMode initialCameraPreviewMode, Boolean flashAvailable, CapturePhotoQualityPrioritization captureQualityPrioritization)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final <Error class: unknown class><TakePictureClickAction>`	`getTakePictureAction()`
`final <Error class: unknown class><Boolean>`	`getPermissionEnabled()`	Updated whe permission status is clarified
`final <Error class: unknown class>`	`getZoomState()`	Zoom value of the camera with application rule
`final Boolean`	`getUserGuidanceShown()`
`final Unit`	`setUserGuidanceShown(Boolean userGuidanceShown)`
`final <Error class: unknown class>`	`getZoomRange()`
`final ZoomRange`	`getSupportedZoomRange()`
`final Unit`	`setSupportedZoomRange(ZoomRange supportedZoomRange)`
`final <Error class: unknown class>`	`getZoomFactorUi()`	Zoom value of the camera for the ui
`final <Error class: unknown class>`	`getFlashEnabled()`	Whether the flash is enabled.
`final <Error class: unknown class>`	`getSnapAnimationEnabled()`	Whether the flash animation on take picture is enabled.
`final <Error class: unknown class>`	`getFlashButtonEnabled()`	Whether the flash is enabled.
`final <Error class: unknown class>`	`getCameraModule()`	Which camera module should be used
`final <Error class: unknown class>`	`getMinFocusDistanceLock()`	Lock the focus on minimum possible distance (device specific).
`final <Error class: unknown class>`	`getTouchToFocusEnabled()`	Whether the touch to focus is enabled.
`final <Error class: unknown class>`	`getPinchToZoomEnabled()`	Whether the pinch to zoom is enabled.
`final <Error class: unknown class>`	`getOrientationLockMode()`	The orientation lock mode.
`final <Error class: unknown class>`	`getCameraPreviewMode()`	The camera preview mode.
`final <Error class: unknown class><Boolean>`	`getCameraHovered()`	The camera is on the screen or went to background somehow.
`final <Error class: unknown class><ScreenState>`	`getScreenState()`
`final <Error class: unknown class>`	`getPreviewEnabled()`	The camera should be enabled.
`final FrameHandler.Frame`	`getCurrentFrameSize()`
`final Unit`	`setCurrentFrameSize(FrameHandler.Frame currentFrameSize)`
`final <Error class: unknown class><FrameHandler.Frame>`	`getFrameSizeFlow()`
`final FrameHandler`	`getScreenSizeFrameHandler()`
`final CapturePhotoQualityPrioritization`	`getCaptureQualityPrioritization()`
`final Unit`	`onPinchToZoom(Float zoom)`
`Unit`	`toggleSnap()`
`final Unit`	`onAction(UiAction action)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScanbotComposeCameraViewModel

ScanbotComposeCameraViewModel(CameraModule initialCameraModule, List<Double> initialZoomSteps, Double defaultZoomFactor, Boolean initialFlashEnabled, Boolean initialMinFocusDistanceLock, Boolean initialTouchToFocusEnabled, Boolean initialPinchToZoomEnabled, Boolean initialPlayFlashOnSnap, OrientationLockMode initialOrientationLockMode, CameraPreviewMode initialCameraPreviewMode, Boolean flashAvailable, CapturePhotoQualityPrioritization captureQualityPrioritization)

Method Detail

getTakePictureAction

 final <Error class: unknown class><TakePictureClickAction> getTakePictureAction()

getPermissionEnabled

 final <Error class: unknown class><Boolean> getPermissionEnabled()

Updated whe permission status is clarified

getZoomState
```
 final <Error class: unknown class> getZoomState()
```
Zoom value of the camera with application rule

getUserGuidanceShown
```
 final Boolean getUserGuidanceShown()
```

setUserGuidanceShown

 final Unit setUserGuidanceShown(Boolean userGuidanceShown)

getZoomRange

 final <Error class: unknown class> getZoomRange()

getSupportedZoomRange

 final ZoomRange getSupportedZoomRange()

setSupportedZoomRange

 final Unit setSupportedZoomRange(ZoomRange supportedZoomRange)

getZoomFactorUi

 final <Error class: unknown class> getZoomFactorUi()

Zoom value of the camera for the ui

getFlashEnabled

 final <Error class: unknown class> getFlashEnabled()

Whether the flash is enabled.

getSnapAnimationEnabled
```
 final <Error class: unknown class> getSnapAnimationEnabled()
```
Whether the flash animation on take picture is enabled.

getFlashButtonEnabled

 final <Error class: unknown class> getFlashButtonEnabled()

Whether the flash is enabled.

getCameraModule

 final <Error class: unknown class> getCameraModule()

Which camera module should be used

getMinFocusDistanceLock
```
 final <Error class: unknown class> getMinFocusDistanceLock()
```
Lock the focus on minimum possible distance (device specific).

getTouchToFocusEnabled

 final <Error class: unknown class> getTouchToFocusEnabled()

Whether the touch to focus is enabled.

getPinchToZoomEnabled

 final <Error class: unknown class> getPinchToZoomEnabled()

Whether the pinch to zoom is enabled.

getOrientationLockMode

 final <Error class: unknown class> getOrientationLockMode()

The orientation lock mode.

getCameraPreviewMode

 final <Error class: unknown class> getCameraPreviewMode()

The camera preview mode.

getCameraHovered
```
 final <Error class: unknown class><Boolean> getCameraHovered()
```
The camera is on the screen or went to background somehow.

getScreenState

 final <Error class: unknown class><ScreenState> getScreenState()

getPreviewEnabled

 final <Error class: unknown class> getPreviewEnabled()

The camera should be enabled.

getCurrentFrameSize

 final FrameHandler.Frame getCurrentFrameSize()

setCurrentFrameSize

 final Unit setCurrentFrameSize(FrameHandler.Frame currentFrameSize)

getFrameSizeFlow

 final <Error class: unknown class><FrameHandler.Frame> getFrameSizeFlow()

getScreenSizeFrameHandler

 final FrameHandler getScreenSizeFrameHandler()

getCaptureQualityPrioritization

 final CapturePhotoQualityPrioritization getCaptureQualityPrioritization()

onPinchToZoom
```
 final Unit onPinchToZoom(Float zoom)
```

toggleSnap
```
 Unit toggleSnap()
```

onAction
```
 final Unit onAction(UiAction action)
```

Class ScanbotComposeCameraViewModel