Class OcrEngine

API for optical character recognition.

Required licence feature(s): Ocr.

Index

Methods

destroy run create

Methods

destroy

destroy(): Promise<void>
Frees up any resources associated with this object. No other methods may be called on this object after destroy has been called.

Returns Promise<void>

run

run(image, consumeImage?): Promise<OcrEngineRunResponse>
Recognize text in the given image.
Parameters
- image: Image
  The image to recognize text in.
- Optional consumeImage: Config.ConsumeType
  Controls if the image can still be used after calling this method, or if it will be consumed by the method. See ConsumeType for more details.
Returns Promise<OcrEngineRunResponse>
Page recognized in the image.

`Static` create

create(workerBridge): Promise<OcrEngine>
Parameters
- workerBridge: WorkerBridge
Returns Promise<OcrEngine>

Generated using TypeDoc