All Implemented Interfaces:: android.os.Parcelable


public final class FinderDocumentScannerJsonConfiguration
 implements Parcelable

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`version`
`private String`	`screen`
`private Double`	`acceptedAngleScore`
`private Double`	`acceptedSizeScore`
`private Double`	`acceptedBrightnessThreshold`
`private Boolean`	`autoSnappingEnabled`
`private Double`	`autoSnappingSensitivity`
`private JsonCameraModule`	`cameraModule`
`private JsonColor`	`cameraBackgroundColor`
`private JsonCameraPreviewMode`	`cameraPreviewMode`
`private Boolean`	`touchToFocusEnabled`
`private String`	`cancelButtonTitle`
`private JsonImageFilterType`	`defaultPageFilter`
`private String`	`enableCameraButtonTitle`
`private String`	`enableCameraExplanationText`
`private Boolean`	`flashButtonHidden`
`private Boolean`	`flashEnabled`
`private Boolean`	`forceUserGuidance`
`private Boolean`	`finderEnabled`
`private JsonColor`	`finderLineColor`
`private Double`	`finderLineWidth`
`private JsonColor`	`cameraOverlayColor`
`private JsonAspectRatio`	`finderAspectRatio`
`private Boolean`	`ignoreBadAspectRatio`
`private Double`	`imageScale`
`private JsonOrientationLockMode`	`orientationLockMode`
`private JsonCapturePhotoQualityPrioritization`	`photoQualityPrioritization`
`private Boolean`	`polygonEnabled`
`private JsonColor`	`polygonBackgroundColor`
`private JsonColor`	`polygonBackgroundColorOK`
`private JsonColor`	`polygonColor`
`private JsonColor`	`polygonColorOK`
`private Double`	`polygonLineWidth`
`private Double`	`polygonCornerRadius`
`private JsonColor`	`autoSnapProgressColor`
`private Double`	`autoSnapProgressLineWidth`
`private Boolean`	`autoSnapProgressEnabled`
`private Boolean`	`lockDocumentAspectRatioToFinder`
`private JsonColor`	`shutterButtonAutoInnerColor`
`private JsonColor`	`shutterButtonAutoOuterColor`
`private JsonColor`	`shutterButtonManualInnerColor`
`private JsonColor`	`shutterButtonManualOuterColor`
`private String`	`textHintBadAngles`
`private String`	`textHintBadAspectRatio`
`private String`	`textHintNothingDetected`
`private String`	`textHintOffCenter`
`private String`	`textHintOK`
`private String`	`textHintTooDark`
`private String`	`textHintTooNoisy`
`private String`	`textHintTooSmall`
`private JsonColor`	`topBarBackgroundColor`
`private JsonColor`	`topBarButtonsActiveColor`
`private JsonColor`	`topBarButtonsInactiveColor`
`private JsonColor`	`userGuidanceBackgroundColor`
`private JsonColor`	`userGuidanceTextColor`
`private Double`	`userGuidanceFontSize`
`private JsonSize`	`documentImageSizeLimit`
`private Boolean`	`shutterButtonHidden`
`private Boolean`	`useButtonsAllCaps`
`private JsonFinderDocumentScannerAccessibilityConfiguration`	`accessibilityConfiguration`

Constructor Summary

