Custom settings

This page covers the description of custom settings

Contents

Process Params

Document processing

Multipage processing

Allows to process more than one page of the document (if they are exist) for several iterations:

Swift
Objective-C
Swift
DocReader.shared.processParams.multipageProcessing = true
Objective-C
[RGLDocReader shared].processParams.multipageProcessing = YES;

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.

Double-page spread processing

Allows to process up to two pages of the document (so-called "a double-page spread") for one-shot if they are presented on the frame (image):

This option is available for the following scenarios: DocType, Ocr, FullProcess, MrzOrBarcodeOrOcr, MrzOrOcr, LocateVisual_And_MrzOrOcr.

Swift
Objective-C
Swift
DocReader.shared.processParams.doublePageSpread = true
Objective-C
[RGLDocReader shared].processParams.doublePageSpread = YES;

Authenticity

Allows you to define whether a document's holograms have to be checked:

Swift
Objective-C
Swift
DocReader.shared.processParams.checkHologram = true
Objective-C
[RGLDocReader shared].processParams.checkHologram = YES;

Timeouts

Allows you to set the time limit for document recognition (in seconds), beyond which the recognition does not continue regardless of its result. The countdown starts from the moment the scenario starts:

Swift
Objective-C
Swift
DocReader.shared.processParams.timeout = 20
Objective-C
[RGLDocReader shared].processParams.timeout = 20;

Allows you to set the time limit for document recognition (in seconds), beyond which the recognition does not continue regardless of its result. The countdown starts from the moment the document is detected:

Swift
Objective-C
Swift
DocReader.shared.processParams.timeoutFromFirstDetect = 5
Objective-C
[RGLDocReader shared].processParams.timeoutFromFirstDetect = 5;

Allows you to set the time limit for document recognition (in seconds), beyond which the recognition does not continue regardless of its result. The countdown starts from the moment the document type is recognized:

Swift
Objective-C
Swift
DocReader.shared.processParams.timeoutFromFirstDocType = 3
Objective-C
[RGLDocReader shared].processParams.timeoutFromFirstDocType = 3;

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":

Swift
Objective-C
Swift
DocReader.shared.processParams.dateFormat = "dd-mm-yyyy"
Objective-C
[RGLDocReader shared].processParams.dateFormat = @"dd-mm-yyyy";

Allows you to change the measure system:

Swift
Objective-C
Swift
DocReader.shared.processParams.measureSystem = MeasureSystem.metric
Objective-C
[RGLDocReader shared].processParams.measureSystem = RGLMeasureSystemMetric;

Logs

If set, Core logs will be written to the console:

Swift
Objective-C
Swift
DocReader.shared.processParams.logs = true
Objective-C
[RGLDocReader shared].processParams.logs = YES;

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

Swift
Objective-C
Swift
DocReader.shared.processParams.debugSaveLogs = true
Objective-C
[RGLDocReader shared].processParams.debugSaveLogs = YES;

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

Swift
Objective-C
Swift
DocReader.shared.processParams.debugSaveImages = true
Objective-C
[RGLDocReader shared].processParams.debugSaveImages = YES;

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

Swift
Objective-C
Swift
DocReader.shared.processParams.debugSaveCroppedImages = true
Objective-C
[RGLDocReader shared].processParams.debugSaveCroppedImages = YES;

Allows to save RFID session data to the file in binary format:

Swift
Objective-C
Swift
DocReader.shared.processParams.debugSaveRFIDSession = true
Objective-C
[RGLDocReader shared].processParams.debugSaveRFIDSession = YES;

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:

Swift
Objective-C
Swift
DocReader.shared.processParams.sessionLogFolder
Objective-C
[RGLDocReader shared].processParams.sessionLogFolder

Scenario

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

Swift
Objective-C
Swift
DocReader.shared.processParams.scenario = RGL_SCENARIO_BARCODE
Objective-C
[RGLDocReader shared].processParams.scenario = RGL_SCENARIO_BARCODE;

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

Swift
Objective-C
Swift
DocReader.shared.processParams.captureButtonScenario = RGL_SCENARIO_LOCATE
Objective-C
[RGLDocReader shared].processParams.captureButtonScenario = RGL_SCENARIO_LOCATE;

