- SCANNED_BARCODE_EXTRA - Static variable in class io.scanbot.sdk.ui.view.barcode.BarcodeScannerActivity
-
- setAcceptedAngleScore(acceptedAngleScore) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document.
Default is 75.0.
- setAcceptedSizeScore(acceptedSizeScore) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The minimum document width or height in percent (0 - 100) of the screen size to accept a detected document.
Default is 80.0.
- setAutoSnappingButtonHidden(autoSnappingButtonHidden) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Controls whether the auto-snapping toggle button is hidden or not.
- setAutoSnappingButtonTitle(autoSnappingButtonTitle) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Title of the auto-snapping toggle button.
- setAutoSnappingEnabled(autoSnappingEnabled) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
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.
- setAutoSnappingSensitivity(autoSnappingSensitivity) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
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)
- setBackgroundColor(color) - Method in class io.scanbot.sdk.ui.view.edit.configuration.CroppingConfiguration
-
Background color of the main screen.
- setBarcodeFormatsFilter(barcodeFormat) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
A list of barcodes that the scanner should recognize. Anything not on the list
will not trigger a detection.
- setBottomBarBackgroundColor(bottomBarBackgroundColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The background color of the bottom shutter-bar.
- setBottomBarBackgroundColor(color) - Method in class io.scanbot.sdk.ui.view.edit.configuration.CroppingConfiguration
-
Background color of the bottom toolbar.
- setBottomBarButtonsColor(bottomBarButtonsColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The color of the title of all buttons in the bottom shutter-bar (Cancel button, etc.),
as well as the camera permission prompt button.
- setBottomBarButtonsColor(color) - Method in class io.scanbot.sdk.ui.view.edit.configuration.CroppingConfiguration
-
Color of the titles of all buttons in the bottom toolbar (Rotate button).
- setCameraBackgroundColor(cameraBackgroundColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The color of the camera background (relevant only when the camera preview mode is CameraPreviewMode.FIT_IN).
- setCameraOverlayColor(cameraOverlayColor) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Background color outside of the finder window.
- setCameraOverlayColor(cameraOverlayColor) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Background color outside of the finder window.
- setCameraPreviewMode(cameraPreviewMode) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Preview mode of the camera: Fit-In or Fill-In.
Optional, default is Fit-In.
- setCancelButtonTitle(cancelButtonTitle) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Title of the cancel button.
- setCancelButtonTitle(cancelButtonTitle) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Title of the cancel button.
- setCancelButtonTitle(text) - Method in class io.scanbot.sdk.ui.view.edit.configuration.CroppingConfiguration
-
Title of the cancel button.
- setCancelButtonTitle(cancelButtonTitle) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Title of the cancel button.
- setDoneButtonTitle(text) - Method in class io.scanbot.sdk.ui.view.edit.configuration.CroppingConfiguration
-
Title of the Done button.
- setEnableCameraButtonTitle(enableCameraButtonTitle) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Title of the button that opens the screen where the user can allow
the usage of the camera by the app.
- setEnableCameraButtonTitle(enableCameraButtonTitle) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Title of the button that opens the screen where the user can allow
the usage of the camera by the app.
- setEnableCameraButtonTitle(enableCameraButtonTitle) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Title of the button that opens the screen where the user can allow
the usage of the camera by the app.
- setEnableCameraExplanationText(enableCameraExplanationText) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
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(enableCameraExplanationText) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
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(enableCameraExplanationText) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
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.
- setFinderHeight(finderHeight) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Height of the finder window in pixels.
- setFinderHeight(finderHeight) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Height of the finder window in pixels.
- setFinderLineColor(finderLineColor) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Color of the finder window's outline.
- setFinderLineColor(finderLineColor) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Color of the finder window's outline.
- setFinderLineWidth(finderLineWidth) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Thickness of the finder window's outline.
- setFinderLineWidth(finderLineWidth) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Thickness of the finder window's outline.
- setFinderTextHint(finderTextHint) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Text hint shown under the finder window.
- setFinderTextHint(finderTextHint) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Text hint shown under the finder window.
- setFinderTextHintColor(finderTextHintColor) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Color of the text hint under the finder window.
- setFinderTextHintColor(finderTextHintColor) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Color of the text hint under the finder window.
- setFinderWidth(finderWidth) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Width of the finder window in pixels.
- setFinderWidth(finderWidth) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Width of the finder window in pixels.
- setFlashButtonHidden(flashButtonHidden) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Controls whether the flash toggle button is hidden or not.
- setFlashButtonTitle(flashButtonTitle) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Title of the flash toggle button.
- setFlashEnabled(flashEnabled) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Controls whether the flash should be initially enabled.
The default value is FALSE.
- setFlashEnabled(flashEnabled) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Controls whether the flash should be initially enabled.
The default value is FALSE.
- setFlashEnabled(flashEnabled) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Controls whether the flash should be initially enabled.
The default value is FALSE.
- setIgnoreBadAspectRatio(ignoreBadAspectRatio) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Sets whether to ignore the net.doo.snap.lib.detector.DetectionResult.OK_BUT_BAD_ASPECT_RATIO detection status.
By default BadAspectRatio is not ignored.
- setImageScale(imageScale) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
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.
- setMultiPageButtonHidden(multiPageButtonHidden) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Controls whether the multi-page toggle button is hidden or not.
- setMultiPageButtonTitle(multiPageButtonTitle) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Title of the multi-page mode toggle button.
- setMultiPageEnabled(multiPageEnabled) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
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.
- setOrientationLockMode(cameraOrientationMode) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Orientation lock mode of the camera: PORTRAIT or LANDSCAPE.
By default the camera orientation is not locked.
- setOrientationLockMode(cameraOrientationMode) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Orientation lock mode of the camera: PORTRAIT or LANDSCAPE.
By default the camera orientation is not locked.
- setOrientationLockMode(cameraOrientationMode) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Orientation lock mode of the camera: PORTRAIT or LANDSCAPE.
By default the camera orientation is not locked.
- setOverlayColor(overlayColor) - Method in class io.scanbot.sdk.ui.view.base.FinderOverlayView
-
Changes fill color of the Finder view
- setPage(page) - Method in class io.scanbot.sdk.ui.view.edit.configuration.CroppingConfiguration
-
The Page to be opened. This is a required parameter.
- setPageCounterButtonTitle(pageCounterButtonTitle) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
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.
- setPolygonBackgroundColor(polygonBackgroundColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
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).
- setPolygonBackgroundColorOK(polygonBackgroundColorOK) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The background color of the detected document outline when we are ready to snap net.doo.snap.lib.detector.DetectionResult.OK.
- setPolygonColor(polygonColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
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).
- setPolygonColor(color) - Method in class io.scanbot.sdk.ui.view.edit.configuration.CroppingConfiguration
-
Default color of the cropping outline.
- setPolygonColorMagnetic(color) - Method in class io.scanbot.sdk.ui.view.edit.configuration.CroppingConfiguration
-
Outline color of magnetically snapped edges.
- setPolygonColorOK(polygonColorOK) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The color of the detected document outline when we are ready to snap net.doo.snap.lib.detector.DetectionResult.OK.
- setPolygonLineWidth(polygonLineWidth) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Width of the detected document outline.
- setPolygonLineWidth(color) - Method in class io.scanbot.sdk.ui.view.edit.configuration.CroppingConfiguration
-
Width of the cropping outline.
- setRotateButtonTitle(text) - Method in class io.scanbot.sdk.ui.view.edit.configuration.CroppingConfiguration
-
Title of the Rotate button.
- setShutterButtonAutoInnerColor(shutterButtonAutoInnerColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The foreground color of the shutter button in auto-snapping mode.
- setShutterButtonAutoOuterColor(shutterButtonAutoOuterColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The background color of the shutter button in auto-snapping mode.
- setShutterButtonManualInnerColor(shutterButtonManualInnerColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The foreground color of the shutter button in manual mode.
- setShutterButtonManualOuterColor(shutterButtonManualOuterColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The background color of the shutter button in manual mode.
- setStrokeColor(strokeColor) - Method in class io.scanbot.sdk.ui.view.base.FinderOverlayView
-
Changes stroke color of the Finder view.
- setStrokeWidth(strokeWidth) - Method in class io.scanbot.sdk.ui.view.base.FinderOverlayView
-
Changes stroke width of the Finder view.
- setSuccessBeepEnabled(successBeepEnabled) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Controls whether to play a beep sound after a successful detection.
Default value is TRUE.
- setSuccessBeepEnabled(successBeepEnabled) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Controls whether to play a beep sound after a successful detection.
Default value is TRUE.
- setTextHintBadAngles(textBadAngles) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.OK_BUT_BAD_ANGLES
- setTextHintBadAspectRatio(textHintBadAspectRatio) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.OK_BUT_BAD_ASPECT_RATIO
- setTextHintNothingDetected(textHintNothingDetected) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.ERROR_NOTHING_DETECTED
- setTextHintOK(textHintDontMove) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.OK
- setTextHintTooDark(textHintTooDark) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.ERROR_TOO_DARK
- setTextHintTooNoisy(textHintTooNoisy) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.ERROR_TOO_NOISY
- setTextHintTooSmall(textHintTooSmall) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.OK_BUT_TOO_SMALL
- setTopBarBackgroundColor(topBarBackgroundColor) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Background color of the top toolbar.
- setTopBarBackgroundColor(topBarBackgroundColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The background color of the top toolbar.
- setTopBarBackgroundColor(color) - Method in class io.scanbot.sdk.ui.view.edit.configuration.CroppingConfiguration
-
Background color of the top toolbar.
- setTopBarBackgroundColor(topBarBackgroundColor) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Background color of the top toolbar.
- setTopBarButtonsActiveColor(topBarButtonsActiveColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The color of all active toggle buttons in the toolbar.
- setTopBarButtonsColor(topBarButtonsColor) - Method in class io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration
-
Color of the titles of all buttons in the top toolbar.
- setTopBarButtonsColor(color) - Method in class io.scanbot.sdk.ui.view.edit.configuration.CroppingConfiguration
-
Color of the titles of all buttons in the top toolbar (Cancel and Done buttons).
- setTopBarButtonsColor(topBarButtonsColor) - Method in class io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration
-
Color of the titles of all buttons in the top toolbar.
- setTopBarButtonsInactiveColor(topBarButtonsInactiveColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The color of all inactive toggle buttons in the toolbar.
- setUserGuidanceBackgroundColor(userGuidanceBackgroundColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The background color of the user guidance hints.
- setUserGuidanceTextColor(userGuidanceTextColor) - Method in class io.scanbot.sdk.ui.view.camera.configuration.DocumentScannerConfiguration
-
The text color of the user guidance hints.
- SNAPPED_PAGE_EXTRA - Static variable in class io.scanbot.sdk.ui.view.camera.DocumentScannerActivity
-