Configuration of the camera behavior.

Hierarchy

  • PartiallyConstructible
    • DocumentScannerCameraConfiguration

Constructors

Properties

acceptedAngleScore: number

The minimum pitch/skew angle of the document to be accepted. The value must be between 0.0 and 1.0. Default is 0.75

acceptedBrightnessThreshold: number

The minimum brightness value to accept a detected document. Default is 50

acceptedSizeScore: number

The minimum size of the document in relation to the screen preview to be accepted. The value must be between 0.0 and 1.0. Default is 0.75

autoCropOnManualSnap: boolean

Determines whether the document should be cropped automatically after a manual snap or not. Default is true

autoSnappingDelay: number

After a page has been snapped, the delay in milliseconds before auto snapping resumes for the next page. Default is 200

autoSnappingEnabled: boolean

Determines if auto snapping is enabled or not. Default is true

autoSnappingSensitivity: number

Controls the auto snapping speed. The sensitivity must be between 0.0 and 1.0. A value of 1.0 triggers auto snapping immediately, while a value of 0.0 delays the auto snapping by 3 seconds. The default value is 0.66 (1 second). Default is 0.66

cameraModule: CameraModule

Determines which camera module to use on start-up. Default is BACK

cameraPreviewMode: CameraPreviewMode

Determines which camera preview mode to use. Default is FILL_IN

captureQualityPrioritization: CapturePhotoQualityPrioritization

Determines the prioritization of still image quality and capturing speed. Default is BALANCED

captureWithHardwareButtonsEnabled: boolean

When enabled the hardware volume up/down buttons can be used to capture an image if manual snapping is enabled. For iOS version 17.2 or later is required. On iPhones with camera control (iPhone 16 series) this also enables zooming and capturing with the camera control. Default is true

defaultZoomFactor: number

The default zoom factor on start-up. Default is 1.0

flashEnabled: boolean

Determines whether the flashlight is enabled or not on start-up. Default is false

ignoreBadAspectRatio: boolean

Determines whether a landscape document will be detected when the camera is in portrait mode (and vice versa) or not. This parameter will be ignored if required aspect ratios have been explicitly defined. Default is true

minFocusDistanceLock: boolean

Determines whether locking the focus at the minimum possible distance is enabled or not (device-specific). Default is false

pinchToZoomEnabled: boolean

Determines whether pinch-to-zoom is enabled or not. Default is true

requiredAspectRatios: AspectRatio[]

The required aspect ratios for the document to be accepted.

touchToFocusEnabled: boolean

Determines whether touch-to-focus is enabled or not. Android only. Default is false