Barcode types

Set the types of barcodes that you wish to process:

Swift
Objective-C
Swift
DocReader.shared.processParams.barcodeTypes = [BarcodeType.QRCODE.rawValue, BarcodeType.AZTEC.rawValue]
Objective-C
[RGLDocReader shared].processParams.barcodeTypes = @[[NSNumber numberWithInteger:RGLBarcodeTypeQRCODE], [NSNumber numberWithInteger:RGLBarcodeTypeAZTEC]];

There are documents that contain barcodes which data can be parsed only if document type verification is performed. The following property allows setting the barcode parser type which should be used during recognition. It allows parsing barcode data without performing document type verification:

Swift
Objective-C
Swift
DocReader.shared.processParams.barcodeParserType = 123
Objective-C
[RGLDocReader shared].processParams.barcodeParserType = 123;

Filters

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

Swift
Objective-C
Swift
DocReader.shared.processParams.documentIDList = [-274257313, -2004898043]
Objective-C
[RGLDocReader shared].processParams.documentIDList = @[[NSNumber numberWithInteger:-274257313], [NSNumber numberWithInteger:-2004898043]];

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:

Swift
Objective-C
Swift
DocReader.shared.processParams.fieldTypesFilter = [FieldType.ft_Date_of_Expiry.rawValue]
Objective-C
[RGLDocReader shared].processParams.fieldTypesFilter = @[[NSNumber numberWithInteger:RGLFieldTypeFt_Date_of_Expiry]];

Detection

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

Swift
Objective-C
Swift
DocReader.shared.processParams.disableFocusingCheck = true
Objective-C
[RGLDocReader shared].processParams.disableFocusingCheck = YES;

Allows you to set the maximum value of the deviation of the corners of the document from the value of 90 degrees:

Swift
Objective-C
Swift
DocReader.shared.processParams.perspectiveAngle = 5
Objective-C
[RGLDocReader shared].processParams.perspectiveAngle = 5;

Output images

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

Swift
Objective-C
Swift
DocReader.shared.processParams.returnUncroppedImage = true
Objective-C
[RGLDocReader shared].processParams.returnUncroppedImage = YES;

Allows to build an integral image, taking into account the quality of fixation of each of the individual images:

Swift
Objective-C
Swift
DocReader.shared.processParams.integralImage = true
Objective-C
[RGLDocReader shared].processParams.integralImage = YES;

Allows you to set the minimum acceptable DPI value:

Swift
Objective-C
Swift
DocReader.shared.processParams.minDPI = 100
Objective-C
[RGLDocReader shared].processParams.minDPI = 100;

If set, an image with cropped barcode will be returned:

Swift
Objective-C
Swift
DocReader.shared.processParams.returnCroppedBarcode = true
Objective-C
[RGLDocReader shared].processParams.returnCroppedBarcode = YES;

Custom params

Allows you to set a custom JSON which should be processed along with other process params:

Swift
Objective-C
Swift
// allows you to depersonalize the document's data
let data = [["allTextFields": true], ["allGraphicFields": true]]
DocReader.shared.processParams.customParams = ["dePersonalize": data]
// allows you to set the maximum DPI for an output image (if set to zero, an image won't be resized):
DocReader.shared.processParams.customParams = ["imageDpiOutMax": 0]
Objective-C
// allows you to depersonalize the document's data
NSArray *data = @[@{@"allTextFields": @YES}, @{@"allGraphicFields": @YES}];
[RGLDocReader shared].processParams.customParams = @{@"dePersonalize": data};
// allows you to set the maximum DPI for an output image (if set to zero, an image won't be resized):
[RGLDocReader shared].processParams.customParams = @{@"imageDpiOutMax": @0};

Bounds

Allows you to manually set the document's bounds:

Swift
Objective-C
Swift
DocReader.shared.processParams.manualCrop = true
Objective-C
[RGLDocReader shared].processParams.manualCrop = YES;

Functionality

Camera Frame

Set this setting to override default cropping frame on camera activity provided by scenario:

Swift
Objective-C
Swift
DocReader.shared.functionality.cameraFrame = DocReaderFrame.max
Objective-C
[RGLDocReader shared].functionality.cameraFrame = RGLDocReaderFrameMax;

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:

