【HarmonyOS NEXT 】鸿蒙detectBarcode (图像识码）

ConneyWu2024-06-21 19:05

本模块提供本地图片识码和图像数据识码能力，支持对图像中的条形码、二维码、多功能码进行识别，并获得码类型、码值、码位置信息。

**起始版本：**4.1.0(11)

导入模块

复制代码 
import { detectBarcode } from '@kit.ScanKit';

InputImage

待识别的图片信息。

**系统能力：**SystemCapability.Multimedia.Scan.ScanBarcode

**起始版本：**4.1.0(11)

名称 类型 只读 可选 说明
uri string 否 否 图片路径，例如file://media/Photo/x/xxx.jpg。

说明

推荐使用picker获取图片路径。

复制代码
javascript 复制代码 
import { photoAccessHelper } from '@kit.MediaLibraryKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

let PhotoSelectOptions = new photoAccessHelper.PhotoSelectOptions();
PhotoSelectOptions.MIMEType = photoAccessHelper.PhotoViewMIMETypes.IMAGE_TYPE;
PhotoSelectOptions.maxSelectNumber = 1;
PhotoSelectOptions.isPhotoTakingSupported = false;
PhotoSelectOptions.isEditSupported = false;
let photoPicker = new photoAccessHelper.PhotoViewPicker();
photoPicker.select(PhotoSelectOptions).then((result: photoAccessHelper.PhotoSelectResult) => {
  if (!result || (result.photoUris && result.photoUris.length === 0)) {
    hilog.error(0x0001, 'picker', 'Failed to get PhotoSelectResult by promise.');
    return;
  }
  hilog.info(0x0001, 'picker', `Succeeded in getting PhotoSelectResult by promise, result is ${JSON.stringify(result)}`); 
})

detectBarcode.decode

decode(inputImage: InputImage, options?: scanBarcode.ScanOptions): Promise<Array<scanBarcode.ScanResult>>

通过配置参数调用图片识码，使用Promise异步回调返回识码结果。

**系统能力：**SystemCapability.Multimedia.Scan.ScanBarcode

**起始版本：**4.1.0(11)

参数：

参数名 类型 必填 说明
inputImage InputImage 是 待识别的图片信息。
options scanBarcode.ScanOptions 否 启动图片识码参数。

返回值：

类型 说明
Promise<Array<scanBarcode.ScanResult>> Promise对象，返回识码结果对象。

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

错误码ID 错误信息
401 Parameter error.
1000500001 Internal error.

示例：

复制代码
javascript 复制代码 
import { scanCore, scanBarcode, detectBarcode } from '@kit.ScanKit';
import { picker } from '@kit.CoreFileKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 定义识码参数options
let options: scanBarcode.ScanOptions = { scanTypes: [scanCore.ScanType.ALL], enableMultiMode: true, enableAlbum: true }
// 通过picker拉起图库并选择图片
let photoOption = new picker.PhotoSelectOptions();
photoOption.MIMEType = picker.PhotoViewMIMETypes.IMAGE_TYPE;
photoOption.maxSelectNumber = 1;
let photoPicker = new picker.PhotoViewPicker();
photoPicker.select(photoOption).then((result) => {
  // 定义识码参数inputImage，其中uri为picker选择图片
  let inputImage: detectBarcode.InputImage = { uri: result.photoUris[0] }
  // 调用图片识码接口
  detectBarcode.decode(inputImage, options).then((result: Array<scanBarcode.ScanResult>) => {
    hilog.info(0x0001, '[Scan Sample]', `Succeeded in getting ScanResult by promise with options, result is ${JSON.stringify(result)}`);
  }).catch((error: BusinessError) => {
    hilog.error(0x0001, '[Scan Sample]', `Failed to get ScanResult by promise with options. Code: ${error.code}, message: ${error.message}`);
  });
})

detectBarcode.decode

decode(inputImage: InputImage, options: scanBarcode.ScanOptions, callback: AsyncCallback<Array<scanBarcode.ScanResult>>): void

通过配置参数调用图片识码，使用Callback异步回调返回识码结果。

**系统能力：**SystemCapability.Multimedia.Scan.ScanBarcode

**起始版本：**4.1.0(11)

参数：

参数名 类型 必填 说明
inputImage InputImage 是 待识别的图片信息。
options scanBarcode.ScanOptions 是 启动图片识码参数。
callback AsyncCallback<Array<scanBarcode.ScanResult>> 是 回调函数，当图片识码成功，err为undefined，data为获取到的识码结果Array<scanBarcode.ScanResult>，否则为错误对象。

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

错误码ID 错误信息
401 Parameter error.
1000500001 Internal error.

示例：

复制代码
javascript 复制代码 
import { picker } from '@kit.CoreFileKit';
import { scanCore, scanBarcode, detectBarcode } from '@kit.ScanKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 定义识码参数options
let options: scanBarcode.ScanOptions = { scanTypes: [scanCore.ScanType.ALL], enableMultiMode: true, enableAlbum: true }
// 通过选择模式拉起photoPicker界面，用户可以选择一个图片
let photoOption = new picker.PhotoSelectOptions();
photoOption.MIMEType = picker.PhotoViewMIMETypes.IMAGE_TYPE;
photoOption.maxSelectNumber = 1;
let photoPicker = new picker.PhotoViewPicker();
photoPicker.select(photoOption).then((result) => {
  // 定义识码参数inputImage，其中uri为picker选择图片
  let inputImage: detectBarcode.InputImage = { uri: result.photoUris[0] }
  // 调用图片识码接口
  detectBarcode.decode(inputImage, options, (error: BusinessError, result: Array<scanBarcode.ScanResult>) => {
    if (error && error.code) {
      hilog.error(0x0001, '[Scan Sample]', `Failed to get ScanResult by callback with options. Code: ${error.code}, message: ${error.message}`);
      return;
    }
    hilog.info(0x0001, '[Scan Sample]', `Succeeded in getting ScanResult by callback with options, result is ${JSON.stringify(result)}`);
  });
})

detectBarcode.decode

decode(inputImage: InputImage, callback: AsyncCallback<Array<scanBarcode.ScanResult>>): void

图片识码，使用Callback异步回调返回识码结果。

**系统能力：**SystemCapability.Multimedia.Scan.ScanBarcode

**起始版本：**4.1.0(11)

参数：

参数名 类型 必填 说明
inputImage InputImage 是 待识别的图片信息。
callback AsyncCallback<Array<scanBarcode.ScanResult>> 是 回调函数，当图片识码成功，err为undefined，data为获取到的识码结果Array<scanBarcode.ScanResult>，否则为错误对象。

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

错误码ID 错误信息
401 Parameter error.
1000500001 Internal error.

示例：

javascript 复制代码 
import { scanBarcode, detectBarcode } from '@kit.ScanKit';
import { picker } from '@kit.CoreFileKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 通过picker拉起图库并选择图片
let photoOption = new picker.PhotoSelectOptions();
photoOption.MIMEType = picker.PhotoViewMIMETypes.IMAGE_TYPE;
photoOption.maxSelectNumber = 1;
let photoPicker = new picker.PhotoViewPicker();
photoPicker.select(photoOption).then((result) => {
  // 定义识码参数inputImage，其中uri为picker选择图片
  let inputImage: detectBarcode.InputImage = { uri: result.photoUris[0] }
  // 调用图片识码接口
  detectBarcode.decode(inputImage, (error: BusinessError, result: Array<scanBarcode.ScanResult>) => {
    if (error && error.code) {
      hilog.error(0x0001, '[Scan Sample]', `Failed to get ScanResult by callback. Code: ${error.code}, message: ${error.message}`);
      return;
    }
    hilog.info(0x0001, '[Scan Sample]', `Succeeded in getting ScanResult by callback, result is ${JSON.stringify(result)}`);
  });
})

ByteImage

待识别的图像数据。

**系统能力：**SystemCapability.Multimedia.Scan.ScanBarcode

**起始版本：**5.0.0(12)

名称 类型 只读 可选 说明
byteBuffer ArrayBuffer 否 否 图像数据。
width number 否 否 图像宽度，单位：px。
height number 否 否 图像高度，单位：px。
format ImageFormat 否 否 图像数据类型。

示例：

javascript 复制代码 
import { detectBarcode } from '@kit.ScanKit';

// YUV图像的buffer, height, width数据，可通过相机预览流数据获取，比如获取宽高都是1080时
let byteImg: detectBarcode.ByteImage = {
  byteBuffer: buffer,
  width: 1080,
  height: 1080,
  format: detectBarcode.ImageFormat.NV21
};

ImageFormat

枚举，图像数据类型。

**系统能力：**SystemCapability.Multimedia.Scan.Barcode

**起始版本：**5.0.0(12)

名称 值 说明
NV21 0 图像格式为NV21。

DetectResult

识别结果。

**系统能力：**SystemCapability.Multimedia.Scan.ScanBarcode

**起始版本：**5.0.0(12)

名称 类型 只读 可选 说明
scanResults Array<scanBarcode.ScanResult> 否 否 扫码结果。
zoomValue number 否 否 相机可变焦距比，通过setZoomRatio控制相机实现变焦功能。 说明 1、使用Camera Kit getZoomRatio接口获取相机当前变焦比zoomRatio。 2、使用Camera Kit setZoomRatio接口设置targetRatio，目标值为zoomRatio * zoomValue。

detectBarcode.decodeImage

decodeImage(image: ByteImage, options?: scanBarcode.ScanOptions): Promise<DetectResult>

通过配置参数调用图像数据识码能力，使用Promise异步回调返回识码结果。

**系统能力：**SystemCapability.Multimedia.Scan.ScanBarcode

**起始版本：**5.0.0(12)

参数：

参数名 类型 只读 必填 说明
image ByteImage 否 是 待识别的图像数据。
options scanBarcode.ScanOptions 否 否 启动图像数据识码参数。

返回值：

类型 说明
Promise<DetectResult> Promise对象，返回图像数据识码结果对象。

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

错误码ID 错误信息
401 Parameter error.
1000500001 Internal error.

示例：

javascript 复制代码 
import { scanCore, scanBarcode, detectBarcode } from '@kit.ScanKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 优先获取图像的YuvByteBuffer, YuvHeight, YuvWidth数据，比如获取宽高都是1080时
let byteImg: detectBarcode.ByteImage = {
  byteBuffer: YuvByteBuffer,
  width: 1080,
  height: 1080,
  format: detectBarcode.ImageFormat.NV21
};
let options: scanBarcode.ScanOptions = {
  scanTypes: [scanCore.ScanType.ALL],
  enableMultiMode: true,
  enableAlbum: false
};
detectBarcode.decodeImage(byteImg, options).then((result: detectBarcode.DetectResult) => {
  hilog.info(0x0001, '[Scan Sample]', 'Succeeded in getting DetectResult by promise by promise with options, result is ${JSON.stringify(result)}');
}).catch((error: BusinessError) => {
  hilog.error(0x0001, '[Scan Sample]', `Failed to get DetectResult by promise with options. Code: ${error.code}, message: ${error.message}`);
})

说明

不支持并行调用。

内容来源 HarmonyOS NEXT API12 官方文档

相关推荐
楚疏笃31 分钟前
鸿蒙学习自由流转与分布式运行环境-跨端迁移(2)
分布式·学习·harmonyos
cdut_suye3 小时前
C++11新特性探索：Lambda表达式与函数包装器的实用指南
开发语言·数据库·c++·人工智能·python·机器学习·华为
楚疏笃4 小时前
鸿蒙学习自由流转与分布式运行环境-价值与架构定义(1)
学习·架构·harmonyos
SameX5 小时前
HarmonyOS Next 运用 FIDO 实现金融级安全认证实战
harmonyos
ChinaDragonDreamer7 小时前
HarmonyOS：应用沙箱
开发语言·harmonyos·鸿蒙
李洋-蛟龙腾飞公司7 小时前
HarmonyOS Next元服务大学之道动卡互动
华为·harmonyos
好看资源平台7 小时前
鸿蒙心路旅程：从实践到创新——开发者的深度技术分享
华为·harmonyos
长弓三石20 小时前
鸿蒙网络编程系列50-仓颉版TCP回声服务器示例
网络·tcp/ip·harmonyos
hhg21 小时前
【harmonyOS】启动框架----优化启动速度和分离初始化代码
harmonyos
热门推荐
01(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明02玄机平台应急响应—webshell查杀03【HarmonyOS】HUAWEI DevEco Studio 下载地址汇总04基于微信小程序的自习室预约系统的设计与实现05Docker 夺命连环 15 问06PyTorch机器学习实现液态神经网络0704 - matlab m_map地学绘图工具基础函数 - 设置网格08支付宝短视频平台创作分成激励项目09RAG 实践- Ollama+RagFlow 部署本地知识库10鸿蒙LiteOS+Hi3861智能家居网关设计：MQTT协议实现与代码示例