Constructors
Constructor	Description
FinderDocumentScannerJsonConfiguration(String version, String screen, Double acceptedAngleScore, Double acceptedSizeScore, Double acceptedBrightnessThreshold, Boolean autoSnappingEnabled, Double autoSnappingSensitivity, JsonCameraModule cameraModule, JsonColor cameraBackgroundColor, JsonCameraPreviewMode cameraPreviewMode, Boolean touchToFocusEnabled, String cancelButtonTitle, JsonImageFilterType defaultPageFilter, String enableCameraButtonTitle, String enableCameraExplanationText, Boolean flashButtonHidden, Boolean flashEnabled, Boolean forceUserGuidance, Boolean finderEnabled, JsonColor finderLineColor, Double finderLineWidth, JsonColor cameraOverlayColor, JsonAspectRatio finderAspectRatio, Boolean ignoreBadAspectRatio, Double imageScale, JsonOrientationLockMode orientationLockMode, JsonCapturePhotoQualityPrioritization photoQualityPrioritization, Boolean polygonEnabled, JsonColor polygonBackgroundColor, JsonColor polygonBackgroundColorOK, JsonColor polygonColor, JsonColor polygonColorOK, Double polygonLineWidth, Double polygonCornerRadius, JsonColor autoSnapProgressColor, Double autoSnapProgressLineWidth, Boolean autoSnapProgressEnabled, Boolean lockDocumentAspectRatioToFinder, JsonColor shutterButtonAutoInnerColor, JsonColor shutterButtonAutoOuterColor, JsonColor shutterButtonManualInnerColor, JsonColor shutterButtonManualOuterColor, String textHintBadAngles, String textHintBadAspectRatio, String textHintNothingDetected, String textHintOffCenter, String textHintOK, String textHintTooDark, String textHintTooNoisy, String textHintTooSmall, JsonColor topBarBackgroundColor, JsonColor topBarButtonsActiveColor, JsonColor topBarButtonsInactiveColor, JsonColor userGuidanceBackgroundColor, JsonColor userGuidanceTextColor, Double userGuidanceFontSize, JsonSize documentImageSizeLimit, Boolean shutterButtonHidden, Boolean useButtonsAllCaps, JsonFinderDocumentScannerAccessibilityConfiguration accessibilityConfiguration)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getVersion()`	Version number of the configuration object.
`final Unit`	`setVersion(String version)`	Version number of the configuration object.
`final String`	`getScreen()`	Screen for which the configuration object should be applied.
`final Unit`	`setScreen(String screen)`	Screen for which the configuration object should be applied.
`final Double`	`getAcceptedAngleScore()`	Minimum score in percent (0 - 100) of the accepted perspective distortion of the detected document.
`final Unit`	`setAcceptedAngleScore(Double acceptedAngleScore)`	Minimum score in percent (0 - 100) of the accepted perspective distortion of the detected document.
`final Double`	`getAcceptedSizeScore()`	Minimum score in percent (0 - 100) of accepted document width or height to screen size ratio of the detected document.
`final Unit`	`setAcceptedSizeScore(Double acceptedSizeScore)`	Minimum score in percent (0 - 100) of accepted document width or height to screen size ratio of the detected document.
`final Double`	`getAcceptedBrightnessThreshold()`	The brightness threshold to accept a detected document in the range of 0 (very dark) to 255 (very bright).
`final Unit`	`setAcceptedBrightnessThreshold(Double acceptedBrightnessThreshold)`	The brightness threshold to accept a detected document in the range of 0 (very dark) to 255 (very bright).
`final Boolean`	`getAutoSnappingEnabled()`	Whether to enable auto-snapping.
`final Unit`	`setAutoSnappingEnabled(Boolean autoSnappingEnabled)`	Whether to enable auto-snapping.
`final Double`	`getAutoSnappingSensitivity()`	Controls the auto-snapping speed.
`final Unit`	`setAutoSnappingSensitivity(Double autoSnappingSensitivity)`	Controls the auto-snapping speed.
`final JsonCameraModule`	`getCameraModule()`	Preferred camera module (Default: BACK).
`final Unit`	`setCameraModule(JsonCameraModule cameraModule)`	Preferred camera module (Default: BACK).
`final JsonColor`	`getCameraBackgroundColor()`	Color of the camera background (relevant only when the camera preview mode is CameraPreviewMode.FIT_IN).
`final Unit`	`setCameraBackgroundColor(JsonColor cameraBackgroundColor)`	Color of the camera background (relevant only when the camera preview mode is CameraPreviewMode.FIT_IN).
`final JsonCameraPreviewMode`	`getCameraPreviewMode()`	Preview mode of the camera.
`final Unit`	`setCameraPreviewMode(JsonCameraPreviewMode cameraPreviewMode)`	Preview mode of the camera.
`final Boolean`	`getTouchToFocusEnabled()`	Whether touch-to-focus is enabled on camera preview.
`final Unit`	`setTouchToFocusEnabled(Boolean touchToFocusEnabled)`	Whether touch-to-focus is enabled on camera preview.
`final String`	`getCancelButtonTitle()`	Title of the cancel button.
`final Unit`	`setCancelButtonTitle(String cancelButtonTitle)`	Title of the cancel button.
`final JsonImageFilterType`	`getDefaultPageFilter()`	Default image filter type for new document pages.
`final Unit`	`setDefaultPageFilter(JsonImageFilterType defaultPageFilter)`	Default image filter type for new document pages.
`final String`	`getEnableCameraButtonTitle()`	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
`final Unit`	`setEnableCameraButtonTitle(String enableCameraButtonTitle)`	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
`final String`	`getEnableCameraExplanationText()`	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
`final Unit`	`setEnableCameraExplanationText(String enableCameraExplanationText)`	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
`final Boolean`	`getFlashButtonHidden()`	Whether the flash toggle button is hidden.
`final Unit`	`setFlashButtonHidden(Boolean flashButtonHidden)`	Whether the flash toggle button is hidden.
`final Boolean`	`getFlashEnabled()`	Whether the flash should be initially enabled.
`final Unit`	`setFlashEnabled(Boolean flashEnabled)`	Whether the flash should be initially enabled.
`final Boolean`	`getForceUserGuidance()`	Whether to show the user guidance elements if auto-snapping is disabled.
`final Unit`	`setForceUserGuidance(Boolean forceUserGuidance)`	Whether to show the user guidance elements if auto-snapping is disabled.
`final Boolean`	`getFinderEnabled()`	Whether to enable the view finder.
`final Unit`	`setFinderEnabled(Boolean finderEnabled)`	Whether to enable the view finder.
`final JsonColor`	`getFinderLineColor()`	Foreground color of the detection overlay.
`final Unit`	`setFinderLineColor(JsonColor finderLineColor)`	Foreground color of the detection overlay.
`final Double`	`getFinderLineWidth()`	Width of finder frame border.
`final Unit`	`setFinderLineWidth(Double finderLineWidth)`	Width of finder frame border.
`final JsonColor`	`getCameraOverlayColor()`	Background color outside of the finder window.
`final Unit`	`setCameraOverlayColor(JsonColor cameraOverlayColor)`	Background color outside of the finder window.
`final JsonAspectRatio`	`getFinderAspectRatio()`	Aspect ratio of the finder frame (width to height), which is used to build the actual finder frame.
`final Unit`	`setFinderAspectRatio(JsonAspectRatio finderAspectRatio)`	Aspect ratio of the finder frame (width to height), which is used to build the actual finder frame.
`final Boolean`	`getIgnoreBadAspectRatio()`	Sets whether to ignore the OK_BUT_BAD_ASPECT_RATIO detection status.
`final Unit`	`setIgnoreBadAspectRatio(Boolean ignoreBadAspectRatio)`	Sets whether to ignore the OK_BUT_BAD_ASPECT_RATIO detection status.
`final Double`	`getImageScale()`	Image scaling factor.
`final Unit`	`setImageScale(Double imageScale)`	Image scaling factor.
`final JsonOrientationLockMode`	`getOrientationLockMode()`	Mode for locking the UI's orientation.
`final Unit`	`setOrientationLockMode(JsonOrientationLockMode orientationLockMode)`	Mode for locking the UI's orientation.
`final JsonCapturePhotoQualityPrioritization`	`getPhotoQualityPrioritization()`	Prioritization of still image quality and capturing speed.
`final Unit`	`setPhotoQualityPrioritization(JsonCapturePhotoQualityPrioritization photoQualityPrioritization)`	Prioritization of still image quality and capturing speed.
`final Boolean`	`getPolygonEnabled()`	Whether to display the document's polygon.
`final Unit`	`setPolygonEnabled(Boolean polygonEnabled)`	Whether to display the document's polygon.
`final JsonColor`	`getPolygonBackgroundColor()`	Background color of the detected document's outline when the document's angle, size or aspect ratio is not yet sufficiently good.
`final Unit`	`setPolygonBackgroundColor(JsonColor polygonBackgroundColor)`	Background color of the detected document's outline when the document's angle, size or aspect ratio is not yet sufficiently good.
`final JsonColor`	`getPolygonBackgroundColorOK()`	Background color of the detected document's outline when ready to snap.
`final Unit`	`setPolygonBackgroundColorOK(JsonColor polygonBackgroundColorOK)`	Background color of the detected document's outline when ready to snap.
`final JsonColor`	`getPolygonColor()`	Color of the detected document's outline when the document's angle, size or aspect ratio is not yet sufficiently good.
`final Unit`	`setPolygonColor(JsonColor polygonColor)`	Color of the detected document's outline when the document's angle, size or aspect ratio is not yet sufficiently good.
`final JsonColor`	`getPolygonColorOK()`	Color of the detected document's outline when ready to snap.
`final Unit`	`setPolygonColorOK(JsonColor polygonColorOK)`	Color of the detected document's outline when ready to snap.
`final Double`	`getPolygonLineWidth()`	Width of the detected document's outline.
`final Unit`	`setPolygonLineWidth(Double polygonLineWidth)`	Width of the detected document's outline.
`final Double`	`getPolygonCornerRadius()`	Radius to use when drawing rounded corners of the polygon.
`final Unit`	`setPolygonCornerRadius(Double polygonCornerRadius)`	Radius to use when drawing rounded corners of the polygon.
`final JsonColor`	`getAutoSnapProgressColor()`	Stroke color of the polygon or the finder's auto-snap progress animation.
`final Unit`	`setAutoSnapProgressColor(JsonColor autoSnapProgressColor)`	Stroke color of the polygon or the finder's auto-snap progress animation.
`final Double`	`getAutoSnapProgressLineWidth()`	Line width of the polygon or the finder's auto-snap progress animation.
`final Unit`	`setAutoSnapProgressLineWidth(Double autoSnapProgressLineWidth)`	Line width of the polygon or the finder's auto-snap progress animation.
`final Boolean`	`getAutoSnapProgressEnabled()`	Whether to enable the polygon or finder's auto-snap progress animation.
`final Unit`	`setAutoSnapProgressEnabled(Boolean autoSnapProgressEnabled)`	Whether to enable the polygon or finder's auto-snap progress animation.
`final Boolean`	`getLockDocumentAspectRatioToFinder()`	Whether to allow scanning only for documents with the same aspect ratio as the finder.
`final Unit`	`setLockDocumentAspectRatioToFinder(Boolean lockDocumentAspectRatioToFinder)`	Whether to allow scanning only for documents with the same aspect ratio as the finder.
`final JsonColor`	`getShutterButtonAutoInnerColor()`	Foreground color of the shutter button in auto-snapping mode.
`final Unit`	`setShutterButtonAutoInnerColor(JsonColor shutterButtonAutoInnerColor)`	Foreground color of the shutter button in auto-snapping mode.
`final JsonColor`	`getShutterButtonAutoOuterColor()`	Background color of the shutter button in auto-snapping mode.
`final Unit`	`setShutterButtonAutoOuterColor(JsonColor shutterButtonAutoOuterColor)`	Background color of the shutter button in auto-snapping mode.
`final JsonColor`	`getShutterButtonManualInnerColor()`	Foreground color of the shutter button in manual mode.
`final Unit`	`setShutterButtonManualInnerColor(JsonColor shutterButtonManualInnerColor)`	Foreground color of the shutter button in manual mode.
`final JsonColor`	`getShutterButtonManualOuterColor()`	Background color of the shutter button in manual mode.
`final Unit`	`setShutterButtonManualOuterColor(JsonColor shutterButtonManualOuterColor)`	Background color of the shutter button in manual mode.
`final String`	`getTextHintBadAngles()`	Text hint that will be shown when the current detection status is OK_BUT_BAD_ANGLES.
`final Unit`	`setTextHintBadAngles(String textHintBadAngles)`	Text hint that will be shown when the current detection status is OK_BUT_BAD_ANGLES.
`final String`	`getTextHintBadAspectRatio()`	Text hint that will be shown when the current detection status is OK_BUT_BAD_ASPECT_RATIO.
`final Unit`	`setTextHintBadAspectRatio(String textHintBadAspectRatio)`	Text hint that will be shown when the current detection status is OK_BUT_BAD_ASPECT_RATIO.
`final String`	`getTextHintNothingDetected()`	Text hint that will be shown when the current detection status is ERROR_NOTHING_DETECTED.
`final Unit`	`setTextHintNothingDetected(String textHintNothingDetected)`	Text hint that will be shown when the current detection status is ERROR_NOTHING_DETECTED.
`final String`	`getTextHintOffCenter()`	Text hint that will be show when a document was detected, but its center is too far away from the image center.
`final Unit`	`setTextHintOffCenter(String textHintOffCenter)`	Text hint that will be show when a document was detected, but its center is too far away from the image center.
`final String`	`getTextHintOK()`	Text hint that will be shown when the current detection status is OK.
`final Unit`	`setTextHintOK(String textHintOK)`	Text hint that will be shown when the current detection status is OK.
`final String`	`getTextHintTooDark()`	Text hint that will be shown when the current detection status is ERROR_TOO_DARK.
`final Unit`	`setTextHintTooDark(String textHintTooDark)`	Text hint that will be shown when the current detection status is ERROR_TOO_DARK.
`final String`	`getTextHintTooNoisy()`	Text hint that will be shown when the current detection status is ERROR_TOO_NOISY.
`final Unit`	`setTextHintTooNoisy(String textHintTooNoisy)`	Text hint that will be shown when the current detection status is ERROR_TOO_NOISY.
`final String`	`getTextHintTooSmall()`	Text hint that will be shown when the current detection status is OK_BUT_TOO_SMALL.
`final Unit`	`setTextHintTooSmall(String textHintTooSmall)`	Text hint that will be shown when the current detection status is OK_BUT_TOO_SMALL.
`final JsonColor`	`getTopBarBackgroundColor()`	Background color of the top toolbar.
`final Unit`	`setTopBarBackgroundColor(JsonColor topBarBackgroundColor)`	Background color of the top toolbar.
`final JsonColor`	`getTopBarButtonsActiveColor()`	Color of all active toggle buttons in the toolbar.
`final Unit`	`setTopBarButtonsActiveColor(JsonColor topBarButtonsActiveColor)`	Color of all active toggle buttons in the toolbar.
`final JsonColor`	`getTopBarButtonsInactiveColor()`	Color of all inactive toggle buttons in the toolbar.
`final Unit`	`setTopBarButtonsInactiveColor(JsonColor topBarButtonsInactiveColor)`	Color of all inactive toggle buttons in the toolbar.
`final JsonColor`	`getUserGuidanceBackgroundColor()`	Background color of the user guidance hints.
`final Unit`	`setUserGuidanceBackgroundColor(JsonColor userGuidanceBackgroundColor)`	Background color of the user guidance hints.
`final JsonColor`	`getUserGuidanceTextColor()`	Text color of the user guidance hints.
`final Unit`	`setUserGuidanceTextColor(JsonColor userGuidanceTextColor)`	Text color of the user guidance hints.
`final Double`	`getUserGuidanceFontSize()`	Font size of the user guidance.
`final Unit`	`setUserGuidanceFontSize(Double userGuidanceFontSize)`	Font size of the user guidance.
`final JsonSize`	`getDocumentImageSizeLimit()`	Limits the maximum size of the document image.
`final Unit`	`setDocumentImageSizeLimit(JsonSize documentImageSizeLimit)`	Limits the maximum size of the document image.
`final Boolean`	`getShutterButtonHidden()`	Whether to hide the shutter button.
`final Unit`	`setShutterButtonHidden(Boolean shutterButtonHidden)`	Whether to hide the shutter button.
`final Boolean`	`getUseButtonsAllCaps()`	Whether buttons should use all-capitals style, as defined by the Android Material Design.
`final Unit`	`setUseButtonsAllCaps(Boolean useButtonsAllCaps)`	Whether buttons should use all-capitals style, as defined by the Android Material Design.
`final JsonFinderDocumentScannerAccessibilityConfiguration`	`getAccessibilityConfiguration()`	Allows you to customize the accessibility configuration for the Document Scanner UI.
`final Unit`	`setAccessibilityConfiguration(JsonFinderDocumentScannerAccessibilityConfiguration accessibilityConfiguration)`	Allows you to customize the accessibility configuration for the Document Scanner UI.

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

- Constructor Detail
  - FinderDocumentScannerJsonConfiguration
```
FinderDocumentScannerJsonConfiguration(String version, String screen, Double acceptedAngleScore, Double acceptedSizeScore, Double acceptedBrightnessThreshold, Boolean autoSnappingEnabled, Double autoSnappingSensitivity, JsonCameraModule cameraModule, JsonColor cameraBackgroundColor, JsonCameraPreviewMode cameraPreviewMode, Boolean touchToFocusEnabled, String cancelButtonTitle, JsonImageFilterType defaultPageFilter, String enableCameraButtonTitle, String enableCameraExplanationText, Boolean flashButtonHidden, Boolean flashEnabled, Boolean forceUserGuidance, Boolean finderEnabled, JsonColor finderLineColor, Double finderLineWidth, JsonColor cameraOverlayColor, JsonAspectRatio finderAspectRatio, Boolean ignoreBadAspectRatio, Double imageScale, JsonOrientationLockMode orientationLockMode, JsonCapturePhotoQualityPrioritization photoQualityPrioritization, Boolean polygonEnabled, JsonColor polygonBackgroundColor, JsonColor polygonBackgroundColorOK, JsonColor polygonColor, JsonColor polygonColorOK, Double polygonLineWidth, Double polygonCornerRadius, JsonColor autoSnapProgressColor, Double autoSnapProgressLineWidth, Boolean autoSnapProgressEnabled, Boolean lockDocumentAspectRatioToFinder, JsonColor shutterButtonAutoInnerColor, JsonColor shutterButtonAutoOuterColor, JsonColor shutterButtonManualInnerColor, JsonColor shutterButtonManualOuterColor, String textHintBadAngles, String textHintBadAspectRatio, String textHintNothingDetected, String textHintOffCenter, String textHintOK, String textHintTooDark, String textHintTooNoisy, String textHintTooSmall, JsonColor topBarBackgroundColor, JsonColor topBarButtonsActiveColor, JsonColor topBarButtonsInactiveColor, JsonColor userGuidanceBackgroundColor, JsonColor userGuidanceTextColor, Double userGuidanceFontSize, JsonSize documentImageSizeLimit, Boolean shutterButtonHidden, Boolean useButtonsAllCaps, JsonFinderDocumentScannerAccessibilityConfiguration accessibilityConfiguration)
```
- Method Detail
  - getVersion
```
 final String getVersion()
