Configure the titles of the user guidance hints for different states.

Hierarchy (view full)

Constructors

Properties

badAngles: string

The user guidance text displayed when the document pitch/skew angle is unacceptable.

Default is "?cameraUserGuidanceBadAngles"

badAspectRatio: string

The user guidance text displayed a detected documents aspect ratio is not within the acceptable range.

Default is "?cameraUserGuidanceBadAspectRatio"

captureManual: string

The user guidance text displayed when the document is ready to be captured in 'manual snapping' mode.

Default is "?cameraUserGuidanceReadyToCaptureManual"

capturing: string

The user guidance text displayed when the document is being captured and user needs to hold the device still.

Default is "?cameraUserGuidanceReadyToCapture"

energySaveMode: string

The user guidance text displayed when the device is in energy saving mode. iOS only.

Default is "?cameraUserGuidanceEnergySaveMode"

noDocumentFound: string

The user guidance text displayed when no document is found.

Default is "?cameraUserGuidanceNoDocumentFound"

orientationMismatch: string

The user guidance text displayed when a landscape document is detected when the camera is in portrait mode (and vice versa).

Default is "?cameraUserGuidanceOrientationMismatch"

readyToCapture: string

The user guidance text displayed when the document is ready to be captured in 'auto snapping' mode.

Default is "?cameraUserGuidanceReadyToCapture"

textHintOffCenter: string

The user guidance text displayed when the document is not centered in the finder view.

Default is "?cameraUserGuidanceTextHintOffCenter"

tooDark: string

The user guidance text displayed when it is too dark to capture an adequate image.

Default is "?cameraUserGuidanceTooDark"

tooNoisy: string

The user guidance text displayed when the background is too noisy.

Default is "?cameraUserGuidanceTooNoisy"

tooSmall: string

The user guidance text displayed when the document is too far from camera.

Default is "?cameraUserGuidanceTooSmall"