Ocrx.Contracts 2.4.1

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package Ocrx.Contracts --version 2.4.1
                    


                    

                
NuGet\Install-Package Ocrx.Contracts -Version 2.4.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Ocrx.Contracts" Version="2.4.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Ocrx.Contracts" Version="2.4.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Ocrx.Contracts" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Ocrx.Contracts --version 2.4.1
                    


                    

                
#r "nuget: Ocrx.Contracts, 2.4.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Ocrx.Contracts@2.4.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Ocrx.Contracts&version=2.4.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Ocrx.Contracts&version=2.4.1
                    


                            Install as a Cake Tool

OCRX.Contracts

The wire contract between the OCRX engine and its plugins: the generated Protocol Buffers code for CaptureEngineService (Track / ReadRoi / DumpFrame / GetStatus), plus the pure types both sides need in order to agree on what a region and a reading are.

Most plugin authors reference this only for RoiRect and the OCR/pixel result types — the rest of the surface is reached through Ocrx.Sdk, which is what a plugin should be written against. A plugin that names a generated proto type is a plugin that has to be recompiled when the wire changes.

Install

dotnet add package Ocrx.Contracts

Usually transitively, via Ocrx.Sdk.

The first OCRX package train is version 2.0.0.

What is in it

Type Role
RoiRect A region in reference space (2560x1440). What a plugin declares.
RoiScaler Maps reference space to frame space, one way only. The engine applies it; a plugin never maps a reported rect back.
OcrRegionResult, OcrLineInfo, OcrWordInfo An OCR reading, with per-word geometry for column-shaped UI.
PixelPatchSampler CPU-side BGRA sampling over a small pixel region — colour probes.
WireLimits The budgets a payload must stay inside (max pixel bytes, default/clamped OCR scale).
ProtocolVersion The integer version the handshake negotiates, distinct from any package version.
PipeContract The default named-pipe name.

Plain net10.0 and deliberately WinRT-free: a plugin referencing this must never gain a dependency on the capture stack.

Documentation

docs/PROTOCOL.md — transport, handshake, version policy, coordinate spaces. Changes to protos/capture.proto are lint- and breaking-change-checked by buf in CI.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Ocrx.Contracts:

Package Downloads
Ocrx.Sdk

Client SDK for writing Ocrx plugins. Implement IOcrxPlugin — a name, a set of screen regions, and what to do with one frame's OCR results — and hand it to OcrxPluginHost, which owns connecting, subscribing, reconnecting, and shutdown.
Ocrx.Sdk.Testing

Testing companion to Ocrx.Sdk: build engine-shaped ticks with TickDataBuilder, substitute the host's services with FakePluginServices, and run replay-parity tests against a real capture engine with ReplayHarness.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.4.1 0 9/16/2026
2.4.0 48 9/15/2026
2.3.0 63 9/14/2026
2.2.0 64 9/14/2026
2.1.1 72 9/14/2026
2.1.0 142 9/11/2026
2.0.0 110 9/7/2026