```
    Version number of the configuration object.
  - setVersion
```
 final Unit setVersion(String version)
```
    Version number of the configuration object.
  - getScreen
```
 final String getScreen()
```
    Screen for which the configuration object should be applied.
  - setScreen
```
 final Unit setScreen(String screen)
```
    Screen for which the configuration object should be applied.
  - getAcceptedAngleScore
```
 final Double getAcceptedAngleScore()
```
    Minimum score in percent (0 - 100) of the accepted perspective distortion of the detected document. Default is 75.0.
  - setAcceptedAngleScore
```
 final Unit setAcceptedAngleScore(Double acceptedAngleScore)
```
    Minimum score in percent (0 - 100) of the accepted perspective distortion of the detected document. Default is 75.0.
  - getAcceptedSizeScore
```
 final Double getAcceptedSizeScore()
```
    Minimum score in percent (0 - 100) of accepted document width or height to screen size ratio of the detected document. Default is 80.0.
  - setAcceptedSizeScore
```
 final Unit setAcceptedSizeScore(Double acceptedSizeScore)
```
    Minimum score in percent (0 - 100) of accepted document width or height to screen size ratio of the detected document. Default is 80.0.
  - getAcceptedBrightnessThreshold
```
 final Double getAcceptedBrightnessThreshold()
