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) Camera appearance param. Color of the alpha transparent layer on the camera view.
void	setCancelButtonTitle(java.lang.String cancelButtonTitle) Camera texts param. Cancel button text.
void	setEnableCameraButtonTitle(java.lang.String enableCameraButtonTitle) Camera texts param Sets camera permission button text
void	setEnableCameraExplanationText(java.lang.String enableCameraExplanationText) Camera texts param Sets camera permission description text
void	setFinderHeight(int finderHeight) Camera appearance param. Height of Finder window
void	setFinderLineColor(int finderLineColor) Camera appearance param. Finder line color.
void	setFinderLineWidth(int finderLineWidth) Camera appearance param. Finder line thickness.
void	setFinderTextHint(java.lang.String finderTextHint) Camera texts param. User finder text hint.
void	setFinderTextHintColor(int finderTextHintColor) Camera appearance param. Finder text hint color.
void	setFinderWidth(int finderWidth) Camera appearance param. Width of Finder window.
void	setFlashEnabled(boolean flashEnabled) Camera behaviour param. Set flash mode for camera active by default if flashEnabled true, inactive otherwise Optional, default value is FALSE.
void	setOrientationLockMode(CameraOrientationMode cameraOrientationMode) Camera behaviour param. Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. Optional, by default camera orientation is not locked.
void	setSuccessBeepEnabled(boolean successBeepEnabled) Camera behaviour param. Play a beep tone on success. Optional, default value is TRUE.
void	setTopBarBackgroundColor(int topBarBackgroundColor) Camera appearance param. Background color of the top toolbar.
void	setTopBarButtonsColor(int topBarButtonsColor) Camera appearance param. Color 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)

Camera behaviour param. Set flash mode for camera active by default if flashEnabled true, inactive otherwise Optional, default value is FALSE.

setOrientationLockMode

public void setOrientationLockMode(CameraOrientationMode cameraOrientationMode)

Camera behaviour param. Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. Optional, by default camera orientation is not locked.

setSuccessBeepEnabled

public void setSuccessBeepEnabled(boolean successBeepEnabled)

Camera behaviour param. Play a beep tone on success. Optional, default value is TRUE.

setTopBarBackgroundColor

public void setTopBarBackgroundColor(int topBarBackgroundColor)

Camera appearance param. Background color of the top toolbar.

setTopBarButtonsColor

public void setTopBarButtonsColor(int topBarButtonsColor)

Camera appearance param. Color of all buttons in the top toolbar.

setCameraOverlayColor

public void setCameraOverlayColor(int cameraOverlayColor)

Camera appearance param. Color of the alpha transparent layer on the camera view.

setFinderWidth

public void setFinderWidth(int finderWidth)

Camera appearance param. Width of Finder window.

setFinderHeight

public void setFinderHeight(int finderHeight)

Camera appearance param. Height of Finder window

setFinderLineWidth

public void setFinderLineWidth(int finderLineWidth)

Camera appearance param. Finder line thickness.

setFinderLineColor

public void setFinderLineColor(int finderLineColor)

Camera appearance param. Finder line color.

setFinderTextHintColor

public void setFinderTextHintColor(int finderTextHintColor)

Camera appearance param. Finder text hint color.

setCancelButtonTitle

public void setCancelButtonTitle(java.lang.String cancelButtonTitle)

Camera texts param. Cancel button text.

setFinderTextHint

public void setFinderTextHint(java.lang.String finderTextHint)

Camera texts param. User finder text hint.

setEnableCameraExplanationText

public void setEnableCameraExplanationText(java.lang.String enableCameraExplanationText)

Camera texts param Sets camera permission description text

setEnableCameraButtonTitle

public void setEnableCameraButtonTitle(java.lang.String enableCameraButtonTitle)

Camera texts param Sets camera permission button text