Custom settings

This page covers the description of custom settings

Contents

• Process Params

  • Multipage Processing

  • Display Formats

  • Logs

  • Scenario

  • Barcode Types

  • Filters

  • Detection

  • Uncropped Image

  • JSON

• Functionality

  • Camera Frame

  • Buttons

  • Detection

  • Orientation

  • Single Frame Capturing

• Customization

  • Camera Frame

  • Status Message

  • Result Status Message

  • Animation

  • Visual Elements

  • Skip Button

  • Loading Indicator

  • Background

• Version

• License

• RFID-chip

Process Params

Multipage Processing

Multipage processing allows to read more than one page. Turn on/off multipage:

Java

DocumentReader.Instance().processParams().multipageProcessing = true;

Kotlin

If multipage processing is enabled, the SDK processes the front side of the document recognizes document type and checks in the database how many pages are available for this document. If there are any child documents (second page, back side) for this document type, multipage processing is triggered. It concerns scenarios which recognize document type.

The only exception is MrzAndLocate and Locate scenarios. In this case, if SDK detects an ID1-sized document, it will ask for the second page. Multi-page processing is not triggered for documents of other formats.

Display Formats

You can change the format string of displayed dates in the results. Mask examples: "dd/mm/yyyy", "mm/dd/yyyy", "dd-mm-yyyy", "mm-dd-yyyy", "dd/mm/yy":

Java

DocumentReader.Instance().processParams().dateFormat = "dd-mm-yyyy";

Kotlin

If you want to change the measure system, use one of the RGLMeasureSystem members:

Java

DocumentReader.Instance().processParams().measureSystem = RGLMeasureSystem.METRIC;

Kotlin

Logs

If set, SDK logs will be written to the logcat:

Java

DocumentReader.Instance().processParams().setLogs(true);

Kotlin

If set, logs will be saved (in case of reading problems). Turn on/off logs saving:

Java

DocumentReader.Instance().processParams().debugSaveLogs = true;

Kotlin

If set, input images will be saved (in case of reading problems). Turn on/off images saving:

Java

DocumentReader.Instance().processParams().debugSaveImages = true;

Kotlin

If set, input images will be cropped and saved. Turn on/off image saving:

Java

DocumentReader.Instance().processParams().debugSaveCroppedImages = true;

Kotlin

Allows you to get the path to the folder of the current session. Before using this, enable save logs. Each new session provides different path:

Java

DocumentReader.Instance().processParams().sessionLogFolder

Kotlin

Scenario

Set proper scenario. You can find information of how to get available scenarios here:

Java

DocumentReader.Instance().processParams().scenario = "Barcode";

Kotlin

You can assign a scenario to the Capture button. This scenario will be used if you press the button:

Java

DocumentReader.Instance().processParams().captureButtonScenario = "Locate";

Kotlin

Barcode Types

Set the types of barcodes that you wish to process:

Java

DocumentReader.Instance().processParams().doBarcodes = new String[]{BarcodeType.valueOf(BarcodeType.PDF417), BarcodeType.valueOf(BarcodeType.QRCODE)};

Kotlin

Filters

Set the list of the document ID's to process. All documents will be processed, if empty:

Java

DocumentReader.Instance().processParams().documentIDList = new int[]{-274257313, -2004898043};

Kotlin

If you read document which contains MRZ, all fields will be extracted. If you read document with OCR, you can set the list of field types that you wish to extract, other fields will be skipped during processing. All fields will be extracted, if the fieldTypesFilter is empty:

Java

DocumentReader.Instance().processParams().fieldTypesFilter = new int[]{eVisualFieldType.FT_DATE_OF_EXPIRY};

Kotlin

Detection

If you enable this parameter, document focus check will be omitted:

Java

DocumentReader.Instance().processParams().disableFocusingCheck = false;

Kotlin

Uncropped Image

If set, an original (uncropped) image will be received, which is sent to Core for processing:

Java

DocumentReader.Instance().processParams().returnUncroppedImage = true;

Kotlin

JSON

Allows to transfer custom JSON to Core, which should be processed:

Java

DocumentReader.Instance().processParams().customParams = new JSONObject("{\"key\":\"value\"}");

Kotlin

Functionality

Camera Frame

Set this setting to override default cropping frame on camera activity provided by scenario using one of DocReaderFrame members:

Java

DocumentReader.Instance().functionality().setCameraFrame(DocReaderFrame.MAX);

Kotlin

Frame is cropped by camera frame. If you set the camera frame to full screen, Core will crop frame by phone borders. Using this setting may lead to lower performance because of huge frame size. Any changes which are connected with camera frame alter scanning process. You can also set the camera frame width.

Buttons

Show/hide torch button:

Java

DocumentReader.Instance().functionality().setShowTorchButton(true);

Kotlin

Show/hide close button:

Java

DocumentReader.Instance().functionality().setShowCloseButton(true);

