@capacitor/barcode-scanner

使用 Outsystems 条码库的 Capacitor 插件

安装

npm install @capacitor/barcode-scanner
npx cap sync

Android

条码扫描插件要求最低 Android SDK 目标版本为 26，这比您的 Capacitor 应用默认值要高。您可以在 android/variables.gradle 文件中更新此值。

ext {
    minSdkVersion = 26
}

您需要修改 android/build.gradle 文件中的 allprojects > repositories 部分，以包含 Outsystems 仓库。添加仓库后，您的 android/build.gradle 文件应与此类似。

allprojects {
    repositories {
        google()
        mavenCentral()
        maven {
            url 'https://pkgs.dev.azure.com/OutSystemsRD/9e79bc5b-69b2-4476-9ca5-d67594972a52/_packaging/PublicArtifactRepository/maven/v1'
            name 'Azure'
            credentials {
                username = "optional"
                password = ""
            }
            content {
                includeGroup "com.github.outsystems"
            }
        }
    }
}

iOS

条码扫描器使用设备上的摄像头。请确保在您的 Info.plist 文件中配置了 Privacy - Camera Usage Description（隐私 - 相机使用说明），以便您的应用可以访问设备的摄像头。

---

API

• scanBarcode(...)
• 类型别名
• 枚举

定义了能够扫描条码的插件合约的接口。 要求实现 scanBarcode 方法，该方法使用给定的选项启动条码扫描。

scanBarcode(...)

scanBarcode(options: CapacitorBarcodeScannerOptions) => Promise<CapacitorBarcodeScannerScanResult>

参数	类型
options	CapacitorBarcodeScannerOptions

返回值:

Promise<CapacitorBarcodeScannerScanResult>

---

类型别名

CapacitorBarcodeScannerScanResult

定义从条码扫描返回的结果结构。

{ ScanResult: string }

CapacitorBarcodeScannerOptions

定义用于配置条码扫描的选项。

{ hint: CapacitorBarcodeScannerTypeHint; scanInstructions?: string; scanButton?: boolean; scanText?: string; cameraDirection?: CapacitorBarcodeScannerCameraDirection; scanOrientation?: CapacitorBarcodeScannerScanOrientation; android?: { scanningLibrary?: CapacitorBarcodeScannerAndroidScanningLibrary; }; web?: { showCameraSelection?: boolean; scannerFPS?: number; }; }

CapacitorBarcodeScannerTypeHint

扩展了 Html5Qrcode 支持的格式，并添加了一个特殊的 'ALL' 选项，表示支持所有条码类型。 此类型定义结合了 Html5QrcodeSupportedFormats 和 OSBarcodeTypeHintALLOption，用于表示要扫描的条码类型的提示。

Html5QrcodeSupportedFormats | CapacitorBarcodeScannerTypeHintALLOption

枚举

Html5QrcodeSupportedFormats

成员	值
QR_CODE	0
AZTEC	1
CODABAR	2
CODE_39	3
CODE_93	4
CODE_128	5
DATA_MATRIX	6
MAXICODE	7
ITF	8
EAN_13	9
EAN_8	10
PDF_417	11
RSS_14	12
RSS_EXPANDED	13
UPC_A	14
UPC_E	15
UPC_EAN_EXTENSION	16

CapacitorBarcodeScannerTypeHintALLOption

成员	值
ALL	17

CapacitorBarcodeScannerCameraDirection

成员	值
BACK	1
FRONT	2

CapacitorBarcodeScannerScanOrientation

成员	值
PORTRAIT	1
LANDSCAPE	2
ADAPTIVE	3

CapacitorBarcodeScannerAndroidScanningLibrary

成员	值
ZXING	'zxing'
MLKIT	'mlkit'