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 class MRZScannerActivity Contains settings indicating views Behaviour, Texts and Appearance

See Also:

class MRZScannerActivity

Constructor Summary

Constructors

Constructor and Description
MRZScannerConfiguration() Class which is used to configure class MRZScannerActivity Contains settings indicating views Behaviour, Texts and Appearance

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.io.Serializable>	getMrzCameraConfiguration()
void	setCameraOverlayColor(int cameraOverlayColor) Background color outside of the finder window.
void	setCancelButtonTitle(java.lang.String cancelButtonTitle) Title of the cancel button.
void	setEnableCameraButtonTitle(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.
void	setEnableCameraExplanationText(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.
void	setFinderHeight(int finderHeight) Height of the finder window in pixels.
void	setFinderLineColor(int finderLineColor) Color of the finder window's outline.
void	setFinderLineWidth(int finderLineWidth) Thickness of the finder window's outline.
void	setFinderTextHint(java.lang.String finderTextHint) Text hint shown under the finder window.
void	setFinderTextHintColor(int finderTextHintColor) Color of the text hint under the finder window.
void	setFinderWidth(int finderWidth) Width of the finder window in pixels.
void	setFlashEnabled(boolean flashEnabled) Controls whether the flash should be initially enabled. The default value is FALSE.
void	setOrientationLockMode(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.
void	setSuccessBeepEnabled(boolean successBeepEnabled) Controls whether to play a beep sound after a successful detection. Default value is TRUE.
void	setTopBarBackgroundColor(int topBarBackgroundColor) Background color of the top toolbar.
void	setTopBarButtonsColor(int topBarButtonsColor) Color of the titles of all buttons in the top toolbar.

Constructor Detail

MRZScannerConfiguration

public MRZScannerConfiguration()

Class which is used to configure class MRZScannerActivity Contains settings indicating views Behaviour, Texts and Appearance

See Also:

class MRZScannerActivity

Method Detail

getMrzCameraConfiguration

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(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.

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.

setFinderWidth

public void setFinderWidth(int finderWidth)

Width of the finder window in pixels.

setFinderHeight

public void setFinderHeight(int finderHeight)

Height of the finder window in pixels.

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(java.lang.String cancelButtonTitle)

Title of the cancel button.

setFinderTextHint

public void setFinderTextHint(java.lang.String finderTextHint)

Text hint shown under the finder window.

setEnableCameraExplanationText

public void setEnableCameraExplanationText(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(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.