Kotlin

You can close camera view manually by using DocumentReader.Instance().stopScanner() function.

Capture allows to take picture and process as a single frame. Show/hide capture button:

Java

DocumentReader.Instance().functionality().setShowCaptureButton(true);

Kotlin

You can set the time interval when Capture button should be displayed after the document is detected. 5 seconds is used by default:

Java

DocumentReader.Instance().functionality().setShowCaptureButtonDelayFromDetect(5);

To use this setting you should enable the setShowCaptureButton() parameter.

Kotlin

You can set the time interval when Capture button should be displayed after the scanning process is started. 10 seconds is used by default:

Java

DocumentReader.Instance().functionality().setShowCaptureButtonDelayFromStart(10);

To use this setting you should enable the setShowCaptureButton() parameter.

Kotlin

If set, frame expanding button will be shown on video capture screen. Show/hide change frame button:

Java

DocumentReader.Instance().functionality().setShowChangeFrameButton(true);

Kotlin

Show/hide skip next page button:

Java

DocumentReader.Instance().functionality().setShowSkipNextPageButton(true);

Kotlin

Show/hide the button for switching between cameras during processing:

Java

DocumentReader.Instance().functionality().setShowCameraSwitchBtn(true);

Kotlin

Detection

DocumentReader will receive data from Motion Sensor and pause scanning when device is moving. Turn on/off video capture motion control:

Java

DocumentReader.Instance().functionality().setVideoCaptureMotionControl(true);

Kotlin

If set, scanning will be paused while camera is focusing (it can decrease camera processing speed):

Java

DocumentReader.Instance().functionality().setSkipFocusingFrames(true);

Kotlin

Orientation

Defines orientation of activities by using one of DocReaderOrientation members:

Java

DocumentReader.Instance().functionality().setOrientation(DocReaderOrientation.PORTRAIT);

Kotlin

Single Frame Capturing

If set, as soon as document is located during video mode, picture will be taken and processed as single frame. It is used for devices with poor-quality video preview:

Java

DocumentReader.Instance().functionality().setPictureOnBoundsReady(true);

Kotlin

Customization

Camera Frame

Set thickness of document bounds border on the video preview (dp):

Java

DocumentReader.Instance().customization().setCameraFrameBorderWidth(5);

Kotlin

Hex string of document bounds border color in default state:

Java

DocumentReader.Instance().customization().setCameraFrameDefaultColor("#ff0000");

Kotlin

Hex string of document bounds border color in document detected state:

Java

DocumentReader.Instance().customization().setCameraFrameActiveColor("#c300ff");

Kotlin

Defines the shape of document bounds border. Use one of FrameShapeType members:

Java

DocumentReader.Instance().customization().setCameraFrameShapeType(FrameShapeType.CORNER);

Kotlin

Defines the length (dp) of the corner side in shape mode FrameShapeType.CORNER:

Java

DocumentReader.Instance().customization().setCameraFrameLineLength(50);

Kotlin

Frame is cropped by camera frame. Any changes with camera frame may alter scanning process. You can change the default camera frame view, even remove it. Discover Functionality page to find out how to do it.

Status Message

Set a status message next to the frame:

Java

DocumentReader.Instance().customization().setStatus("Hello");

Kotlin

Turn on/off status message:

Java

DocumentReader.Instance().customization().setShowStatusMessages(true);

Kotlin

Set the text font for the status message, so-called hint message:

Java

DocumentReader.Instance().customization().setStatusTextFont(Typeface.SERIF);

Kotlin

Size of main text status (sp):

Java

DocumentReader.Instance().customization().setStatusTextSize(14);

Kotlin

Hex string of main text status color:

Java

DocumentReader.Instance().customization().setStatusTextColor("#ff0000");

Kotlin

Allows you to change the location of the status. For example, if you set the multiplier to 0.5 and the number of pixels by vertical is equal to 800, your message will be centralized and located at 200 px from top, i.e. (800 / 2) * 0.5 = 200 px. If multiplier is equal to 1, the message will be centered. If multiplier is equal to zero, default location will be used:

Java

DocumentReader.Instance().customization().setStatusPositionMultiplier(0.5D);

Kotlin

Result Status Message

Set a result status message next to the frame:

Java

DocumentReader.Instance().customization().setResultStatus("Hello");

Kotlin

Turn on/off result status message:

Java

DocumentReader.Instance().customization().setShowResultStatusMessages(true);

Kotlin

Set the text font for the current status:

Java

DocumentReader.Instance().customization().setResultStatusTextFont(Typeface.SERIF);

Kotlin

Set the size of current text status (sp):

Java

DocumentReader.Instance().customization().setResultStatusTextSize(14);

Kotlin

Hex string of current text status color:

Java

DocumentReader.Instance().customization().setResultStatusTextColor("#ff0000");

Kotlin

