Finder
Constructors
Properties
Minimum score in percent (0 - 100) of the accepted perspective distortion of the detected document. Default is 75.0.
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.
Minimum score in percent (0 - 100) of accepted document width or height to screen size ratio of the detected document. Default is 80.0.
Allows you to customize the accessibility configuration for the Document Scanner UI.
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.
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).
Stroke color of the polygon or the finder's auto-snap progress animation. Default is green. Can't be nil.
Whether to enable the polygon or finder's auto-snap progress animation. Default is true.
Line width of the polygon or the finder's auto-snap progress animation. Default is 5.0.
Color of the camera background (relevant only when the camera preview mode is CameraPreviewMode.FIT_IN).
Preferred camera module (Default: BACK).
Background color outside of the finder window.
Preview mode of the camera. Fit-In or Fill-In.
Title of the cancel button.
Default image filter type for new document pages. Defaults to ImageFilterTypeNone.
Limits the maximum size of the document image. If the width or height are zero, this property is effectively ignored.
Title of the button that opens the screen where the user can allow the usage of the camera by the app.
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.
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.
Whether to enable the view finder.
Foreground color of the detection overlay.
Width of finder frame border. Default is 2.
Whether the flash toggle button is hidden.
Whether the flash should be initially enabled. The default value is FALSE.
Whether to show the user guidance elements if auto-snapping is disabled.
Sets whether to ignore the OK_BUT_ORIENTATION_MISMATCH detection status. By default OrientationMismatch is not ignored.
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.
Whether to allow scanning only for documents with the same aspect ratio as the finder.
Mode for locking the UI's orientation.
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.
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.)
Background color of the detected document's outline when ready to snap.
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.)
Color of the detected document's outline when ready to snap.
Radius to use when drawing rounded corners of the polygon. Default is 8.0.
Whether to display the document's polygon.
Width of the detected document's outline.
Foreground color of the shutter button in auto-snapping mode.
Background color of the shutter button in auto-snapping mode.
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.
Foreground color of the shutter button in manual mode.
Background color of the shutter button in manual mode.
Text hint that will be shown when the current detection status is OK_BUT_BAD_ANGLES.
Text hint that will be shown when the current detection status is OK_BUT_BAD_ASPECT_RATIO.
Text hint that will be shown when the current detection status is ERROR_NOTHING_DETECTED.
Text hint that will be show when a document was detected, but its center is too far away from the image center.
Text hint that will be shown when the current detection status is OK.
Text hint that will be shown when the current detection status is ERROR_TOO_DARK.
Text hint that will be shown when the current detection status is ERROR_TOO_NOISY.
Text hint that will be shown when the current detection status is OK_BUT_TOO_SMALL.
Background color of the top toolbar.
Color of all active toggle buttons in the toolbar.
Color of all inactive toggle buttons in the toolbar.
Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
Whether buttons should use all-capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
Background color of the user guidance hints.
Font size of the user guidance. Default is 17.0.
Text color of the user guidance hints.