Class ScannerConfig

A configuration file for the scanner screen.

Index

Constructors

Properties

cameraId? extPortrait? livePortrait? onlineProcessingConfig? scenario?

Methods

withOnlineProcessingConfig withScenario

Constructors

constructor

new ScannerConfig(
scenario: Scenario,
onlineProcessingConfig: OnlineProcessingConfig,
): ScannerConfig
Parameters
- scenario: Scenario
- onlineProcessingConfig: OnlineProcessingConfig
Returns ScannerConfig
- Defined in config/ScannerConfig.d.ts:41

Properties

`Optional`cameraId

cameraId?: number

Camera id.

Android only.

`Optional`extPortrait

extPortrait?: string

Portrait photo from an external source. Base64 string.

Requires network connection.

`Optional`livePortrait

livePortrait?: string

Live portrait photo. Base64 string.

Requires network connection.

`Optional` `Readonly`onlineProcessingConfig

onlineProcessingConfig?: OnlineProcessingConfig

Configuration class for online processing.

Requires network connection.

`Optional` `Readonly`scenario

scenario?: Scenario

Documents processing scenario.

Methods

`Static`withOnlineProcessingConfig

withOnlineProcessingConfig(
onlineProcessingConfig: OnlineProcessingConfig,
): ScannerConfig
Creates a configuration for online processing.
Parameters
- onlineProcessingConfig: OnlineProcessingConfig
  The configuration for online processing.
Returns ScannerConfig
- Defined in config/ScannerConfig.d.ts:53

`Static`withScenario

withScenario(scenario: Scenario): ScannerConfig
Creates a configuration with a specific processing scenario.
Parameters
- scenario: Scenario
  The documents processing scenario.
Returns ScannerConfig
- Defined in config/ScannerConfig.d.ts:47