Hex string of current text status background color:

Java

DocumentReader.Instance().customization().setResultStatusBackgroundColor("#ff0000");

Kotlin

Allows you to change the location of the results status. For example, if you set the multiplier to 0.5 and the number of pixels by vertical is equal to 800, your message will be centralized and located at 200 px from top, i.e. (800 / 2) * 0.5 = 200 px. If multiplier is equal to 1, the message will be centered. If multiplier is equal to zero, default location will be used:

Java

DocumentReader.Instance().customization().setResultStatusPositionMultiplier(0.5D);

Kotlin

Animation

If set, animation showing how to position document will be displayed. Show/hide help animation:

Java

DocumentReader.Instance().customization().setShowHelpAnimation(true);

Kotlin

You can set image for the help animation. If not set, default image will be used:

Java

DocumentReader.Instance().customization().setHelpAnimationImageID(R.drawable.icon);

Kotlin

Allows to change the scaling of the help animation image, use one of ImageView.ScaleType members:

Java

DocumentReader.Instance().customization().setHelpAnimationImageScaleType(ImageView.ScaleType.MATRIX);
Matrix matrix = new Matrix();
DocumentReader.Instance().customization().setHelpAnimationImageMatrix(matrix);

Kotlin

If set, expecting page turn animation will be shown. Turn on/off next page animation:

Java

DocumentReader.Instance().customization().setShowNextPageAnimation(true);

Kotlin

You can set front image for the multipage animation. If not set, default image will be used:

Java

DocumentReader.Instance().customization().setMultipageAnimationFrontImage(R.drawable.icon);

Kotlin

Allows to change the scaling of front image of the multipage animation, use one of ImageView.ScaleType members:

Java

DocumentReader.Instance().customization().setMultipageAnimationFrontImageScaleType(ImageView.ScaleType.MATRIX);
Matrix matrix = new Matrix();
DocumentReader.Instance().customization().setMultipageAnimationFrontImageMatrix(matrix);

Kotlin

You can set back image for the multipage animation. If not set, default image will be used:

Java

DocumentReader.Instance().customization().setMultipageAnimationBackImage(R.drawable.icon);

Kotlin

Allows to change the scaling of back image of the multipage animation, use one of ImageView.ScaleType members:

Java

DocumentReader.Instance().customization().setMultipageAnimationBackImageScaleType(ImageView.ScaleType.MATRIX);
Matrix matrix = new Matrix();
DocumentReader.Instance().customization().setMultipageAnimationBackImageMatrix(matrix);

Kotlin

Visual Elements

Hex string of visual elements color (one for all):

Java

DocumentReader.Instance().customization().setTintColor("#ff0000");

Kotlin

Skip Button

Set the background color to the multipage button:

Java

DocumentReader.Instance().customization().setMultipageButtonBackgroundColor("#ff0000");

Kotlin

Loading Indicator

Hex string of loading indicator(s) color. You can see it if you press the capture button:

Java

DocumentReader.Instance().customization().setActivityIndicatorColor("#ff0000");

Kotlin

Background

If set, background will be darkened around the document detection frame. Show/hide background mask:

Java

DocumentReader.Instance().customization().setShowBackgroundMask(true);

Kotlin

Allows to change the intensity of the background mask:

Java

DocumentReader.Instance().customization().setBackgroundMaskAlpha(0.5F);

Kotlin

Allows to set image within camera frame:

Java

DocumentReader.Instance().customization().setBorderBackgroundImage(R.drawable.icon);

Kotlin

Version

To get the API version use:

Java

DocumentReader.Instance().version.api

Kotlin

To get the Core version use:

Java

DocumentReader.Instance().version.core

Kotlin

To get the Core mode use:

Java

DocumentReader.Instance().version.coreMode

Kotlin

Allows you to get database id, e.g. KAZ:

Java

DocumentReader.Instance().version.database.databaseID

Kotlin

To get the database version use:

Java

DocumentReader.Instance().version.database.version

Kotlin

Allows you to get the database export date:

Java

DocumentReader.Instance().version.database.date

Kotlin

To get the list of supported database documents use:

Java

DocumentReader.Instance().version.database.databaseDescription

Kotlin

Allows to get the number of supported database countries:

Java

DocumentReader.Instance().version.database.countriesNumber

Kotlin

Allows to get the number of supported database documents:

Java

DocumentReader.Instance().version.database.documentsNumber

Kotlin

License

Allows to get an expiration date of the license:

Java

DocumentReader.Instance().licenseResult().license().getExpiryDate()

Kotlin

Allows to get a list of country identifiers which are defined for processing in the license. If the array is empty, there are no restrictions for processing:

Java

DocumentReader.Instance().licenseResult().license().getCountryFilter()

Kotlin

RFID-chip

RFID-chip reading parameters:

Java

DocumentReader.Instance().rfidScenario()

Kotlin