AUIImageCaptureSettings protocol

Provides access to the settings of the image capture scenario for the certain page.

An instance of this protocol is passed as a parameter to the captureScenario:onConfigureImageCaptureSettings: method of the AUIMultiPageCaptureSettings protocol.

Properties

Name Type Description
aspectRatioMin CGFloat

Lower limit of the document's aspect ratio.

This property is used in pair with the aspectRatioMax, defining an interval of acceptable aspect ratio values of the document to be captured. Setting aspect ratio will help to improve boundary detection accuracy.

If only aspectRatioMax is set, aspectRatioMin will be set to 1.

By default the property is set to 0 (aspect ratio is not set).

aspectRatioMax CGFloat

Upper limit of document's aspect ratio.

This property is used in pair with the aspectRatioMin, defining an interval of acceptable aspect ratio values of the document to be captured. Setting aspect ratio will help to improve boundary detection accuracy.

If only aspectRatioMin is set, aspectRatioMax will be set to CGFLOAT_MAX.

By default the property is set to 0 (aspect ratio is not set).

documentSize AUIDocumentSize

Document physical size.

The default value is AUIDocumentSizeAny.

imageFromGalleryMaxSize NSInteger

Maximum available size of an image, loaded from the gallery. The size is defined as the length of the largest side of an image (in pixels).

The default value is 4096.

minimumDocumentToViewRatio CGFloat

The [0..1] ratio of the minimum document area relative to the whole frame area.

The default value is 0.15.

Document aspect ratio setting is intended to specify the exact proportions of the target document, which will increase capture accuracy.

 Notes: 

  • Aspect ratio detection requires the mobile device to be placed strictly horizontally over the document during image capture. In case the mobile device is tilted, camera will capture distorted image and the document aspect ratio may be detected incorrectly.
  • The value of aspect ratio is calculated by division of the longer side to the shorter side and is expected to be greater than or equal to 1 (or 0 if not set). If neither aspectRatioMin nor aspectRatioMin are set, the values will be calculated from the documentSize setting.
  • Either height or width of the document should be greater than 60% of the frame height or width respectively. Otherwise the document is considered to be too small and no capture is performed.

02.03.2022 12:59:15

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.