只支持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,否则生成的码图过小会影响识别。

通过字节数组生成码图,以Promise形式生成码图。具体API说明详见接口文档。
接口名 | 接口描述 |
|---|---|
createBarcode(content: ArrayBuffer, options: CreateOptions): Promise<image.PixelMap> | 码图生成接口,返回image.PixelMap类型的参数,可以使用Image组件渲染成图片。使用Promise异步回调返回生成的码图。 |
码图生成根据传参内容直接生成所需码图,需要传入固定参数和可选参数。
以下示例为调用码图生成能力的createBarcode接口实现码图生成。
// 导入码图生成需要的图片模块、错误码模块
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';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%')
}
}