OcrEngine

java.lang.Object

io.scanbot.sdk.ocr.OcrEngine

All Implemented Interfaces:: AutoCloseable

public class OcrEngine extends Object implements AutoCloseable

API for optical character recognition. Required licence feature(s): Ocr.

Constructor Summary

Constructors

Constructor

Description

OcrEngine()

Constructs OcrEngine with the given params.
Method Summary

Modifier and Type

Method

Description

void

close()

Closes native resources held by the object.

protected void

finalize()

Page

run(ImageRef image)

Recognize text in the given image.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- OcrEngine
  
  public OcrEngine() throws LicenseException
  
  Constructs OcrEngine with the given params.
  
  Throws:
  
  LicenseException - If license requirements for the API are not met
Method Details
- run
  
  public Page run(ImageRef image) throws InvalidImageRefException, LicenseException
  
  Recognize text in the given image.
  
  Parameters:
  
  image - The image to recognize text in.
  
  Returns:
  
  Page recognized in the image.
  
  Throws:
  
  InvalidImageRefException - If an invalid image reference is used
  
  LicenseException - If license requirements for the API are not met
- close
  
  public void close()
  
  Closes native resources held by the object.
  
  Specified by:
  
  close in interface AutoCloseable
- finalize
  
  protected void finalize() throws Throwable
  
  Overrides:
  
  finalize in class Object
  
  Throws:
  
  Throwable