Skip navigation links
A B C D E G H I L M O P R S T U 

A

A4 - Static variable in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
Document size is 210x297 millimeters.
ANY - Static variable in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
The captured document can have any size.

B

build() - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder
Returns an instance of a class MultiPageImageCaptureScenario. This instance will have the settings predefined by Builder class methods.
Builder(engine, pageStorage) - Constructor for class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder
Creates an instance of a MultiPageImageCaptureScenario class and manages the settings of the scenario, represented by this instance.
Builder(engine, context) - Constructor for class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder
 
Builder(engine, path) - Constructor for class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder
 
BUSINESS_CARD - Static variable in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
Document size is 53.98x85.6 millimeters.

C

CameraSettings.Resolution - Enum in com.abbyy.mobile.uicomponents
The resolution of the images captured from the camera preview.
captureImageManually() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Captures image immediately. This method is useful for implementing your own manual capture button.
CaptureScenario - Interface in com.abbyy.mobile.uicomponents.scenario
Provides access to the capture scenario management.
CaptureView - Class in com.abbyy.mobile.uicomponents
Displays camera preview and provides methods for tuning the user interface appearance and the capturing.
CaptureView(context) - Constructor for class com.abbyy.mobile.uicomponents.CaptureView
 
CaptureView(context, attrs) - Constructor for class com.abbyy.mobile.uicomponents.CaptureView
 
CaptureView(context, attrs, defStyleAttr) - Constructor for class com.abbyy.mobile.uicomponents.CaptureView
 
CaptureView(context, attrs, defStyleAttr, defStyleRes) - Constructor for class com.abbyy.mobile.uicomponents.CaptureView
 
CaptureView.CameraSettings - Interface in com.abbyy.mobile.uicomponents
Settings of the camera. The interface provides methods for tuning camera resolution. Also, if for some reason you have to hide embedded flashlight button and implement a custom one, you can use the methods of this interface to manage the flashlight.
CaptureView.ExtendedSettings - Interface in com.abbyy.mobile.uicomponents
Extended user interface components settings. Intended for advanced users: most common scenarios will work with the default settings.
CaptureView.UISettings - Interface in com.abbyy.mobile.uicomponents
Settings for tuning the user interface appearance.
clear() - Method in interface com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.PageStorage
Removes all the pages from the storage.
clear() - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Result
Removes all the pages from the storage.
closeView() - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario
Stops capture process and calls onClose method of the interface MultiPageImageCaptureScenario.Callback interface.
com.abbyy.mobile.uicomponents - package com.abbyy.mobile.uicomponents
 
com.abbyy.mobile.uicomponents.scenario - package com.abbyy.mobile.uicomponents.scenario
 
component1() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
Document width in millimeters.
component2() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
Document height in millimeters
copy(width, height) - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
The physical size of the documents. Can be chosen from the preset values or defined manually.
create() - Method in interface com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.PageStorage
Creates an empty page with a string identifier and adds it to the storage.

D

delete(pageId) - Method in interface com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.PageStorage
Removes the page with specified identifier
delete(pageId) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Result
Removes the page with specified identifier.
DocumentSize(width, height) - Constructor for class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
The physical size of the documents. Can be chosen from the preset values or defined manually.

E

equals(p) - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
 

G

