OptionalbtAllows you to specify a name of a Regula device that will be used with Document Reader SDK.
OptionalcameraSet this setting to override the default cropping frame provided by scenarios.
OptionalcameraAllows you to specify the camera API.
OptionalcameraAllows you to specify a position of a capture device for the video session.
OptionalcameraAllows you to specify the frame resolution.
Android only. For iOS use cameraResolutionIOS
OptionalcameraAllows you to specify the frame resolution.
iOS only. For Android use cameraResolutionAndroid
OptionalcaptureAllows you to specify the video processing mode.
OptionaldisplayIf it's set to true, the metadata will be displayed over the camera
preview during document processing, namely the perspective angle value.
OptionalexcludedA list of devices that must not use the camera2 API.
Android only.
Unmodifiable property. Use setter instead of editing.
OptionalexposureAllows you to control exposure.
Android only.
OptionalforceSets a limit on the number of pages to be processed.
OptionalisAllows you to disable all validations of having a torch in case Android returns that it's not available, but it can be used when checks are skipped.
OptionalisIf it's set to true, allows you to adjust a zoom level using the pinch
gesture (its range is from 1x to 10x).
OptionalmanualIf it's set to true, scanner operate in manual multipage scanning mode.
Set this flag to true, if you wanna create for example, custom logic
(or UI) between scanning document pages.
OptionalorientationAllows you to specify an orientation of the camera view controller.
OptionalpictureIf set to true, as soon as document is located during video mode,
picture wil be taken and processed as single frame.
Used for devices with poor-quality video preview.
Android only.
OptionalpreventWhen enabled, the SDK prevents both screen recording and screenshots.
OptionalrecordIf set to true, video during processing of the document will be recorded.
This can be used later for debugging and troubleshooting.
OptionalrfidUse the parameter to set the time limit (in seconds) for the RFID chip reading, beyond which it does not continue regardless of its result.
Android only.
OptionalshowIf it's set to true, the button that allows you to change a position
of a capture device for the video session will be displayed.
OptionalshowIf it's set to true, the button that allows you to take a picture
and process it as a single frame will be displayed.
OptionalshowAllows you to specify a time interval when the Capture button
has to be displayed after the document is detected.
Don't forget to set the showCaptureButton to true,
otherwise, it won't be displayed.
OptionalshowAllows you to specify a time interval when the Capture button
has to be displayed after the scanning process is started.
Don't forget to set the showCaptureButton to true,
otherwise, it won't be displayed.
OptionalshowOptionalshowIf it's set to true, the button that allows you to close the scanner
will be displayed.
OptionalshowIf it's set to true, the button that allows you to skip processing
of the next page of a document will be displayed.
OptionalshowIf it's set to true, the button that allows you to turn on/off
the torch will be displayed.
OptionalsingleIf it's set to true, once the scanning process is finished,
the scanner will be dismissed.
OptionalskipIf it's set to true, camera frames won't be taken for recognition
while a camera is focusing.
OptionaltorchIf set, torch (if available) will turn on immediately on camera preview start.
OptionaluseIf it's set to true, allows you to connect to the external
Regula Bluetooth devices like Regula 1120 and others.
OptionalvideoIf it's set to true, camera frames won't be taken for recognition
while a device is moving based on motion sensors.
OptionalvideoAndroid only.
OptionalzoomAllows you to set the desired zoom level (its range from 1x to 10x).
StaticfromAllows you to deserialize object.
Params that influence the scanning process, camera view controller customization and etc.