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

Hierarchy

  • PartiallyConstructible
    • UserGuidanceStates

Constructors

Properties

badAngles: string

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

Default Value

"?cameraUserGuidanceBadAngles";
badAspectRatio: string

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

Default Value

"?cameraUserGuidanceBadAspectRatio";
captureManual: string

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

Default Value

"?cameraUserGuidanceReadyToCaptureManual";
capturing: string

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

Default Value

"?cameraUserGuidanceReadyToCapture";
energySaveMode: string

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

Default Value

"?cameraUserGuidanceEnergySaveMode";
noDocumentFound: string

The user guidance text displayed when no document is found.

Default Value

"?cameraUserGuidanceNoDocumentFound";
readyToCapture: string

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

Default Value

"?cameraUserGuidanceReadyToCapture";
textHintOffCenter: string

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

Default Value

"?cameraUserGuidanceTextHintOffCenter";
tooDark: string

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

Default Value

"?cameraUserGuidanceTooDark";
tooNoisy: string

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

Default Value

"?cameraUserGuidanceTooNoisy";
tooSmall: string

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

Default Value

"?cameraUserGuidanceTooSmall";

Generated using TypeDoc