Swift
Objective-C
Swift
DocReader.shared.functionality.showTorchButton = true
Objective-C
[RGLDocReader shared].functionality.showTorchButton = YES;

Show/hide close button:

Swift
Objective-C
Swift
DocReader.shared.functionality.showCloseButton = true
Objective-C
[RGLDocReader shared].functionality.showCloseButton = YES;

You can close camera view manually using DocReader.shared.stopScanner() function.

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

Swift
Objective-C
Swift
DocReader.shared.functionality.showCaptureButton = true
Objective-C
[RGLDocReader shared].functionality.showCaptureButton = YES;

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

Swift
Objective-C
Swift
DocReader.shared.functionality.showCaptureButtonDelayFromDetect = 5
Objective-C
[RGLDocReader shared].functionality.showCaptureButtonDelayFromDetect = 5;

To use this setting you should enable the showCaptureButton parameter.

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

Swift
Objective-C
Swift
DocReader.shared.functionality.showCaptureButtonDelayFromStart = 10
Objective-C
[RGLDocReader shared].functionality.showCaptureButtonDelayFromStart = 10;

To use this setting you should enable the showCaptureButton parameter.

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

Swift
Objective-C
Swift
DocReader.shared.functionality.showChangeFrameButton = true
Objective-C
[RGLDocReader shared].functionality.showChangeFrameButton = YES;

Show/hide skip next page button:

Swift
Objective-C
Swift
DocReader.shared.functionality.showSkipNextPageButton = true
Objective-C
[RGLDocReader shared].functionality.showSkipNextPageButton = YES;

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

Swift
Objective-C
Swift
DocReader.shared.functionality.showCameraSwitchButton = true
Objective-C
[RGLDocReader shared].functionality.showCameraSwitchButton = YES;

Detection

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

Swift
Objective-C
Swift
DocReader.shared.functionality.videoCaptureMotionControl = true
Objective-C
[RGLDocReader shared].functionality.videoCaptureMotionControl = YES;

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

Swift
Objective-C
Swift
DocReader.shared.functionality.skipFocusingFrames = true
Objective-C
[RGLDocReader shared].functionality.skipFocusingFrames = YES;

Orientation

Defines orientation of activities by using one of UIInterfaceOrientationMask members:

Swift
Objective-C
Swift
DocReader.shared.functionality.orientation = UIInterfaceOrientationMask.portrait
Objective-C
[RGLDocReader shared].functionality.orientation = UIInterfaceOrientationMaskPortrait;

Make sure that selected orientation corresponds to your application’s orientation. Otherwise, it may lead to unexpected behavior.

Scanning modes

Allows you to set the scanning mode:

Swift
Objective-C
Swift
DocReader.shared.functionality.captureMode = CaptureMode.captureVideo
Objective-C
[RGLDocReader shared].functionality.captureMode = RGLCaptureModeCaptureVideo;

Video Settings

Set the frame resolution. Use on of AVCaptureSession.Preset members:

Swift
Objective-C
Swift
DocReader.shared.functionality.videoSessionPreset = AVCaptureSession.Preset.hd1920x1080
Objective-C
[RGLDocReader shared].functionality.videoSessionPreset = AVCaptureSessionPreset1920x1080;

If set, allows you to adjust a zoom level using the pinch gesture (its range from 1x to 10x):

Swift
Objective-C
Swift
DocReader.shared.functionality.isZoomEnabled = true
Objective-C
[RGLDocReader shared].functionality.isZoomEnabled = YES;

Allows you to set the desired zoom level (its range from 1x to 10x):

Swift
Objective-C
Swift
DocReader.shared.functionality.zoomFactor = 2.0
Objective-C
[RGLDocReader shared].functionality.zoomFactor = 2.0;

Single Result

If set, the result will be displayed as soon as it is received:

Swift
Objective-C
Swift
DocReader.shared.functionality.singleResult = true
Objective-C
[RGLDocReader shared].functionality.singleResult = YES;

Capture Device Position

You can specify the position of a capture device for video session:

Swift
Objective-C
Swift
DocReader.shared.functionality.cameraPosition = AVCaptureDevice.Position.back
Objective-C
[RGLDocReader shared].functionality.cameraPosition = AVCaptureDevicePositionBack;