getAspectRatioMax() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Returns the value of defined upper limit of document's aspect ratio.
getAspectRatioMax() - Method in interface com.abbyy.mobile.uicomponents.scenario.ImageCaptureSettings
Returns the value of defined upper limit of document's aspect ratio.
getAspectRatioMin() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Returns the value of defined lower limit of document's aspect ratio.
getAspectRatioMin() - Method in interface com.abbyy.mobile.uicomponents.scenario.ImageCaptureSettings
Returns the value of defined lower limit of document's aspect ratio.
getBitmap() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.Result
Captured image.
getCameraSettings() - Method in class com.abbyy.mobile.uicomponents.CaptureView
Returns the object that defines the settings of the camera.
getCustomColor() - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Returns defined color of the button for manual taking photo.
getDocumentBoundary() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.Result
Coordinates of the boundaries detected on the image document.
getDocumentSize() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Returns the defined physical size of the captured document.
getDocumentSize() - Method in interface com.abbyy.mobile.uicomponents.scenario.ImageCaptureSettings
Returns the defined physical size of the captured document.
getExtendedSettings() - Method in class com.abbyy.mobile.uicomponents.CaptureView
Returns the object with extended settings for non-common scenarios, i.e. setting extra permissions.
getHeight() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
Document height in millimeters
getImageFromGalleryMaxSize() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Returns the value of the maximum available size of an image, that can be loaded from the gallery.
getImageFromGalleryMaxSize() - Method in interface com.abbyy.mobile.uicomponents.scenario.ImageCaptureSettings
Returns the value of the maximum available size of an image, that can be loaded from the gallery.
getMinimumDocumentToViewRatio() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Returns the value of defined minimum document area relative to the whole frame area.
getMinimumDocumentToViewRatio() - Method in interface com.abbyy.mobile.uicomponents.scenario.ImageCaptureSettings
Returns the value of defined minimum document area relative to the whole frame area.
getPages() - Method in interface com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.PageStorage
Returns all the pages identifiers in the storage.
getPages() - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Result
Returns all the pages identifiers in the storage.
getResolution() - Method in interface com.abbyy.mobile.uicomponents.CaptureView.CameraSettings
Returns the camera resolution.
getResult() - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario
Provides access to the result, represented by an internal class MultiPageImageCaptureScenario.Result object.
getString(type, pageIndex) - Method in interface com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.UISettings
Provides string resources from the ResourceType enumeration for the view control, depending on the scenario step and the page characteristic. I.e., string resources for a page of a passport and a page of a business card can differ on the same view control. So both view control type and page type should be specified. Control type and the type of message is defined by the ResourceType enumeration value. Page type is specified by the page index.
getTheme() - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Returns current color theme of the user interface.
getUISettings() - Method in class com.abbyy.mobile.uicomponents.CaptureView
Returns the object that defines the settings of the user interface.
getWidth() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
Document width in millimeters.

H

hasFlashlight() - Method in interface com.abbyy.mobile.uicomponents.CaptureView.CameraSettings
Determines if the device has a flashlight
hashCode() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
 

I

ImageCaptureScenario - Class in com.abbyy.mobile.uicomponents.scenario
Provides access to the image capture scenario management. The ImageCaptureScenario object constructor receives an instance of the Engine object, required for connection of the User Interface API with the capturing and recognition mechanisms.
ImageCaptureScenario(engine) - Constructor for class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Provides access to the image capture scenario management. The ImageCaptureScenario object constructor receives an instance of the Engine object, required for connection of the User Interface API with the capturing and recognition mechanisms.
ImageCaptureScenario.Callback - Interface in com.abbyy.mobile.uicomponents.scenario
The callback interface of the image capture scenario. In case the image was captured successfully, the result image and the document boundaries on it are returned. Otherwise the callback will return the information about the occurred error. This interface and its methods are to be implemented on the client side.
ImageCaptureScenario.DocumentSize - Class in com.abbyy.mobile.uicomponents.scenario
The physical size of the documents. Can be chosen from the preset values or defined manually.
ImageCaptureScenario.Result - Class in com.abbyy.mobile.uicomponents.scenario
Captured bitmap image with detected document boundaries. This result can be received in both real-time capture from camera preview and from an immediate manual capture.
ImageCaptureSettings - Interface in com.abbyy.mobile.uicomponents.scenario
Settings of image capture. The interface provides methods for tuning required aspect ratio range, document size for cropping and other useful settings.
isAutoCaptureButtonVisible() - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Checks if the button for automatic capture is visible.
isCancelButtonVisible() - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Checks if the cancel button, that closes the view, is visible.
isCaptureButtonVisible() - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Checks if the button for taking photo manually is visible.
isCropEnabled() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Checks if the crop function is enabled and the captured image will be cropped.
isFlashlightButtonVisible() - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Checks if the button of flashlight is shown.
isFlashlightEnabled() - Method in interface com.abbyy.mobile.uicomponents.CaptureView.CameraSettings
Defines if the flashlight in torch mode is currently enabled.
isGalleryButtonVisible() - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Checks if the button for choosing an image from photo gallery is visible.