```
    The brightness threshold to accept a detected document in the range of 0 (very dark) to 255 (very bright). If the average brightness value of the detectors input image is below this value, the status of the detection will be set to ERROR_TOO_DARK.
  - 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). If the average brightness value of the detectors input image is below this value, the status of the detection will be set to ERROR_TOO_DARK.
  - getAutoSnappingEnabled
```
 final Boolean getAutoSnappingEnabled()
```
    Whether to enable auto-snapping. If enabled, the document scanner will take a photo automatically when a document is detected, conditions are good and the auto-snapping time-out elapses. In this mode, the user can still tap the shutter button to snap a document.
  - setAutoSnappingEnabled
```
 final Unit setAutoSnappingEnabled(Boolean autoSnappingEnabled)
```
    Whether to enable auto-snapping. If enabled, the document scanner will take a photo automatically when a document is detected, conditions are good and the auto-snapping time-out elapses. In this mode, the user can still tap the shutter button to snap a document.
  - getAutoSnappingSensitivity
```
 final Double getAutoSnappingSensitivity()
```
    Controls the auto-snapping speed. Sensitivity must be within the 0..1 range. A value of 1.0 triggers automatic capturing immediately, a value of 0.0 delays the automatic capturing by 3 seconds. Default value is 0.66 (2 seconds).
  - setAutoSnappingSensitivity
```
 final Unit setAutoSnappingSensitivity(Double autoSnappingSensitivity)