Extra info

If set, the metadata will be displayed over the camera preview during document processing, namely the perspective angle value:

Swift
Objective-C
Swift
DocReader.shared.functionality.showMetadataInfo = true
Objective-C
[RGLDocReader shared].functionality.showMetadataInfo = YES;

Customization

Camera Frame

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

Swift
Objective-C
Swift
DocReader.shared.customization.cameraFrameBorderWidth = 10
Objective-C
[RGLDocReader shared].customization.cameraFrameBorderWidth = 10;

Hex string of document bounds border color in default state:

Swift
Objective-C
Swift
DocReader.shared.customization.cameraFrameDefaultColor = UIColor.red
Objective-C
[RGLDocReader shared].customization.cameraFrameDefaultColor = [UIColor redColor];

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

Swift
Objective-C
Swift
DocReader.shared.customization.cameraFrameActiveColor = UIColor.purple
Objective-C
[RGLDocReader shared].customization.cameraFrameActiveColor = [UIColor purpleColor];

Defines the shape of document bounds border:

Swift
Objective-C
Swift
DocReader.shared.customization.cameraFrameShapeType = CameraFrameShapeType.corners
Objective-C
[RGLDocReader shared].customization.cameraFrameShapeType = RGLCameraFrameShapeTypeCorners;

Defines the length (dp) of the corner side in shape mode corners:

Swift
Objective-C
Swift
DocReader.shared.customization.cameraFrameLineLength = 25
Objective-C
[RGLDocReader shared].customization.cameraFrameLineLength = 25;

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.

Allows to change the corners' radius of the camera frame:

Swift
Objective-C
Swift
DocReader.shared.customization.cameraFrameCornerRadius = 10
Objective-C
[RGLDocReader shared].customization.cameraFrameCornerRadius = 10;

Allows to customize the beginning and ending of stroked lines of the camera frame:

Swift
Objective-C
Swift
DocReader.shared.customization.cameraFrameLineCap = CGLineCap.round
Objective-C
[RGLDocReader shared].customization.cameraFrameLineCap = kCGLineCapRound;

Allows to specify the offsetWidth for the camera frame (only for the portrait orientation):

Swift
Objective-C
Swift
DocReader.shared.customization.cameraFrameOffsetWidth = 50
Objective-C
[RGLDocReader shared].customization.cameraFrameOffsetWidth = 50;

Allows to change the aspect ratio of the camera frame for portrait mode:

Swift
Objective-C
Swift
DocReader.shared.customization.cameraFramePortraitAspectRatio = 1.0
Objective-C
[RGLDocReader shared].customization.cameraFramePortraitAspectRatio = 1.0;

Allows to change the aspect ratio of the camera frame for landscape mode:

Swift
Objective-C
Swift
DocReader.shared.customization.cameraFrameLandscapeAspectRatio = 1.0
Objective-C
[RGLDocReader shared].customization.cameraFrameLandscapeAspectRatio = 1.0;

Allows to change the position of the camera frame vertically:

Swift
Objective-C
Swift
DocReader.shared.customization.cameraFrameVerticalPositionMultiplier = 0.5
Objective-C
[RGLDocReader shared].customization.cameraFrameVerticalPositionMultiplier = 0.5;

Buttons

Allows you to change the Torch button's icon for both ON and OFF states:

Swift
Objective-C
Swift
// For the ON state
DocReader.shared.customization.torchButtonOnImage = UIImage(named: "icon")
// For the OFF state
DocReader.shared.customization.torchButtonOffImage = UIImage(named: "icon")
Objective-C
// For the ON state
[RGLDocReader shared].customization.torchButtonOnImage = [UIImage imageNamed:@"icon"];
// For the OFF state
[RGLDocReader shared].customization.torchButtonOffImage = [UIImage imageNamed:@"icon"];

Allows you to change the Close button's icon:

Swift
Objective-C
Swift
DocReader.shared.customization.closeButtonImage = UIImage(named: "icon")
Objective-C
[RGLDocReader shared].customization.closeButtonImage = [UIImage imageNamed:@"icon"];

Allows you to change the Capture button's icon:

Swift
Objective-C
Swift
DocReader.shared.customization.captureButtonImage = UIImage(named: "icon")
Objective-C
[RGLDocReader shared].customization.captureButtonImage = [UIImage imageNamed:@"icon"];

Allows you to change the Change Frame button's icon for both ON and OFF states:

Swift
Objective-C
Swift
// For the ON state
DocReader.shared.customization.changeFrameButtonExpandImage = UIImage(named: "icon")
// For the OFF state
DocReader.shared.customization.changeFrameButtonCollapseImage = UIImage(named: "icon")
Objective-C
// For the ON state
[RGLDocReader shared].customization.changeFrameButtonExpandImage = [UIImage imageNamed:@"icon"];
// For the OFF state
[RGLDocReader shared].customization.changeFrameButtonCollapseImage = [UIImage imageNamed:@"icon"];

Allows you to change the Camera Switch button's icon:

Swift
Objective-C
Swift
DocReader.shared.customization.cameraSwitchButtonImage = UIImage(named: "icon")
Objective-C
[RGLDocReader shared].customization.cameraSwitchButtonImage = [UIImage imageNamed:@"icon"];

Allows you to change the size of the toolbar (the area where the buttons are located):

Swift
Objective-C
Swift
DocReader.shared.customization.toolbarSize = 46.0
Objective-C
[RGLDocReader shared].customization.toolbarSize = 46.0;

Status Message

Set a status message next to the frame:

Swift
Objective-C
Swift
DocReader.shared.customization.status = "Hello"
Objective-C
[RGLDocReader shared].customization.status = @"Hello";

Turn on/off status message:

Swift
Objective-C
Swift
DocReader.shared.customization.showStatusMessages = true
Objective-C
[RGLDocReader shared].customization.showStatusMessages = YES;

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

Swift
Objective-C
Swift
DocReader.shared.customization.statusTextFont = UIFont.italicSystemFont(ofSize: 14)
Objective-C
[RGLDocReader shared].customization.statusTextFont = [UIFont italicSystemFontOfSize:14];

Hex string of main text status color:

Swift
Objective-C
Swift
DocReader.shared.customization.statusTextColor = UIColor.red
Objective-C
[RGLDocReader shared].customization.statusTextColor = [UIColor redColor];

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:

Swift
Objective-C
Swift
DocReader.shared.customization.statusPositionMultiplier = 0.5
Objective-C
[RGLDocReader shared].customization.statusPositionMultiplier = 0.5;

Result Status Message

Set a result status message next to the frame:

Swift
Objective-C
Swift
DocReader.shared.customization.resultStatus = "Hello"
Objective-C
[RGLDocReader shared].customization.resultStatus = @"Hello";

Turn on/off result status message:

Swift
Objective-C
Swift
DocReader.shared.customization.showResultStatusMessages = true
Objective-C
[RGLDocReader shared].customization.showResultStatusMessages = YES;

Set the text font for the current status:

Swift
Objective-C
Swift
DocReader.shared.customization.resultStatusTextFont = UIFont.italicSystemFont(ofSize: 14)
Objective-C
[RGLDocReader shared].customization.resultStatusTextFont = [UIFont italicSystemFontOfSize:14];

Hex string of current text status color:

Swift
Objective-C
Swift
DocReader.shared.customization.resultStatusTextColor = UIColor.purple
Objective-C
[RGLDocReader shared].customization.resultStatusTextColor = [UIColor purpleColor];

Hex string of current text status background color:

Swift
Objective-C
Swift
DocReader.shared.customization.resultStatusBackgroundColor = UIColor.red
Objective-C
[RGLDocReader shared].customization.resultStatusBackgroundColor = [UIColor redColor];

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:

Swift
Objective-C
Swift
DocReader.shared.customization.resultStatusPositionMultiplier = 0.5
Objective-C
[RGLDocReader shared].customization.resultStatusPositionMultiplier = 0.5;

Custom Status Message

Allows to create a custom status as NSAttributedString:

