public static class MultiPageImageCaptureScenario.Builder
Creates an instance of a MultiPageImageCaptureScenario class and manages the settings of the scenario, represented by this instance.
@MainThread public Builder(@NotNull com.abbyy.mobile.rtr.Engine engine, @NotNull com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.PageStorage pageStorage)
Creates an instance of a MultiPageImageCaptureScenario class and manages the settings of the scenario, represented by this instance.
engine
- Engine object via which image processing is performed.pageStorage
- Page storage for storing captured images and all corresponding information.@MainThread public Builder(@NotNull com.abbyy.mobile.rtr.Engine engine, @NotNull android.content.Context context)
engine
- Engine object via which image processing is performed.context
- Default storage located in the default folder. Pass context to use this page storage.@MainThread public Builder(@NotNull com.abbyy.mobile.rtr.Engine engine, @NotNull java.lang.String path)
engine
- Engine object via which image processing is performed.path
- Custom folder with a default storage. Pass the full path to the custom folder to use this page storage.
Important: In case a custom folder is used, read/write permissions should be granted for the application.
To do this, use the setAdditionalPermissions method of the interface CaptureView.ExtendedSettings
interface.
@MainThread @NotNull public com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder setRequiredPageCount(int requiredPageCount)
Sets total number of pages to be captured.
In case the total number of pages is set to 0, there is no limit on the pages number, the result images set can be saved or edited at any time. If the total number of pages is set to a positive value, only the exact number of images can be saved.
requiredPageCount
- The total number of pages to be captured.@MainThread @NotNull public com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder setUISettings(@Nullable com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.UISettings uiSettings)
Sets appearance settings to the pages.
uiSettings
- A interface MultiPageImageCaptureScenario.UISettings
object, storing the settings for pages appearance.@MainThread @NotNull public com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder setCaptureSettings(@Nullable com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.CaptureSettings captureSettings)
Sets additional multipage image capture scenario processing settings.
captureSettings
- A interface MultiPageImageCaptureScenario.CaptureSettings
object for managing processing setting of the multipage imagecapture scenario.@MainThread @NotNull public com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder setStartAsEditorAtPage(@Nullable java.lang.String pageId)
Sets one of the previously captured images as a start page by its identifier. The image with this identifier will be displayed at the scenario beginning. In order to show the camera view at the beginning of the scenario, skip this method or pass null.
pageId
- Identifier of a page to be shown as a start page at the scenario beginning.@MainThread @NotNull public com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder setShowPreviewEnabled(boolean isShowPreviewEnabled)
Enables and disables image preview after capture.
isShowPreviewEnabled
- This parameter defines if a preview of an image should be shown after capture.Set true to show preview and false to return to camera view after capture.@MainThread @NotNull public MultiPageImageCaptureScenario build()
Returns an instance of a class MultiPageImageCaptureScenario
.
This instance will have the settings predefined by Builder class methods.
class MultiPageImageCaptureScenario