public abstract class Engine
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static interface |
Engine.EngineSettings
Extended settings of the
Engine . |
static class |
Engine.LicenseException
The exception to be thrown when invalid license is loaded.
|
Constructor and Description |
---|
Engine() |
Modifier and Type | Method and Description |
---|---|
abstract IDataCaptureCoreAPI |
createDataCaptureCoreAPI()
Creates a data capture core API object for extracting data from image
|
abstract IDataCaptureService |
createDataCaptureService(java.lang.String profileName,
IDataCaptureService.Callback callback)
Creates a background recognition service to run in data capture mode.
|
abstract IImageCaptureService |
createImageCaptureService(IImageCaptureService.Callback callback)
Creates a background image capture service to run in image capture mode.
|
abstract IImagingCoreAPI |
createImagingCoreAPI()
Creates a core API object, which provides access to low-level single image processing functions for the current thread.
|
abstract IRecognitionCoreAPI |
createRecognitionCoreAPI()
Creates a core API object, which provides access to low-level single image processing functions for the current thread.
|
abstract ITextCaptureService |
createTextCaptureService(ITextCaptureService.Callback callback)
Creates a background recognition service to run in text capture mode.
|
abstract DataCapture.DataScheme[] |
getDataSchemesForProfile(java.lang.String profile) |
abstract Engine.EngineSettings |
getExtendedSettings()
Extended settings of the
Engine |
static Engine |
load(android.content.Context context,
java.lang.String licenseFilePath)
Loads the ABBYY RTR SDK engine.
|
abstract void |
unload()
Unloads the engine.
|
public static Engine load(android.content.Context context, java.lang.String licenseFilePath) throws java.io.IOException, Engine.LicenseException
context
- the application contextlicenseFilePath
- the path to the license file relative to the 'assets' directoryEngine
objectjava.io.IOException
- required library or resource not found or could not be loadedEngine.LicenseException
- the license is invalidpublic abstract void unload()
Explicitly unloading the engine is NOT required and NOT RECOMMENDED in most applications. Use this method only if in your application the engine is used in a separate activity which is not likely to be used repeatedly and you absolutely must reclaim the memory. If this is the case the most appropriate place to unload the engine is onDestroy method of that activity.
public abstract ITextCaptureService createTextCaptureService(ITextCaptureService.Callback callback)
callback
- the callback object used to interact with the serviceIRecognitionService
object configured to run in 'text capture' modepublic abstract IDataCaptureService createDataCaptureService(java.lang.String profileName, IDataCaptureService.Callback callback)
profileName
- the name of the asset containing the data scheme(s) and patterns required for data extractioncallback
- the callback object used to interact with the serviceIDataCaptureService
objectpublic abstract IImageCaptureService createImageCaptureService(IImageCaptureService.Callback callback)
callback
- the callback object used to interact with the serviceIImageCaptureService
object configured to run in 'image capture' modepublic abstract IRecognitionCoreAPI createRecognitionCoreAPI()
IRecognitionCoreAPI
objectpublic abstract IDataCaptureCoreAPI createDataCaptureCoreAPI()
IDataCaptureCoreAPI
objectpublic abstract IImagingCoreAPI createImagingCoreAPI()
IImagingCoreAPI
objectpublic abstract Engine.EngineSettings getExtendedSettings()
Engine
EngineSettings
objectpublic abstract DataCapture.DataScheme[] getDataSchemesForProfile(java.lang.String profile)