io.scanbot.sdk.ui.view.mrz.configuration

Class MRZScannerConfiguration

io.scanbot.sdk.ui.view.mrz.configuration.MRZScannerConfiguration

public class MRZScannerConfiguration

Class which is used to configure io.scanbot.sdk.ui.view.mrz.MRZScannerActivity Contains settings indicating views Behaviour, Texts and Appearance

See Also:

io.scanbot.sdk.ui.view.mrz.MRZScannerActivity

Constructor Detail

MRZScannerConfiguration

public MRZScannerConfiguration()

Class which is used to configure io.scanbot.sdk.ui.view.mrz.MRZScannerActivity Contains settings indicating views Behaviour, Texts and Appearance

See Also:

io.scanbot.sdk.ui.view.mrz.MRZScannerActivity

Method Detail

getMrzCameraConfiguration

@NotNull
public java.util.Map<java.lang.String,java.io.Serializable> getMrzCameraConfiguration()

setFlashEnabled

public void setFlashEnabled(boolean flashEnabled)

Controls whether the flash should be initially enabled. The default value is FALSE.

setOrientationLockMode

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.

setCameraModule

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.

setSuccessBeepEnabled

public void setSuccessBeepEnabled(boolean successBeepEnabled)

Controls whether to play a beep sound after a successful detection. Default value is TRUE.

setTopBarBackgroundColor

public void setTopBarBackgroundColor(int topBarBackgroundColor)

Background color of the top toolbar.

setTopBarButtonsColor

public void setTopBarButtonsColor(int topBarButtonsColor)

Color of the titles of all buttons in the top toolbar.

setCameraOverlayColor

public void setCameraOverlayColor(int cameraOverlayColor)

Background color outside of the finder window.

setFinderAspectRatio

public void setFinderAspectRatio(@NotNull
                                 io.scanbot.sdk.ui.camera.FinderAspectRatio finderAspectRatio)

Aspect ratio of the finder window.

setFinderLineWidth

public void setFinderLineWidth(int finderLineWidth)

Thickness of the finder window's outline.

setFinderLineColor

public void setFinderLineColor(int finderLineColor)

Color of the finder window's outline.

setFinderTextHintColor

public void setFinderTextHintColor(int finderTextHintColor)

Color of the text hint under the finder window.

setCancelButtonTitle

public void setCancelButtonTitle(@NotNull
                                 java.lang.String cancelButtonTitle)

Title of the cancel button.

setFinderTextHint

public void setFinderTextHint(@NotNull
                              java.lang.String finderTextHint)

Text hint shown under the finder window.

setEnableCameraExplanationText

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.

setEnableCameraButtonTitle

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.

setUseButtonsAllCaps

public void setUseButtonsAllCaps(boolean allCaps)

Controls whether buttons should use all capitals style