```
    Controls the auto-snapping speed. Sensitivity must be within the 0..1 range. A value of 1.0 triggers automatic capturing immediately, a value of 0.0 delays the automatic capturing by 3 seconds. Default value is 0.66 (2 seconds).
  - getCameraModule
```
 final JsonCameraModule getCameraModule()
```
    Preferred camera module (Default: BACK).
  - setCameraModule
```
 final Unit setCameraModule(JsonCameraModule cameraModule)
```
    Preferred camera module (Default: BACK).
  - getCameraBackgroundColor
```
 final JsonColor getCameraBackgroundColor()
```
    Color of the camera background (relevant only when the camera preview mode is CameraPreviewMode.FIT_IN).
  - setCameraBackgroundColor
```
 final Unit setCameraBackgroundColor(JsonColor cameraBackgroundColor)
```
    Color of the camera background (relevant only when the camera preview mode is CameraPreviewMode.FIT_IN).
  - getCameraPreviewMode
```
 final JsonCameraPreviewMode getCameraPreviewMode()
```
    Preview mode of the camera. Fit-In or Fill-In.
  - setCameraPreviewMode
```
 final Unit setCameraPreviewMode(JsonCameraPreviewMode cameraPreviewMode)
```
    Preview mode of the camera. Fit-In or Fill-In.
  - getTouchToFocusEnabled
```
 final Boolean getTouchToFocusEnabled()
```
    Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
  - setTouchToFocusEnabled
```
 final Unit setTouchToFocusEnabled(Boolean touchToFocusEnabled)
```
    Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
  - getCancelButtonTitle
```
 final String getCancelButtonTitle()
```
    Title of the cancel button.
  - setCancelButtonTitle
```
 final Unit setCancelButtonTitle(String cancelButtonTitle)
```
    Title of the cancel button.
  - getDefaultPageFilter
```
 final JsonImageFilterType getDefaultPageFilter()
```
    Default image filter type for new document pages. Defaults to ImageFilterTypeNone.
  - setDefaultPageFilter
```
 final Unit setDefaultPageFilter(JsonImageFilterType defaultPageFilter)
```
    Default image filter type for new document pages. Defaults to ImageFilterTypeNone.
  - getEnableCameraButtonTitle
```
 final String getEnableCameraButtonTitle()
```
    Title of the button that opens the screen where the user can allow the usage of the camera by the app.
  - setEnableCameraButtonTitle
```
 final Unit setEnableCameraButtonTitle(String enableCameraButtonTitle)
```
    Title of the button that opens the screen where the user can allow the usage of the camera by the app.
  - getEnableCameraExplanationText
```
 final String getEnableCameraExplanationText()
```
    Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
  - setEnableCameraExplanationText
```
 final Unit setEnableCameraExplanationText(String enableCameraExplanationText)
```
    Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
  - getFlashButtonHidden
```
 final Boolean getFlashButtonHidden()
```
    Whether the flash toggle button is hidden.
  - setFlashButtonHidden
```
 final Unit setFlashButtonHidden(Boolean flashButtonHidden)
```
    Whether the flash toggle button is hidden.
  - getFlashEnabled
```
 final Boolean getFlashEnabled()
```
    Whether the flash should be initially enabled. The default value is FALSE.
  - setFlashEnabled
```
 final Unit setFlashEnabled(Boolean flashEnabled)
```
    Whether the flash should be initially enabled. The default value is FALSE.
  - getForceUserGuidance
```
 final Boolean getForceUserGuidance()
```
    Whether to show the user guidance elements if auto-snapping is disabled.
  - setForceUserGuidance
```
 final Unit setForceUserGuidance(Boolean forceUserGuidance)
```
    Whether to show the user guidance elements if auto-snapping is disabled.
  - getFinderEnabled
```
 final Boolean getFinderEnabled()
```
    Whether to enable the view finder.
  - setFinderEnabled
```
 final Unit setFinderEnabled(Boolean finderEnabled)
```
    Whether to enable the view finder.
  - getFinderLineColor
```
 final JsonColor getFinderLineColor()
