Skip to main content
Version: v8001

Session settings

Mobile and web SDKs use session settings to configure the scanning session. Scanning settings are a part of session settings.

inputImageSource​

type: string, default: video

Specifies whether the session receives images from a continuous camera feed or from a single photo.

Allowed values: video, photo.

  • video: continuous camera feed; the SDK processes frames in real time until a result is produced
  • photo: a single static image, such as one picked from a gallery or captured by your own camera logic
note

Setting inputImageSource to photo affects the behavior of several scanning settings: inputImageMargin, resultAggregationEnabled, and inputImageSelectionStrategy are only applicable to video sources, while the unknown and cropped values of cropType are only applicable to photo sources.

scanningMode​

type: string, default: automatic

Controls whether the SDK scans one or both sides of a document.

Allowed values:

  • automatic: the SDK detects the document type and prompts the user to turn the document to scan the other side
  • single: the SDK scans exactly one side, then returns a result regardless of document type
note

single mode imposes additional constraints on scanning settings. secondSideWithNoExtractableDataSkipped and passportDataPageScanOnly must remain true in single mode.

scanningSettings​

type: object

See Scanning settings.

Platform specifics: timeouts​

In addition to the session settings listed above, iOS also has the following timeout-related settings:

  • stepTimeoutDuration
  • inactivityTimeoutDuration

For a general discussion of timeouts, and how they can be configured (including for iOS), see Timeouts.

Last updated on