Swift
Objective-C
Swift
DocReader.shared.customization.customLabelStatus = NSAttributedString(string: "Hello, world!", attributes: [NSAttributedString.Key.foregroundColor: UIColor.red, NSAttributedString.Key.font: UIFont.italicSystemFont(ofSize: 18)])
Objective-C
[RGLDocReader shared].customization.customLabelStatus = [[NSAttributedString alloc] initWithString:@"Hello, world!" attributes:@{ NSForegroundColorAttributeName:[UIColor redColor], NSFontAttributeName:[UIFont italicSystemFontOfSize:18] }];

Allows you to change the location of the custom 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:

Swift
Objective-C
Swift
DocReader.shared.customization.customStatusPositionMultiplier = 1.0
Objective-C
[RGLDocReader shared].customization.customStatusPositionMultiplier = 1.0;

Animation

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

Swift
Objective-C
Swift
DocReader.shared.customization.showHelpAnimation = true
Objective-C
[RGLDocReader shared].customization.showHelpAnimation = YES;

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

Swift
Objective-C
Swift
DocReader.shared.customization.helpAnimationImage = UIImage(named: "icon")
Objective-C
[RGLDocReader shared].customization.helpAnimationImage = [UIImage imageNamed:@"icon"];

Allows to change the content mode of the help animation image, use one of UIView.ContentMode members:

Swift
Objective-C
Swift
DocReader.shared.customization.helpAnimationImageContentMode = UIView.ContentMode.scaleAspectFit
Objective-C
[RGLDocReader shared].customization.helpAnimationImageContentMode = UIViewContentModeScaleAspectFit;

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

Swift
Objective-C
Swift
DocReader.shared.customization.showNextPageAnimation = true
Objective-C
[RGLDocReader shared].customization.showNextPageAnimation = YES;

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

Swift
Objective-C
Swift
DocReader.shared.customization.multipageAnimationFrontImage = UIImage(named: "icon")
Objective-C
[RGLDocReader shared].customization.multipageAnimationFrontImage = [UIImage imageNamed:@"icon"];

Allows to change the content mode of the front image of the multipage animation, use one of UIView.ContentMode members:

Swift
Objective-C
Swift
DocReader.shared.customization.multipageAnimationFrontImageContentMode = UIView.ContentMode.scaleAspectFit
Objective-C
[RGLDocReader shared].customization.multipageAnimationFrontImageContentMode = UIViewContentModeScaleAspectFit;

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

Swift
Objective-C
Swift
DocReader.shared.customization.multipageAnimationBackImage = UIImage(named: "icon")
Objective-C
[RGLDocReader shared].customization.multipageAnimationBackImage = [UIImage imageNamed:@"icon"];

Allows to change the content mode of the back image of the multipage animation, use one of UIView.ContentMode members:

Swift
Objective-C
Swift
DocReader.shared.customization.multipageAnimationBackImageContentMode = UIView.ContentMode.scaleAspectFit
Objective-C
[RGLDocReader shared].customization.multipageAnimationBackImageContentMode = UIViewContentModeScaleAspectFit;

Visual Elements

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

Swift
Objective-C
Swift
DocReader.shared.customization.tintColor = UIColor.red
Objective-C
[RGLDocReader shared].customization.tintColor = [UIColor redColor];

Skip Button

Hex string of page skipping button background:

Swift
Objective-C
Swift
DocReader.shared.customization.multipageButtonBackgroundColor = UIColor.red
Objective-C
[RGLDocReader shared].customization.multipageButtonBackgroundColor = [UIColor redColor];

Loading Indicator

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

Swift
Objective-C
Swift
DocReader.shared.customization.activityIndicatorColor = UIColor.red
Objective-C
[RGLDocReader shared].customization.activityIndicatorColor = [UIColor redColor];

Background

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

Swift
Objective-C
Swift
DocReader.shared.customization.showBackgroundMask = true
Objective-C
[RGLDocReader shared].customization.showBackgroundMask = YES;

Allows to change the intensity of the background mask:

Swift
Objective-C
Swift
DocReader.shared.customization.backgroundMaskAlpha = 0.3
Objective-C
[RGLDocReader shared].customization.backgroundMaskAlpha = 0.3;

Allows to set image within camera frame:

Swift
Objective-C
Swift
DocReader.shared.customization.borderBackgroundImage = UIImage(named: "icon")
Objective-C
[RGLDocReader shared].customization.borderBackgroundImage = [UIImage imageNamed:@"icon"];

