目录

通过字节数组生成码图

基本概念

码图生成能力支持将字节数组转换为自定义格式的码图。

场景介绍

码图生成能力支持将字节数组转换为自定义格式的码图。

例如:调用码图生成能力, 将字节数组转换成交通一卡通二维码使用。

约束与限制

只支持QR Code生成,根据纠错水平不同对生成参数有不同的要求,参数限制可见下表,具体接口参数限制信息请参见CreateOptions。

Scan Kit识别该码图内容显示内容为乱码,这种字节数组需要专门的解码器解析,例如地铁闸机。

纠错水平

参数内容限制

LEVEL_L

字节数组长度限制建议不超过2048。

LEVEL_M

字节数组长度限制建议不超过2048。

LEVEL_Q

字节数组长度限制建议不超过1536。

LEVEL_H

字节数组长度限制建议不超过1024。

生成码参数建议:

  • 码图颜色和背景

    建议使用默认颜色和背景:黑色码图、白色背景。如果码图颜色和背景对比度较小会影响识别率。

  • 码图边距

    建议使用默认边距1,单位:px,取值范围:[1, 10]。

  • 码图大小

    输入的width和height值相同且均大于等于200小于等于4096,单位:px,否则生成的码图过小会影响识别。

业务流程

  1. 用户向应用发起生成码请求后,传入需要生成的码的信息,包括码的类型、宽高等。
  2. 应用通过调用Scan Kit的createBarcode接口启动码图生成能力。
  3. Scan Kit通过将字节数组转换为码图并返回给应用。
  4. 应用向用户返回生成码结果。

接口说明

通过字节数组生成码图,以Promise形式生成码图。具体API说明详见接口文档。

接口名

接口描述

createBarcode(content: ArrayBuffer, options: CreateOptions): Promise<image.PixelMap>

码图生成接口,返回image.PixelMap类型的参数,可以使用Image组件渲染成图片。使用Promise异步回调返回生成的码图。

开发步骤

码图生成根据传参内容直接生成所需码图,需要传入固定参数和可选参数。

以下示例为调用码图生成能力的createBarcode接口实现码图生成。

  1. 导入码图生成接口模块,该模块提供了码图生成的参数和方法,导入方法如下。
    // 导入码图生成需要的图片模块、错误码模块
    import { scanCore, generateBarcode } from '@kit.ScanKit';
    import { BusinessError } from '@kit.BasicServicesKit';
    import { image } from '@kit.ImageKit';
    import { hilog } from '@kit.PerformanceAnalysisKit';
    import { buffer } from '@kit.ArkTS';
  2. 调用码图生成能力的createBarcode接口实现码图生成。
    • 通过Promise方式回调,获取生成的码图。
      const TAG: string = 'Create barcode';
      
      @Entry
      @Component
      struct Index {
        @State pixelMap: image.PixelMap | undefined = undefined
        build() {
          Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
            Button('generateBarcode Promise').onClick(() => {
              this.pixelMap = undefined;
              let content: string =
      '0177C10DD10F7768600202312110000063458FD14112345678FFFFD381012610b746365409210201b66636540ad0200020000000000110e617003201000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000006645fbec664358ECF657CB40693c92da';
              let contentBuffer: ArrayBuffer = buffer.from(content, 'hex').buffer; // 通过包含十六进制字符的字符串创建Buffer
              let options: generateBarcode.CreateOptions = {
                scanType: scanCore.ScanType.QR_CODE,
                height: 400,
                width: 400
              }
              try {
                // 码图生成接口,成功返回PixelMap格式图片
                generateBarcode.createBarcode(contentBuffer, options).then((pixelMap: image.PixelMap) => {
                  this.pixelMap = pixelMap;
                  hilog.info(0x0001, TAG, 'Succeeded in creating barCode.');
                }).catch((error: BusinessError) => {
                  hilog.error(0x0001, TAG, `Failed to createBarCode. Code: ${error.code}, message: ${error.message}`);
                })
              } catch (error) {
                hilog.error(0x0001, TAG,
                  `Failed to createBarcode by Promise with options. Code: ${error.code}, message: ${error.message}`);
              }
            })
            // 获取生成码后显示
            if (this.pixelMap) {
              Image(this.pixelMap).width(300).height(300).objectFit(ImageFit.Contain)
            }
          }
          .width('100%')
          .height('100%')
        }
      }

模拟器开发

暂不支持模拟器使用,调用会返回错误信息“Emulator is not supported.”