Get Started

API Reference

Class

OcrEngineRunner

Edit on GitHub
Namespace OfficeIMO.Ocr
Assembly OfficeIMO.Ocr
Source OfficeIMO.Ocr/OcrEngineRunner.cs:19
Modifiers static

Coordinates bounded calls to a shared OCR engine instance.

Inheritance

  • Object
  • OcrEngineRunner

Methods

public static OcrEngineExecution CreateExecution(IOcrEngine engine) #
OfficeIMO.Ocr/OcrEngineRunner.cs:35
Returns: OcrEngineExecution

Captures one validated identity and capability snapshot for a logical OCR operation.

Parameters

engine OfficeIMO.Ocr.IOcrEngine requiredposition: 0
public static String GetValidatedEngineId(IOcrEngine engine) #
OfficeIMO.Ocr/OcrEngineRunner.cs:19
Returns: String

Reads and validates the stable identifier exposed by an OCR engine.

Parameters

engine OfficeIMO.Ocr.IOcrEngine requiredposition: 0
public static Task<OcrResult> RecognizeAsync(IOcrEngine engine, OcrRequest request, TimeSpan timeout, CancellationToken cancellationToken = null) #
OfficeIMO.Ocr/OcrEngineRunner.cs:54
Returns: Task<OcrResult>

Runs one recognition request within a total timeout. Engines that do not advertise concurrent-request support are serialized across every Reader, PDF, and caller integration using this method.

Parameters

engine OfficeIMO.Ocr.IOcrEngine requiredposition: 0
request OfficeIMO.Ocr.OcrRequest requiredposition: 1
timeout System.TimeSpan requiredposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3

Fields

public const Int32 MaximumEngineIdCharacters #

Maximum accepted length of an OCR engine identifier before surrounding whitespace is removed.

Value: 256