public class MultipleObjectsDetectorConfiguration
Class which is used to configure io.scanbot.sdk.ui.view.multiple_objects.MultipleObjectsDetectorActivity Contains settings indicating views Behaviour, Texts and Appearance
public MultipleObjectsDetectorConfiguration()
Class which is used to configure io.scanbot.sdk.ui.view.multiple_objects.MultipleObjectsDetectorActivity Contains settings indicating views Behaviour, Texts and Appearance
@NotNull public java.util.Map<java.lang.String,java.io.Serializable> getCameraConfiguration()
public void setFlashEnabled(boolean flashEnabled)
Controls whether the flash should be initially enabled. The default value is FALSE.
public void setBatchModeEnabled(boolean batchModeEnabled)
Controls batch mode. When enabled, the user can snap multiple times before closing the screen by tapping the snapped objects counter button. When disabled, the screen will be closed immediately after the first snap was made. The default value is FALSE.
public void setMaxNumberOfPages(int maxNumberOfPages)
Defines max number of scanned pages. This parameter works only if the “multipage” feature is enabled. Once the number of scanned pages was reached, the Document Scanner will be closed.
public void setCameraPreviewMode(@NotNull
io.scanbot.sdk.camera.CameraPreviewMode cameraPreviewMode)
Preview mode of the camera: Fit-In or Fill-In. Optional, default is Fit-In.
public void setOrientationLockMode(@NotNull
io.scanbot.sdk.ui.view.base.configuration.CameraOrientationMode cameraOrientationMode)
Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. By default the camera orientation is not locked.
public void setCameraModule(@NotNull
io.scanbot.sdk.camera.CameraModule cameraModule)
Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others. Optional. By default is CameraModule.BACK.
public void setShutterButtonOuterColor(@ColorInt
int shutterButtonOuterColor)
The background color of the shutter button.
public void setShutterButtonInnerColor(@ColorInt
int shutterButtonInnerColor)
The foreground color of the shutter button.
public void setShutterSoundEnabled(boolean shutterSoundEnabled)
Set camera shutter sound state. true if a sound should be played when taking a picture, false - otherwise
By default, the camera plays the system-defined camera shutter sound when taking a picture.
shutterSoundEnabled - if shutter sound should be enabledpublic void setTopBarBackgroundColor(@ColorInt
int topBarBackgroundColor)
The background color of the top toolbar.
public void setTopBarButtonsActiveColor(@ColorInt
int topBarButtonsActiveColor)
The color of all active toggle buttons in the toolbar.
public void setTopBarButtonsInactiveColor(@ColorInt
int topBarButtonsInactiveColor)
The color of all inactive toggle buttons in the toolbar.
public void setBottomBarBackgroundColor(@ColorInt
int bottomBarBackgroundColor)
The background color of the bottom shutter-bar.
public void setBottomBarButtonsColor(@ColorInt
int bottomBarButtonsColor)
The color of the title of all buttons in the bottom shutter-bar (Cancel button, etc.), as well as the camera permission prompt button.
public void setCameraBackgroundColor(@ColorInt
int cameraBackgroundColor)
The color of the camera background (relevant only when the camera preview mode is CameraPreviewMode.FIT_IN).
public void setBatchButtonHidden(boolean batchButtonHidden)
Controls whether the batch toggle button is hidden or not.
public void setFlashButtonHidden(boolean flashButtonHidden)
Controls whether the flash toggle button is hidden or not.
public void setCancelButtonTitle(@NotNull
java.lang.String cancelButtonTitle)
Title of the cancel button.
public void setPageCounterButtonTitle(@NotNull
java.lang.String pageCounterButtonTitle)
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.
public void setBatchButtonTitle(@NotNull
java.lang.String batchButtonTitle)
Title of the batch mode toggle button.
public void setFlashButtonTitle(@NotNull
java.lang.String flashButtonTitle)
Title of the flash toggle button.
public void setEnableCameraExplanationText(@NotNull
java.lang.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.
public void setEnableCameraButtonTitle(@NotNull
java.lang.String enableCameraButtonTitle)
Title of the button that opens the screen where the user can allow the usage of the camera by the app.
public void setAspectRatioRange(@NotNull
io.scanbot.sdk.ui.view.multiple_objects.configuration.MultipleObjectsDetectorConfiguration.AspectRatioRange aspectRatioRange)
Set qualifying objects aspect ratio range. See MultipleObjectsDetector.Params
public void setUseButtonsAllCaps(boolean allCaps)
Controls whether buttons should use all capitals style