Octobox API  4.1.0
Octobox Scripting API
Public Types | Properties
SCOcrResult

Object with the OCR results. More...

Public Types

enum  RecogResultTypes { Ocr, Barcode }
 Enumeration of Recognition result types. More...
 

Properties

IReadOnlyCollection< SCOcrLine > Lines [get]
 Collection of all lines in this recognition result. More...
 
string MediaFileName [get]
 Internal media file name this recognition result applies to. More...
 
IReadOnlyCollection< SCOcrPage > Pages [get]
 Collection of all pages in this recognition result. More...
 
Guid ProfileId [get]
 ID of the recognition profile that generated this result. More...
 
RecogResultTypes ResultType [get]
 Type of this recognition result (OCR or barcode). More...
 

Detailed Description

Object with the OCR results.

Member Enumeration Documentation

◆ RecogResultTypes

enum RecogResultTypes
strong

Enumeration of Recognition result types.

Enumerator
Ocr 

OCR result type.

Barcode 

Barcode result type.

Property Documentation

◆ Lines

IReadOnlyCollection<SCOcrLine> Lines
get

Collection of all lines in this recognition result.

◆ MediaFileName

string MediaFileName
get

Internal media file name this recognition result applies to.

◆ Pages

IReadOnlyCollection<SCOcrPage> Pages
get

Collection of all pages in this recognition result.

◆ ProfileId

Guid ProfileId
get

ID of the recognition profile that generated this result.

◆ ResultType

RecogResultTypes ResultType
get

Type of this recognition result (OCR or barcode).