Allows to change the content mode of image, which is located within camera frame, use one of UIView.ContentMode members:

Swift
Objective-C
Swift
DocReader.shared.customization.borderBackgroundImageContentMode = UIView.ContentMode.scaleAspectFit
Objective-C
[RGLDocReader shared].customization.borderBackgroundImageContentMode = UIViewContentModeScaleAspectFit;

RFID

Allows you to automatically change the scenario settings depending on the type and results obtained during scanning of the last document. Default value is true:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.autoSettings = true
Objective-C
[RGLDocReader shared].rfidScenario.autoSettings = YES;

Allows to set an authentication procedure type, conducting which is expected in the presence of all the objective conditions:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.authProcType = RFIDAuthenticationProcedureType.advanced
Objective-C
[RGLDocReader shared].rfidScenario.authProcType = RGLRFIDSdkProfilerTypeDoc9303Edition2006;

Allows to set a type of priority mechanism for organizing SM-channel (Security Messaging - a mechanism of protected data exchanging):

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.baseSMProcedure = RFIDAccessControlProcedureType.bac
Objective-C
[RGLDocReader shared].rfidScenario.baseSMProcedure = RGLRFIDAccessControlProcedureTypeBac;

Allows to set a data access type for PACE procedure:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.pacePasswordType = RFIDPasswordType.mrz
Objective-C
[RGLDocReader shared].rfidScenario.pacePasswordType = RGLRFIDPasswordTypeMrz;

Priority of using DS-certificates:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.pkdDSCertPriority = false
Objective-C
[RGLDocReader shared].rfidScenario.pkdDSCertPriority = NO;

Use of CSCA-certificates submitted by individual data files only:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.pkdUseExternalCSCA = false
Objective-C
[RGLDocReader shared].rfidScenario.pkdUseExternalCSCA = NO;

Level of trust to CSCA-certificates from PKD:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.trustedPKD = false
Objective-C
[RGLDocReader shared].rfidScenario.trustedPKD = NO;

Logical sign of passive authentication performance:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.passiveAuth = true
Objective-C
[RGLDocReader shared].rfidScenario.passiveAuth = YES;

Logical sign of the cancellation of active authentication procedure (AA) after the successful performance of chip authentication (CA) procedure:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.skipAA = false
Objective-C
[RGLDocReader shared].rfidScenario.skipAA = NO;

Selection of the type of logical data profiler to use with the electronic document:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.profilerType = RGLRFIDSdkProfilerTypeDoc9303Edition2006
Objective-C
[RGLDocReader shared].rfidScenario.profilerType = RGLRFIDSdkProfilerTypeDoc9303Edition2006;

Strict ISO protocol:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.strictProcessing = false
Objective-C
[RGLDocReader shared].rfidScenario.strictProcessing = NO;

Allows to specify whether the ePassport has to be read or not:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.readEPassport = true
Objective-C
[RGLDocReader shared].rfidScenario.readEPassport = YES;

Allows to specify which data groups of the ePassport have to be read:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.ePassportDataGroups.dG1 = true
Objective-C
[RGLDocReader shared].rfidScenario.ePassportDataGroups.dG1 = YES;

Allows to specify whether the eID has to be read or not:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.readEID = false
Objective-C
[RGLDocReader shared].rfidScenario.readEID = NO;

Allows to specify which data groups of the eID have to be read:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.eIDDataGroups.dG1 = true
Objective-C
[RGLDocReader shared].rfidScenario.eIDDataGroups.dG1 = YES;

Allows to specify whether the eDL has to be read or not:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.readEDL = true
Objective-C
[RGLDocReader shared].rfidScenario.readEDL = YES;

Allows to specify which data groups of the eDL have to be read:

Swift
Objective-C
Swift
DocReader.shared.rfidScenario.eDLDataGroups.dG1 = true
Objective-C
[RGLDocReader shared].rfidScenario.eDLDataGroups.dG1 = YES;

Other

Camera Session

If set, camera session will be paused as soon as the result is received:

Swift
Objective-C
Swift
DocReader.shared.isCameraSessionIsPaused = true
Objective-C
[RGLDocReader shared].cameraSessionIsPaused = YES;