Document
Constructors
Properties
The minimum score in percent (0 - 100) of the perspective distortion to accept a 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.
The minimum document width or height in percent (0 - 100) of the screen size to accept a detected document. Default is 80.0.
Allows you to customize the accessibility configuration for the Document Scanner UI
Controls whether the auto-snapping toggle button is hidden or not.
Title of the auto-snapping toggle button.
When auto-snapping is 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 by 3 seconds. The default value is 0.66 (2 seconds)
The background color of the bottom shutter-bar.
The color of the title of all buttons in the bottom shutter-bar (Cancel button, etc.), as well as the camera permission prompt button.
The color of the camera background (relevant only when the camera preview mode is CameraPreviewMode.FIT_IN).
The preferred camera module (default - BACK)
Preview mode of the camera. Fit-In or Fill-In.
Title of the cancel button.
The default image filter type for new documents pages. Defaults to ImageFilterTypeNone.
Limits the maximum size of the document image. If 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.
Controls whether the flash toggle button is hidden or not.
Title of the flash toggle button.
Controls whether the flash should be initially enabled. The default value is FALSE.
Shows the user guidance elements if autosnapping is disabled.
Sets whether to ignore the OK_BUT_ORIENTATION_MISMATCH detection status. By default OrientationMismatch is not ignored.
The 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.
Maximum number of pages to scan. Ignored when set to null, or when multiPageEnabled is FALSE. Default value is null.
Controls whether the multi-page toggle button is hidden or not.
Title of the multi-page mode toggle button.
Controls multi-page mode. When enabled, the user can take multiple document photos before closing the screen by tapping the page counter button. When disabled, the screen will be closed immediately after the first document photo is made. The default value is FALSE.
UI Interface orientation lock mode
Title suffix of the button that finishes the document scanning when multi-page scanning is enabled. The button's title has the format "# Pages", where '#' shows the number of images captured up to now and the suffix "Pages" is set using this method.
The 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. Note: Has no effect on devices prior to iOS 13.0!. iOS only.
Stroke color of polygon auto snap progress animation. Default is green. Can't be nil.
Whether polygon auto snap progress animation is enabled or not. Default is true.
Line width of polygon auto snap progress animation. Default is 5.0.
The background color of the detected document 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).
The background color of the detected document outline when we are ready to snap OK.
The color of the detected document 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).
The color of the detected document outline when we are ready to snap OK.
The radius to use when drawing rounded corners of the polygon. Default is 8.0.
Width of the detected document outline.
An optional array of aspect ratios the documents have to conform to.
Whether polygon auto snap progress animation is enabled or not. Default is true.
The background color of the shutter button in auto-snapping mode.
Hides the shutter button if set to TRUE. Shows it otherwise. Defaults to FALSE. If set to TRUE, auto-snapping is enabled and the property autoSnappingEnabled of the behaviour configuration will have no effect. Also the auto-snapping button will be hidden.
The foreground color of the shutter button in manual mode.
The 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
The text being displayed on the user-guidance label, 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
The background color of the top toolbar.
The color of all active toggle buttons in the toolbar.
The color of all inactive toggle buttons in the toolbar.
Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
The background color of the user guidance hints.
Font size of the user guidance. Default is 17.0.
The text color of the user guidance hints.