@tauri-apps/plugin-barcode-scanner

Functions

cancel()

function cancel(): Promise<void>;

Defined in: plugins/barcode-scanner/guest-js/index.ts:70

Cancel the current scan process.

Returns

Promise<void>

---

checkPermissions()

function checkPermissions(): Promise<PermissionState>;

Defined in: plugins/barcode-scanner/guest-js/index.ts:77

Get permission state.

Returns

Promise<PermissionState>

---

openAppSettings()

function openAppSettings(): Promise<void>;

Defined in: plugins/barcode-scanner/guest-js/index.ts:95

Open application settings. Useful if permission was denied and the user must manually enable it.

Returns

Promise<void>

---

requestPermissions()

function requestPermissions(): Promise<PermissionState>;

Defined in: plugins/barcode-scanner/guest-js/index.ts:86

Request permissions to use the camera.

Returns

Promise<PermissionState>

---

scan()

function scan(options?: ScanOptions): Promise<Scanned>;

Defined in: plugins/barcode-scanner/guest-js/index.ts:63

Start scanning.

Parameters

Parameter	Type	Description
options?	ScanOptions	-

Returns

Promise<Scanned>

Enumerations

Format

Defined in: plugins/barcode-scanner/guest-js/index.ts:13

Enumeration Members

Enumeration Member	Value	Description	Defined in
Aztec	"AZTEC"	-	plugins/barcode-scanner/guest-js/index.ts:30
Codabar	"CODABAR"	Not supported on iOS.	plugins/barcode-scanner/guest-js/index.ts:28
Code128	"CODE_128"	-	plugins/barcode-scanner/guest-js/index.ts:24
Code39	"CODE_39"	-	plugins/barcode-scanner/guest-js/index.ts:22
Code93	"CODE_93"	-	plugins/barcode-scanner/guest-js/index.ts:23
DataMatrix	"DATA_MATRIX"	-	plugins/barcode-scanner/guest-js/index.ts:31
EAN13	"EAN_13"	-	plugins/barcode-scanner/guest-js/index.ts:21
EAN8	"EAN_8"	-	plugins/barcode-scanner/guest-js/index.ts:20
GS1DataBar	"GS1_DATA_BAR"	Not supported on Android. Requires iOS 15.4+	plugins/barcode-scanner/guest-js/index.ts:36
GS1DataBarExpanded	"GS1_DATA_BAR_EXPANDED"	Not supported on Android. Requires iOS 15.4+	plugins/barcode-scanner/guest-js/index.ts:44
GS1DataBarLimited	"GS1_DATA_BAR_LIMITED"	Not supported on Android. Requires iOS 15.4+	plugins/barcode-scanner/guest-js/index.ts:40
ITF	"ITF"	-	plugins/barcode-scanner/guest-js/index.ts:29
PDF417	"PDF_417"	-	plugins/barcode-scanner/guest-js/index.ts:32
QRCode	"QR_CODE"	-	plugins/barcode-scanner/guest-js/index.ts:14
UPC_A	"UPC_A"	Not supported on iOS.	plugins/barcode-scanner/guest-js/index.ts:18
UPC_E	"UPC_E"	-	plugins/barcode-scanner/guest-js/index.ts:19

Interfaces

Scanned

Defined in: plugins/barcode-scanner/guest-js/index.ts:53

Properties

Property	Type	Defined in
bounds	unknown	plugins/barcode-scanner/guest-js/index.ts:56
content	string	plugins/barcode-scanner/guest-js/index.ts:54
format	Format	plugins/barcode-scanner/guest-js/index.ts:55

---

ScanOptions

Defined in: plugins/barcode-scanner/guest-js/index.ts:47

Properties

Property	Type	Defined in
cameraDirection?	"back" | "front"	plugins/barcode-scanner/guest-js/index.ts:48
formats?	Format[]	plugins/barcode-scanner/guest-js/index.ts:49
windowed?	boolean	plugins/barcode-scanner/guest-js/index.ts:50

Type Aliases

PermissionState

type PermissionState = "granted" | "denied" | "prompt" | "prompt-with-rationale";

Defined in: @tauri-apps/api/core.d.ts:87