```
    Foreground color of the detection overlay.
  - setFinderLineColor
```
 final Unit setFinderLineColor(JsonColor finderLineColor)
```
    Foreground color of the detection overlay.
  - getFinderLineWidth
```
 final Double getFinderLineWidth()
```
    Width of finder frame border. Default is 2.
  - setFinderLineWidth
```
 final Unit setFinderLineWidth(Double finderLineWidth)
```
    Width of finder frame border. Default is 2.
  - getCameraOverlayColor
```
 final JsonColor getCameraOverlayColor()
```
    Background color outside of the finder window.
  - setCameraOverlayColor
```
 final Unit setCameraOverlayColor(JsonColor cameraOverlayColor)
```
    Background color outside of the finder window.
  - getFinderAspectRatio
```
 final JsonAspectRatio getFinderAspectRatio()
```
    Aspect ratio of the finder frame (width to height), which is used to build the actual finder frame. Default is the DIN A4 aspect ratio.
  - setFinderAspectRatio
```
 final Unit setFinderAspectRatio(JsonAspectRatio finderAspectRatio)
```
    Aspect ratio of the finder frame (width to height), which is used to build the actual finder frame. Default is the DIN A4 aspect ratio.
  - getIgnoreBadAspectRatio
```
 final Boolean getIgnoreBadAspectRatio()
```
    Sets whether to ignore the OK_BUT_BAD_ASPECT_RATIO detection status. By default, BadAspectRatio is ignored.
  - setIgnoreBadAspectRatio
```
 final Unit setIgnoreBadAspectRatio(Boolean ignoreBadAspectRatio)
```
    Sets whether to ignore the OK_BUT_BAD_ASPECT_RATIO detection status. By default, BadAspectRatio is ignored.
  - getImageScale
```
 final Double getImageScale()
```
    Image scaling factor. The factor must be within the 0..1 range. A factor of 1 means that the resulting images retain their original size. When the factor is less than 1, resulting images will be made smaller by that factor. By default the scale is 1.
  - setImageScale
```
 final Unit setImageScale(Double imageScale)
```
    Image scaling factor. The factor must be within the 0..1 range. A factor of 1 means that the resulting images retain their original size. When the factor is less than 1, resulting images will be made smaller by that factor. By default the scale is 1.
  - getOrientationLockMode
```
 final JsonOrientationLockMode getOrientationLockMode()
```
    Mode for locking the UI's orientation.
  - setOrientationLockMode
```
 final Unit setOrientationLockMode(JsonOrientationLockMode orientationLockMode)
```
    Mode for locking the UI's orientation.
  - getPhotoQualityPrioritization
```
 final JsonCapturePhotoQualityPrioritization getPhotoQualityPrioritization()
```
    Prioritization of still image quality and capturing speed. Defaults to CapturePhotoQualityPrioritization.BALANCED. If you experience lots of blurry still images, try to set this property to CapturePhotoQualityPrioritization.QUALITY. iOS only.
  - setPhotoQualityPrioritization
```
 final Unit setPhotoQualityPrioritization(JsonCapturePhotoQualityPrioritization photoQualityPrioritization)
```
    Prioritization of still image quality and capturing speed. Defaults to CapturePhotoQualityPrioritization.BALANCED. If you experience lots of blurry still images, try to set this property to CapturePhotoQualityPrioritization.QUALITY. iOS only.
  - getPolygonEnabled
```
 final Boolean getPolygonEnabled()
```
    Whether to display the document's polygon.
  - setPolygonEnabled
```
 final Unit setPolygonEnabled(Boolean polygonEnabled)
```
    Whether to display the document's polygon.
  - getPolygonBackgroundColor
```
 final JsonColor getPolygonBackgroundColor()
```
    Background color of the detected document's outline when the document's angle, size or aspect ratio is not yet sufficiently good. (All net.doo.snap.lib.detector.DetectionResult with OK_BUT_XXX.)
  - setPolygonBackgroundColor
```
 final Unit setPolygonBackgroundColor(JsonColor polygonBackgroundColor)
```
    Background color of the detected document's outline when the document's angle, size or aspect ratio is not yet sufficiently good. (All net.doo.snap.lib.detector.DetectionResult with OK_BUT_XXX.)
  - getPolygonBackgroundColorOK
```
 final JsonColor getPolygonBackgroundColorOK()
```
    Background color of the detected document's outline when ready to snap.
  - setPolygonBackgroundColorOK
```
 final Unit setPolygonBackgroundColorOK(JsonColor polygonBackgroundColorOK)
```
    Background color of the detected document's outline when ready to snap.
  - getPolygonColor
```
 final JsonColor getPolygonColor()
```
    Color of the detected document's outline when the document's angle, size or aspect ratio is not yet sufficiently good. (All detection statuses in net.doo.snap.lib.detector.DetectionResult that have the OK_BUT_XXX prefix.)
  - setPolygonColor
```
 final Unit setPolygonColor(JsonColor polygonColor)
```
    Color of the detected document's outline when the document's angle, size or aspect ratio is not yet sufficiently good. (All detection statuses in net.doo.snap.lib.detector.DetectionResult that have the OK_BUT_XXX prefix.)
  - getPolygonColorOK
```
 final JsonColor getPolygonColorOK()
```
    Color of the detected document's outline when ready to snap.
  - setPolygonColorOK
```
 final Unit setPolygonColorOK(JsonColor polygonColorOK)
```
    Color of the detected document's outline when ready to snap.
  - getPolygonLineWidth
```
 final Double getPolygonLineWidth()
```
    Width of the detected document's outline.
  - setPolygonLineWidth
```
 final Unit setPolygonLineWidth(Double polygonLineWidth)
```
    Width of the detected document's outline.
  - getPolygonCornerRadius
```
 final Double getPolygonCornerRadius()
```
    Radius to use when drawing rounded corners of the polygon. Default is 8.0.
  - setPolygonCornerRadius
```
 final Unit setPolygonCornerRadius(Double polygonCornerRadius)
