For the complete documentation index, see llms.txt. This page is also available as Markdown.

codeReader

Optional QR code capture step after extracting the document.

Details

Attribute: code-reader

Type: CodeReader

Default value: CodeReader.Off

CodeReader

Member
Value
Description

Off

'off'

Does not open the code screen or download reader assets (default value).

Optional

'optional'

Opens the screen if the catalog requests it. If the capture budget is exhausted, it skips the code and emits extractionFinish no code data.

Mandatory

'mandatory'

Same as optional, but if the code is not read it shows timeout and emits extractionTimeout. The retry resumes code scanning, not the document.

Morphology

import { CodeReader } from '@facephi/selphid-web-component';

selphid.codeReader = CodeReader.Optional;

Description

Activates a step optional of QR/code capture during a document extraction in facephi-selphid-widget.

It does not replace or use barcode / barcodeSide: these control the document engine's barcode reader. codeReader mounts the same instance of <facephi-selphid> and is activated only with settings.codeReader.

The code result goes in event.detail.ocrResult (encoded e images), not in result.images. With tokenize: true, the current Tokenized payload uses keys such as qr_back_0 and qr_back_0_content.

Related telemetry states in trackStatus: codeInfo, readingCode, codesFinished.


Example

Last updated