Class ScannerConfig

A configuration file for the scanner screen.

Constructors

constructor

Properties

cameraId? extPortrait? livePortrait? onlineProcessingConfig? scenario?

Methods

withOnlineProcessingConfig withScenario

Constructors

constructor

Properties

OptionalcameraId

cameraId?: number

Camera id.

Android only.

OptionalextPortrait

extPortrait?: string

Portrait photo from an external source. Base64 string.

Requires network connection.

OptionallivePortrait

livePortrait?: string

Live portrait photo. Base64 string.

Requires network connection.

Optional ReadonlyonlineProcessingConfig

onlineProcessingConfig?: OnlineProcessingConfig

Configuration class for online processing.

Requires network connection.

Optional Readonlyscenario

scenario?: Scenario

Documents processing scenario.

Methods

StaticwithOnlineProcessingConfig

  • withOnlineProcessingConfig(onlineProcessingConfig): ScannerConfig

  • Creates a configuration for online processing.

    Parameters

    Returns ScannerConfig

StaticwithScenario

  • withScenario(scenario): ScannerConfig

  • Creates a configuration with a specific processing scenario.

    Parameters

    • scenario: Scenario

      The documents processing scenario.

    Returns ScannerConfig

Settings

Member Visibility

On This Page

Constructors
Properties
Methods