```
    Radius to use when drawing rounded corners of the polygon. Default is 8.0.
  - getAutoSnapProgressColor
```
 final JsonColor getAutoSnapProgressColor()
```
    Stroke color of the polygon or the finder's auto-snap progress animation. Default is green. Can't be nil.
  - setAutoSnapProgressColor
```
 final Unit setAutoSnapProgressColor(JsonColor autoSnapProgressColor)
```
    Stroke color of the polygon or the finder's auto-snap progress animation. Default is green. Can't be nil.
  - getAutoSnapProgressLineWidth
```
 final Double getAutoSnapProgressLineWidth()
```
    Line width of the polygon or the finder's auto-snap progress animation. Default is 5.0.
  - setAutoSnapProgressLineWidth
```
 final Unit setAutoSnapProgressLineWidth(Double autoSnapProgressLineWidth)
```
    Line width of the polygon or the finder's auto-snap progress animation. Default is 5.0.
  - getAutoSnapProgressEnabled
```
 final Boolean getAutoSnapProgressEnabled()
```
    Whether to enable the polygon or finder's auto-snap progress animation. Default is true.
  - setAutoSnapProgressEnabled
```
 final Unit setAutoSnapProgressEnabled(Boolean autoSnapProgressEnabled)
```
    Whether to enable the polygon or finder's auto-snap progress animation. Default is true.
  - getLockDocumentAspectRatioToFinder
```
 final Boolean getLockDocumentAspectRatioToFinder()
```
    Whether to allow scanning only for documents with the same aspect ratio as the finder.
  - setLockDocumentAspectRatioToFinder
```
 final Unit setLockDocumentAspectRatioToFinder(Boolean lockDocumentAspectRatioToFinder)
```
    Whether to allow scanning only for documents with the same aspect ratio as the finder.
  - getShutterButtonAutoInnerColor
```
 final JsonColor getShutterButtonAutoInnerColor()
```
    Foreground color of the shutter button in auto-snapping mode.
  - setShutterButtonAutoInnerColor
```
 final Unit setShutterButtonAutoInnerColor(JsonColor shutterButtonAutoInnerColor)
```
    Foreground color of the shutter button in auto-snapping mode.
  - getShutterButtonAutoOuterColor
```
 final JsonColor getShutterButtonAutoOuterColor()
```
    Background color of the shutter button in auto-snapping mode.
  - setShutterButtonAutoOuterColor
```
 final Unit setShutterButtonAutoOuterColor(JsonColor shutterButtonAutoOuterColor)
```
    Background color of the shutter button in auto-snapping mode.
  - getShutterButtonManualInnerColor
```
 final JsonColor getShutterButtonManualInnerColor()
```
    Foreground color of the shutter button in manual mode.
  - setShutterButtonManualInnerColor
```
 final Unit setShutterButtonManualInnerColor(JsonColor shutterButtonManualInnerColor)
```
    Foreground color of the shutter button in manual mode.
  - getShutterButtonManualOuterColor
```
 final JsonColor getShutterButtonManualOuterColor()
```
    Background color of the shutter button in manual mode.
  - setShutterButtonManualOuterColor
```
 final Unit setShutterButtonManualOuterColor(JsonColor shutterButtonManualOuterColor)
```
    Background color of the shutter button in manual mode.
  - getTextHintBadAngles
```
 final String getTextHintBadAngles()
```
    Text hint that will be shown when the current detection status is OK_BUT_BAD_ANGLES.
  - setTextHintBadAngles
```
 final Unit setTextHintBadAngles(String textHintBadAngles)
```
    Text hint that will be shown when the current detection status is OK_BUT_BAD_ANGLES.
  - getTextHintBadAspectRatio
```
 final String getTextHintBadAspectRatio()
```
    Text hint that will be shown when the current detection status is OK_BUT_BAD_ASPECT_RATIO.
  - setTextHintBadAspectRatio
```
 final Unit setTextHintBadAspectRatio(String textHintBadAspectRatio)
```
    Text hint that will be shown when the current detection status is OK_BUT_BAD_ASPECT_RATIO.
  - getTextHintNothingDetected
```
 final String getTextHintNothingDetected()
```
    Text hint that will be shown when the current detection status is ERROR_NOTHING_DETECTED.
  - setTextHintNothingDetected
```
 final Unit setTextHintNothingDetected(String textHintNothingDetected)
```
    Text hint that will be shown when the current detection status is ERROR_NOTHING_DETECTED.
  - getTextHintOffCenter
```
 final String getTextHintOffCenter()
```
    Text hint that will be show when a document was detected, but its center is too far away from the image center.
  - setTextHintOffCenter
```
 final Unit setTextHintOffCenter(String textHintOffCenter)
```
    Text hint that will be show when a document was detected, but its center is too far away from the image center.
  - getTextHintOK
```
 final String getTextHintOK()
```
    Text hint that will be shown when the current detection status is OK.
  - setTextHintOK
```
 final Unit setTextHintOK(String textHintOK)
```
    Text hint that will be shown when the current detection status is OK.
  - getTextHintTooDark
```
 final String getTextHintTooDark()
```
    Text hint that will be shown when the current detection status is ERROR_TOO_DARK.
  - setTextHintTooDark
```
 final Unit setTextHintTooDark(String textHintTooDark)
```
    Text hint that will be shown when the current detection status is ERROR_TOO_DARK.
  - getTextHintTooNoisy
```
 final String getTextHintTooNoisy()
```
    Text hint that will be shown when the current detection status is ERROR_TOO_NOISY.
  - setTextHintTooNoisy
```
 final Unit setTextHintTooNoisy(String textHintTooNoisy)
```
    Text hint that will be shown when the current detection status is ERROR_TOO_NOISY.
  - getTextHintTooSmall
```
 final String getTextHintTooSmall()
```
    Text hint that will be shown when the current detection status is OK_BUT_TOO_SMALL.
  - setTextHintTooSmall
```
 final Unit setTextHintTooSmall(String textHintTooSmall)
```
    Text hint that will be shown when the current detection status is OK_BUT_TOO_SMALL.
  - getTopBarBackgroundColor
```
 final JsonColor getTopBarBackgroundColor()
```
    Background color of the top toolbar.
  - setTopBarBackgroundColor
```
 final Unit setTopBarBackgroundColor(JsonColor topBarBackgroundColor)
```
    Background color of the top toolbar.
  - getTopBarButtonsActiveColor
```
 final JsonColor getTopBarButtonsActiveColor()
```
    Color of all active toggle buttons in the toolbar.
  - setTopBarButtonsActiveColor
```
 final Unit setTopBarButtonsActiveColor(JsonColor topBarButtonsActiveColor)
```
    Color of all active toggle buttons in the toolbar.
  - getTopBarButtonsInactiveColor
```
 final JsonColor getTopBarButtonsInactiveColor()
```
    Color of all inactive toggle buttons in the toolbar.
  - setTopBarButtonsInactiveColor
```
 final Unit setTopBarButtonsInactiveColor(JsonColor topBarButtonsInactiveColor)
```
    Color of all inactive toggle buttons in the toolbar.
  - getUserGuidanceBackgroundColor
```
 final JsonColor getUserGuidanceBackgroundColor()
```
    Background color of the user guidance hints.
  - setUserGuidanceBackgroundColor
```
 final Unit setUserGuidanceBackgroundColor(JsonColor userGuidanceBackgroundColor)
```
    Background color of the user guidance hints.
  - getUserGuidanceTextColor
```
 final JsonColor getUserGuidanceTextColor()
```
    Text color of the user guidance hints.
  - setUserGuidanceTextColor
```
 final Unit setUserGuidanceTextColor(JsonColor userGuidanceTextColor)
```
    Text color of the user guidance hints.
  - getUserGuidanceFontSize
```
 final Double getUserGuidanceFontSize()
```
    Font size of the user guidance. Default is 17.0.
  - setUserGuidanceFontSize
```
 final Unit setUserGuidanceFontSize(Double userGuidanceFontSize)
```
    Font size of the user guidance. Default is 17.0.
  - getDocumentImageSizeLimit
```
 final JsonSize getDocumentImageSizeLimit()
```
    Limits the maximum size of the document image. If the width or height are zero, this property is effectively ignored.
  - setDocumentImageSizeLimit
```
 final Unit setDocumentImageSizeLimit(JsonSize documentImageSizeLimit)
```
    Limits the maximum size of the document image. If the width or height are zero, this property is effectively ignored.
  - getShutterButtonHidden
```
 final Boolean getShutterButtonHidden()
```
    Whether to hide the shutter button. Defaults to TRUE. If set to TRUE, auto-snapping is enabled and the property autoSnappingEnabled of the behavior configuration will have no effect. Also the auto-snapping button will be hidden.
  - setShutterButtonHidden
```
 final Unit setShutterButtonHidden(Boolean shutterButtonHidden)
```
    Whether to hide the shutter button. Defaults to TRUE. If set to TRUE, auto-snapping is enabled and the property autoSnappingEnabled of the behavior configuration will have no effect. Also the auto-snapping button will be hidden.
  - getUseButtonsAllCaps
```
 final Boolean getUseButtonsAllCaps()
```
    Whether buttons should use all-capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
  - setUseButtonsAllCaps
```
 final Unit setUseButtonsAllCaps(Boolean useButtonsAllCaps)
```
    Whether buttons should use all-capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
  - getAccessibilityConfiguration
```
 final JsonFinderDocumentScannerAccessibilityConfiguration getAccessibilityConfiguration()
```
    Allows you to customize the accessibility configuration for the Document Scanner UI.
  - setAccessibilityConfiguration
```
 final Unit setAccessibilityConfiguration(JsonFinderDocumentScannerAccessibilityConfiguration accessibilityConfiguration)
```
    Allows you to customize the accessibility configuration for the Document Scanner UI.

Class FinderDocumentScannerJsonConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FinderDocumentScannerJsonConfiguration

Method Detail

getVersion

setVersion

getScreen

setScreen

getAcceptedAngleScore

setAcceptedAngleScore

getAcceptedSizeScore

setAcceptedSizeScore

getAcceptedBrightnessThreshold

setAcceptedBrightnessThreshold

getAutoSnappingEnabled

setAutoSnappingEnabled

getAutoSnappingSensitivity

setAutoSnappingSensitivity

getCameraModule

setCameraModule

getCameraBackgroundColor

setCameraBackgroundColor

getCameraPreviewMode

setCameraPreviewMode

getTouchToFocusEnabled

setTouchToFocusEnabled

getCancelButtonTitle

setCancelButtonTitle

getDefaultPageFilter

setDefaultPageFilter

getEnableCameraButtonTitle

setEnableCameraButtonTitle

getEnableCameraExplanationText

setEnableCameraExplanationText

getFlashButtonHidden

setFlashButtonHidden

getFlashEnabled

setFlashEnabled

getForceUserGuidance

setForceUserGuidance

getFinderEnabled

setFinderEnabled

getFinderLineColor

setFinderLineColor

getFinderLineWidth

setFinderLineWidth

getCameraOverlayColor

setCameraOverlayColor

getFinderAspectRatio

setFinderAspectRatio

getIgnoreBadAspectRatio

setIgnoreBadAspectRatio

getImageScale

setImageScale

getOrientationLockMode

setOrientationLockMode

getPhotoQualityPrioritization

setPhotoQualityPrioritization

getPolygonEnabled

setPolygonEnabled

getPolygonBackgroundColor

setPolygonBackgroundColor

getPolygonBackgroundColorOK

setPolygonBackgroundColorOK

getPolygonColor

setPolygonColor

getPolygonColorOK

setPolygonColorOK

getPolygonLineWidth

setPolygonLineWidth

getPolygonCornerRadius

setPolygonCornerRadius

getAutoSnapProgressColor

setAutoSnapProgressColor