Custom settings
This page covers the description of customizable settings
Contents
Process Params
Multipage Processing
Multipage processing allows to read more than one page. Turn on/off multipage:
Date Format
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":
Logs
If set, Core logs will be written to logcat:
If set, deep logs will be saved (in case of reading problems). Turn on/off logs saving:
If set, input images will be saved (in case of reading problems). Turn on/off images saving:
If set, input images will be cropped and saved. Turn on/off image saving:
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:
Scenario
Set proper scenario. You can find information of how to get available scenarios here:
Barcode Types
Set the types of barcodes that you wish to process:
RFID-chip
RFID-chip reading parameters:
Filters
Set the list of the document ID's to process. All documents will be processed, if empty:
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:
Detection
If you enable this parameter, document focus check will be omitted:
Functionality
Camera Frame
Set this setting to override default cropping frame on camera activity provided by scenario using one of DocReaderFrame members:
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:
Show/hide close button:
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:
If set, frame expanding button will be shown on video capture screen. Show/hide change frame button:
Show/hide skip next page button:
Show/hide the button for switching between cameras during processing:
Detection
DocumentReader will receive data from Motion Sensor and pause scanning when device is moving. Turn on/off video capture motion control:
If set, scanning will be paused while camera is focusing (it can decrease camera processing speed):
Orientation
Defines orientation of activities by using one of DocReaderOrientation members:
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:
Customization
Camera Frame
Set thickness of document bounds border on the video preview (dp):
Hex string of document bounds border color in default state:
Hex string of document bounds border color in document detected state:
Defines the shape of document bounds border. Use one of FrameShapeType members:
Defines the length (dp) of the corner side in shape mode FrameShapeType.CORNER:
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:
Turn on/off status message:
Set the text font for the status message, so-called hint message:
Size of main text status (sp):
Hex string of main text status color:
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:
Result Status Message
Turn on/off result status message:
Set the text font for the current status:
Set the size of current text status (sp):
Hex string of current text status color:
Hex string of current text status background color:
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:
Animation
If set, animation showing how to position document will be displayed. Show/hide help animation:
If set, expecting page turn animation will be shown. Turn on/off next page animation:
You can set image for help animation. If not set, default image will be used:
You can set front image for multipage animation. If not set, default image will be used:
You can set back image for multipage animation. If not set, default image will be used:
Visual Elements
Hex string of visual elements color (one for all):
Skip Button
Set the background color to the multipage button:
Loading Indicator
Hex string of loading indicator(s) color. You can see it if you press the capture button:
Background
If set, background will be darkened around the document detection frame. Show/hide background mask:
Allows to set image within camera frame:
Version
To get the API version use:
To get the Core version use:
To get the Core mode use:
Allows you to get database id, e.g. KAZ:
To get the database version use:
Allows you to get the database export date:
To get the list of supported database documents use:
Allows to get the number of supported database countries:
Allows to get the number of supported database documents:
Last updated
