AUIMultiPageImageCaptureScenario interface

Provides access to the multipage image capture scenario management.

This interface helps to easily integrate the image capture technology into your application and manage the scenario when more than one image should be captured.

Inherits from the AUICaptureScenario interface.

Requires a delegate that conforms to the AUIMultiPageImageCaptureScenarioDelegate protocol.

Properties

Name Type Description
uiSettings AUIMultiPageUISettings Appearance settings of pages.
captureSettings AUIMultiPageCaptureSettings Additional multipage image capture scenario processing settings.
active BOOL

Defines if the automatic capture is enabled. if YES, the image will be captured automatically from the video stream. If NO, only manual capture will be available.

After each capture this parameter is set to NO.

This property is passed to the setActive method as a parameter.

The default value is YES.

isShowPreviewEnabled BOOL

Specifies if a preview of an image should be shown after capture. If YES, a preview is shown. If NO, the camera view is shown instead.

The default value is NO.

requiredPageCount NSUInteger

Total number of pages to be captured.

Use this property to set the page-limitation mode of the image capture:

  • set to 0 to allow unlimited image capture. The batch of the result images can be saved or edited at any time
  • set to a positive value to set the exact number of images that should be captured. Images saving is enabled only when this number of images are been captured.
    If the uiSettings property is set to the default value, required number of images is shown as a tip at the bottom of the camera view and in the top left corner of the gallery view, i.e. "1 of 3", where "3" is the required number of images.

The value of this property should be set before the start of the capture scenario.

The default value is 0 (no pages limit).

startAsEditorAtPageId AUIPageId

Identifier of the page with previously captured image that will be displayed as a start page at the scenario beginning. This property may be nil. In this case at the scenario beginning the camera view will be shown.

 Note: This property becomes available after some images are been captured and saved to the AUIPageStorage with corresponding AUIPageId. Before the first image capture scenario start this property is nil.

The default value is nil.

result AUIMultiPageImageCaptureResult Result of the multipage image capture scenario. Captured images can be retrieved by this property methods and used in further scenario, i.e. images demonstration in a view with all captured documents.

Methods

Name Description
- initWithEngine: Connects the AUIMultiPageImageCaptureScenario object with the RTREngine object that implements recognition.
- setActive:animated: Sets on and off automatic image capture mode.

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.