IImageCaptureService interface

An image capture service interface.

This interface provides methods to tune the processing settings, start and stop the work, and pass the video frames from the camera to the background processing engine.

Extends the IRecognitionService interface.

public interface IImageCaptureService extends IRecognitionService


Name Description
setAspectRatioMax Sets the upper limit of document's aspect ratio*.
setAspectRatioMin Sets the lower limit of the document's aspect ratio*.
getExtendedSettings Provides access to extended service configuration settings. Inherited from IRecognitionService.
setAreaOfInterest Sets the area on the frame where the text is to be found. Inherited from IRecognitionService.
setDebugLog Attaches a callback for collecting debug data. Inherited from IRecognitionService.
setDocumentSize Sets the physical size of the document to be captured.
start Starts processing. Inherited from IRecognitionService.
stop Stops processing and releases the resources used by the recognition service. Inherited from IRecognitionService.
submitFrame Submits a video frame.
submitRequestedFrame Submits the video frame requested through the Callback.onRequestLatestFrame method. Inherited from IRecognitionService.
setNumberOfBestFramesToCollect Sets a number of frames with the highest quality to collect during capture. Access the frames via the BestFrames property of the Result class.

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


  • 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.

Nested classes

Name Description
Callback A callback interface to interact with the recognition service: input the data and obtain the results. Extends IRecognitionService.Callback.
ExtendedSettings Extended service configuration settings. Extends IRecognitionService.ExtendedSettings.
QualityAssessmentForOcrBlock Quality assessment block
QualityAssessmentForOcrBlockType Type of quality assessment block
Result Capture result.
Status Capture status.

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.