@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仓库。添加后的配置示例如下：

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>

---

Type Aliases

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

Enums类型

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	'zxingly'
MLKIT	'mlkit'