Zaya.OCR

Pluggable OCR and text-layout abstractions for the Zaya ecosystem — engines expose metadata and SettingDescriptors, hosts pass settings into CreateSessionAsync.

Packages

Package Version Role
Zaya.OCR 2.0.0 Abstractions: IOCRService, IOCRSession, ITextLayoutService; debug Ext for layout tracking
Zaya.OCR.Impl.OneOcr 2.0.0.0 Windows OneOCR (oneocr.dll via P/Invoke; no WinRT / App SDK identity)
Zaya.OCR.Impl.WindowsMediaOcr 2.0.0.0 Official Windows.Media.Ocr WinRT API (Windows 10+; typically needs MSIX identity)
Zaya.OCR.Impl.ProximityTextLayout 2.0.0.0 Merges OCR words into lines/paragraphs; optional stabilization, merge hysteresis, and word/line/paragraph filters

Requires Zaya.Primitives 2.0.0. Impl packages depend on Zaya.Logging 1.0.0. Update channel for plugins: plugin-Zaya.OCR-v2.0-latest. See versioning.

Features

  • IOCRService — engine id, localized name/description, Settings, PreferredPixelFormat, CreateSessionAsync
  • IOCRSession — RecognizeAsync(IRawImage) → IOCRResult (from Zaya.Primitives.OCR)
  • ITextLayoutService / ITextLayoutSession — ITextResult with Paragraphs + FullText
  • ITextLineExt / ITextParagraphExt — optional tracking/ghost for debug overlay
  • Failures surface as LocalizedException for host UI
  • Plugin Impl constructors take Zaya.Logging ILoggingWrapper

There is no separate InitializeAsync: create a session with defaults or an explicit settings dictionary.

Installation

<PackageReference Include="Zaya.OCR" Version="2.0.0" />
<PackageReference Include="Zaya.OCR.Impl.OneOcr" Version="2.0.0.0" />
<!-- optional -->
<PackageReference Include="Zaya.OCR.Impl.WindowsMediaOcr" Version="2.0.0.0" />
<PackageReference Include="Zaya.OCR.Impl.ProximityTextLayout" Version="2.0.0.0" />

Quick Start

using System.Drawing;
using Zaya.OCR.Impl.OneOcr;
using Zaya.OCR.Services;

using var ocr = new OneOcrService();

using var session = await ocr.CreateSessionAsync(new Dictionary<string, object>
{
    ["source"] = "auto",
    ["minConfidence"] = 40, // 0–100; default is 70
});

using var bitmap = new Bitmap(@"C:\screenshot.png");
var result = await session.RecognizeAsync(bitmap); // Bitmap extension in Impl.OneOcr

foreach (var word in result.Words)
    Console.WriteLine($"'{word.Text}' at {word.Bounds} ({word.Confidence:P0})");

Next Steps