@regulaforensics/document-reader
    Preparing search index...

    Class Functionality

    Params that influence the scanning process, camera view controller customization and etc.

    Index
    constructor
    btDeviceName? cameraFrame? cameraMode? cameraPositionIOS? cameraResolutionAndroid? cameraResolutionIOS? captureMode? displayMetadata? excludedCamera2Models? exposure? forcePagesCount? hideStatusBar? homeIndicatorAutoHide? isCameraTorchCheckDisabled? isZoomEnabled? manualMultipageMode? mdlTimeout? orientation? pictureOnBoundsReady? preventScreenRecording? recordScanningProcess? rfidTimeout? showCameraSwitchButton? showCaptureButton? showCaptureButtonDelayFromDetect? showCaptureButtonDelayFromStart? showChangeFrameButton? showCloseButton? showSkipNextPageButton? showTorchButton? singleResult? skipFocusingFrames? torchTurnedOn? useAuthenticator? videoCaptureMotionControl? videoRecordingSizeDownscaleFactor? zoomFactor?
    fromJson
    btDeviceName?: string

    Allows you to specify a name of a Regula device that will be used with Document Reader SDK.

    cameraFrame?: DocReaderFrame

    Set this setting to override the default cropping frame provided by scenarios.

    DocReaderFrame.SCENARIO_DEFAULT

    cameraMode?: CameraMode

    Allows you to specify the camera API.

    CameraMode.AUTO

    Android only.

    cameraPositionIOS?: CameraPosition

    Allows you to specify a position of a capture device for the video session.

    CameraPosition.UNSPECIFIED

    IOS only.

    cameraResolutionAndroid?: CameraSize

    Allows you to specify the frame resolution.

    Android only. For iOS use cameraResolutionIOS

    cameraResolutionIOS?: CaptureSessionPreset

    Allows you to specify the frame resolution.

    iOS only. For Android use cameraResolutionAndroid

    captureMode?: CaptureMode

    Allows you to specify the video processing mode.

    CaptureMode.AUTO

    displayMetadata?: boolean

    If it's set to true, the metadata will be displayed over the camera preview during document processing, namely the perspective angle value.

    false
    excludedCamera2Models?: string[]

    A list of devices that must not use the camera2 API.

    Android only.

    Unmodifiable property. Use setter instead of editing.

    exposure?: number

    Allows you to control exposure.

    Android only.

    forcePagesCount?: number

    Sets a limit on the number of pages to be processed.

    hideStatusBar?: boolean

    Android only.

    homeIndicatorAutoHide?: boolean

    If it's set to true, system is allowed to hide the visual indicator for returning to the Home Screen in landscape mode.

    true
    isCameraTorchCheckDisabled?: boolean

    Allows 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.

    false

    Android only.
    isZoomEnabled?: boolean

    If it's set to true, allows you to adjust a zoom level using the pinch gesture (its range is from 1x to 10x).

    false
    manualMultipageMode?: boolean

    If 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.

    false
    mdlTimeout?: number
    orientation?: DocReaderOrientation

    Allows you to specify an orientation of the camera view controller.

    DocReaderOrientation.ALL

    pictureOnBoundsReady?: boolean

    If 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.

    preventScreenRecording?: boolean

    When enabled, the SDK prevents both screen recording and screenshots.

    false
    recordScanningProcess?: boolean

    If set to true, video during processing of the document will be recorded. This can be used later for debugging and troubleshooting.

    false
    rfidTimeout?: number

    Use 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.

    showCameraSwitchButton?: boolean

    If 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.

    false
    showCaptureButton?: boolean

    If it's set to true, the button that allows you to take a picture and process it as a single frame will be displayed.

    false
    showCaptureButtonDelayFromDetect?: number

    Allows 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.

    5
    showCaptureButtonDelayFromStart?: number

    Allows 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.

    10
    showChangeFrameButton?: boolean

    Not used in new UI If it's set to true, the button that allows you to change the camera frame type will be displayed.

    false
    showCloseButton?: boolean

    If it's set to true, the button that allows you to close the scanner will be displayed.

    true
    showSkipNextPageButton?: boolean

    If it's set to true, the button that allows you to skip processing of the next page of a document will be displayed.

    true
    showTorchButton?: boolean

    If it's set to true, the button that allows you to turn on/off the torch will be displayed.

    true
    singleResult?: boolean

    If it's set to true, once the scanning process is finished, the scanner will be dismissed.

    true

    iOS only.
    skipFocusingFrames?: boolean

    If it's set to true, camera frames won't be taken for recognition while a camera is focusing.

    true
    torchTurnedOn?: boolean

    If set, torch (if available) will turn on immediately on camera preview start.

    false
    useAuthenticator?: boolean

    If it's set to true, allows you to connect to the external Regula Bluetooth devices like Regula 1120 and others.

    videoCaptureMotionControl?: boolean

    If it's set to true, camera frames won't be taken for recognition while a device is moving based on motion sensors.

    true
    videoRecordingSizeDownscaleFactor?: number

    Android only.

    zoomFactor?: number

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

    1.0

    • Allows you to deserialize object.

      Parameters

      • jsonObject: any

      Returns Functionality

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods