Skip to main content

Interface: CodeScanner

A scanner for detecting codes in a Camera Stream.

Properties​

codeTypes​

codeTypes: CodeType[]

The types of codes to configure the code scanner for.

Defined in​

types/CodeScanner.ts:70


onCodeScanned()​

onCodeScanned: (codes, frame) => void

A callback to call whenever the scanned codes change.

Parameters​

• codes: Code[]

The scanned codes, or an empty array if none.

• frame: CodeScannerFrame

The full area that is used for scanning. Code bounds and corners are relative to this frame.

Returns​

void

Defined in​

types/CodeScanner.ts:76


regionOfInterest?​

optional regionOfInterest: object

Crops the scanner's view area to the specific region of interest.

height​

height: number

width​

width: number

x​

x: number

y​

y: number

Platform​

iOS

Defined in​

types/CodeScanner.ts:82