L

LETTER - Static variable in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
Document size is 215.9x279.4 millimeters
load(pageId, key) - Method in interface com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.PageStorage
Returns the data of the certain page, associated with the specified key
loadBoundary(pageId) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Result
Returns the document boundary for the specified page.
loadDocumentSize(pageId) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Result
 
loadImage(pageId) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Result
Returns the captured and cropped image for the specified page.
loadOriginalImage(pageId) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Result
Returns the original captured image for the specified page.

M

MultiPageImageCaptureScenario - Class in com.abbyy.mobile.uicomponents.scenario
Provides access to the multipage image capture scenario management.
MultiPageImageCaptureScenario.Builder - Class in com.abbyy.mobile.uicomponents.scenario
Creates an instance of a MultiPageImageCaptureScenario class and manages the settings of the scenario, represented by this instance.
MultiPageImageCaptureScenario.Callback - Interface in com.abbyy.mobile.uicomponents.scenario
 
MultiPageImageCaptureScenario.CaptureSettings - Interface in com.abbyy.mobile.uicomponents.scenario
Manages the image capture process of a certain page.
MultiPageImageCaptureScenario.PageStorage - Interface in com.abbyy.mobile.uicomponents.scenario
API for implementing a custom image storage.
MultiPageImageCaptureScenario.ResourceType - Enum in com.abbyy.mobile.uicomponents.scenario
String resources, that should be shown according to the corresponding view control.
MultiPageImageCaptureScenario.Result - Class in com.abbyy.mobile.uicomponents.scenario
Provides access to the result of a multipage document capture.
MultiPageImageCaptureScenario.UISettings - Interface in com.abbyy.mobile.uicomponents.scenario
Provides access to extra user interface setting of current view control.

O

onClose(result) - Method in interface com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Callback
 
onConfigureImageCaptureSettings(settings, pageIndex) - Method in interface com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.CaptureSettings
Provides image capture processing settings to the page during capture. The page with specified index will be captured according to these settings.
onError(exception) - Method in interface com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.Callback
This method is to be implemented on the client side, which may include displaying the error description to the user or handling it otherwise.
onError(exception, result) - Method in interface com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Callback
 
onFinished(result) - Method in interface com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Callback
 
onImageCaptured(result) - Method in interface com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.Callback
Delivers the result if the image was captured successfully.
onImageCaptured(result) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario
 

P

pickImageFromGallery() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Opens image gallery view. This method can be used for implementing your own gallery button.

R

Result(bitmap, documentBoundary) - Constructor for class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.Result
Captured bitmap image with detected document boundaries. This result can be received in both real-time capture from camera preview and from an immediate manual capture.

S

