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​

CodeScanner.ts:69


onCodeScanned​

• onCodeScanned: (codes: Code[], frame: CodeScannerFrame) => void

Type declaration​

â–¸ (codes, frame): void

A callback to call whenever the scanned codes change.

Parameters​
NameTypeDescription
codesCode[]The scanned codes, or an empty array if none.
frameCodeScannerFrameThe full area that is used for scanning. Code bounds and corners are relative to this frame.
Returns​

void

Defined in​

CodeScanner.ts:75


regionOfInterest​

• Optional regionOfInterest: Object

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

Platform

iOS

Type declaration​

NameType
heightnumber
widthnumber
xnumber
ynumber

Defined in​

CodeScanner.ts:81