MrzReader.readMrz Method

Module: MrzReader

Definition

Detects and reads an MRZ in an image.

Python

read_mrz(self, image: DocumentImage) -> MrzReadingResult

Parameters

image DocumentImage

in Source image to process

Returns

MrzReadingResult

MRZ reading output.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

MrzReadingResult readMrz(DocumentImage image)

Parameters

image DocumentImage

in Source image to process

Returns

MrzReadingResult

MRZ reading output.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public MrzReadingResult ReadMrz(DocumentImage image)

Parameters

image DocumentImage

in Source image to process

Returns

MrzReadingResult

MRZ reading output.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public MrzReadingResult readMrz(DocumentImage image) throws DocumentException

Parameters

image DocumentImage

in Source image to process

Returns

MrzReadingResult

MRZ reading output.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public func readMrz(image: DocumentImage) throws -> MrzReadingResult

Parameters

image DocumentImage

in Source image to process

Returns

MrzReadingResult

MRZ reading output.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentMrzReader_ReadMrz (
    ID3_DOCUMENT_MRZ_READER hMrzReader,
    ID3_DOCUMENT_IMAGE hImage,
    ID3_DOCUMENT_MRZ_READING_RESULT hResult)

Parameters

hMrzReader ID3_DOCUMENT_MRZ_READER

in Handle to the MrzReader object.

hImage ID3_DOCUMENT_IMAGE

in Source image to process

hResult ID3_DOCUMENT_MRZ_READING_RESULT

out MRZ reading output.

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.