setAdditionalPermissions(permissions) - Method in interface com.abbyy.mobile.uicomponents.CaptureView.ExtendedSettings
Sets if any permissions to be granted for the scenario performance in addition to the camera usage permission, i.e. remote storage, Bluetooth or geolocation permissions.
setAspectRatioMax(maxValue) - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Sets the upper limit of document's aspect ratio.
setAspectRatioMax(maxValue) - Method in interface com.abbyy.mobile.uicomponents.scenario.ImageCaptureSettings
Sets the upper limit of document's aspect ratio.
setAspectRatioMin(minValue) - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Sets the lower limit of the document's aspect ratio.
setAspectRatioMin(minValue) - Method in interface com.abbyy.mobile.uicomponents.scenario.ImageCaptureSettings
Sets the lower limit of the document's aspect ratio.
setAutoCaptureButtonVisible(isVisible) - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Shows or hides the button for automatic capture.
setAutoCaptureEnabled(isEnabled) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario
Enables the real-time capture from the camera preview. If the auto-capture mode is disabled, the image should be captured manually.
setCallback(callback) - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Sets the callback object for current image capture scenario.
setCallback(callback) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario
Sets the callback object for current multipage image capture scenario.
setCancelButtonVisible(isVisible) - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Shows or hides the cancel button, that closes the view.
setCaptureButtonVisible(isVisible) - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Shows or hides the button for taking photo manually.
setCaptureScenario(scenario) - Method in class com.abbyy.mobile.uicomponents.CaptureView
Sets the capture scenario.
setCaptureSettings(captureSettings) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder
Sets additional multipage image capture scenario processing settings.
setCropEnabled(isCropEnabled) - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Enables or disables the automatic crop option. In case this option is enabled, the fields around captured document will be cropped. Also perspective distortion will be corrected if needed.
setCustomColor(colorRes) - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Sets a custom color of the button for manual taking photo.
setDocumentSize(documentSize) - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Sets the physical size of the captured document.
setDocumentSize(documentSize) - Method in interface com.abbyy.mobile.uicomponents.scenario.ImageCaptureSettings
Sets the physical size of the captured document.
setFlashlightButtonVisible(isVisible) - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Shows or hides the flashlight button.
setFlashlightEnabled(isEnabled) - Method in interface com.abbyy.mobile.uicomponents.CaptureView.CameraSettings
Enables or disables the device flashlight torch mode.
setGalleryButtonVisible(isVisible) - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Shows or hides the button for choosing an image from photo gallery.
setImageFromGalleryMaxSize(size) - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Sets the maximum available size of an image, that can be loaded from the gallery
setImageFromGalleryMaxSize(size) - Method in interface com.abbyy.mobile.uicomponents.scenario.ImageCaptureSettings
Sets the maximum available size of an image, that can be loaded from the gallery
setManualCaptureEnabled(isEnabled) - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Enables manual capture buttons (photo and gallery) for user.
setMinimumDocumentToViewRatio(ratio) - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Sets the minimum document area relative to the whole frame area, required for capturing. If the document area is less the image will not be captured.
setMinimumDocumentToViewRatio(ratio) - Method in interface com.abbyy.mobile.uicomponents.scenario.ImageCaptureSettings
Sets the minimum document area relative to the whole frame area, required for capturing. If the document area is less the image will not be captured.
setRequestPermissionsResultCallback(callback) - Method in interface com.abbyy.mobile.uicomponents.CaptureView.ExtendedSettings
Sets the callback object for receiving the results for additional permission requests.
setRequiredPageCount(requiredPageCount) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder
Sets total number of pages to be captured.
setResolution(resolution) - Method in interface com.abbyy.mobile.uicomponents.CaptureView.CameraSettings
Sets camera resolution. Default value is Resolution.FULL_HD.
setShowPreviewEnabled(isShowPreviewEnabled) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder
Enables and disables image preview after capture.
setShowPreviewEnabled(isShowPreviewEnabled) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario
Enables and disables image preview after capture.
setStartAsEditorAtPage(pageId) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder
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.
setTheme(theme) - Method in interface com.abbyy.mobile.uicomponents.CaptureView.UISettings
Sets chosen theme for the user interface.
setUISettings(uiSettings) - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder
Sets appearance settings to the pages.
showInfoTip(tip, duration) - Method in class com.abbyy.mobile.uicomponents.CaptureView
Displays the specified string tip during a time period.
start() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Starts the capture scenario execution.
start() - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario
Starts the multipage image capture scenario execution.
startCamera() - Method in class com.abbyy.mobile.uicomponents.CaptureView
Starts the camera. It is recommended to call the method inside onResume or onStart methods of the Activity/Fragment lifecycle.
stop() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario
Stops the automatic capture process and releases the resources.
stop() - Method in class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario
Stops automatic and manual capture and releases the resources.
stopCamera() - Method in class com.abbyy.mobile.uicomponents.CaptureView
Stops the camera. It is recommended to call the method inside onPause or onStop methods of the Activity/Fragment lifecycle.
store(pageId, key, data) - Method in interface com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.PageStorage
Adds, removes or edits data, associated with the key of the page with the specified identifier.

T

toString() - Method in class com.abbyy.mobile.uicomponents.scenario.ImageCaptureScenario.DocumentSize
 

U

UISettings.Theme - Enum in com.abbyy.mobile.uicomponents
The user interface theme.
A B C D E G H I L M O P R S T U 
Skip navigation links