harmony 鸿蒙@ohos.multimodalAwareness.metadataBinding (回旋镖)

2025-06-16
浏览 (4)

@ohos.multimodalAwareness.metadataBinding (回旋镖)

本模块提供回旋镖能力调用，用于在图片加入和解析相关信息，完成信息传递。

说明：

本模块首批接口从API version 18开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块为系统接口。

导入模块

import { metadataBinding } from '@kit.MultimodalAwarenessKit';

encodeImage(image.PixelMap, string)

encodeImage(srcImage: image.PixelMap, metadata: string): Promise;
在图片中加入信息
系统能力：SystemCapability.MultimodalAwareness.metadataBinding 系统API：此接口为系统接口

参数：

参数名	类型	必填	说明
srcImage	PixelMap	是	原始图片。
metadata	string	是	嵌入的信息。
Promise	Promise	是	回调函数，返回嵌入信息的图片。

错误码:

以下错误码的详细介绍请参见回旋镖错误码和通用错误码。

错误码ID	错误信息
202	Permission check failed. A non-system application uses the system API.
32100001	Internal handling failed. File creation failed.
32100002	Encoding failed. Possible causes: 1. Image processing error; 2. Channel coding error.

示例：

import image from '@ohos.multimedia.image';
import { metadataBinding } from '@kit.MultimodalAwarenessKit';
import { BusinessError } from '@kit.BasicServicesKit';

let captureImage: image.PixelMap|undefined = undefined;
let metadata: string = "";
let srcImage: image.PixelMap|undefined = undefined;
metadataBinding.encodeImage(srcImage, metadata).then((pixelMap: image.PixelMap) =>{
	captureImage = pixelMap;
}).catch((error:BusinessError)=>{
	console.error("encode image error" + error);
});

decodeImage(image.PixelMap)

function decodeImage(encodedImage: image.PixelMap): Promise<string> 解析图片中携带的信息。

系统能力：SystemCapability.MultimodalAwareness.metadataBinding 系统API：此接口为系统接口

参数：

参数名	类型	必填	说明
encodedImage	PixelMap	是	带有信息的图片。
Promise	Promise<string>	是	回调函数，返回从图片解析出的信息。

错误码：

以下错误码的详细介绍请参见回旋镖错误码和通用错误码。

错误码ID	错误信息
202	Permission check failed. A non-system application uses the system API.
32100001	Internal handling failed. File creation failed.
32100003	Decoding failed. Possible causes: 1. Image not encoded; 2. Image destroyed.

示例：

import image from '@ohos.multimedia.image';
import { metadataBinding } from '@kit.MultimodalAwarenessKit';
import { BusinessError } from '@kit.BasicServicesKit';

let encodeImage: image.PixelMap|undefined = undefined;
let captrueMetadata: string = "";
metadataBinding.decodeImage(encodeImage).then((metadata: string) =>{
	captrueMetadata = metadata;
}).catch((error:BusinessError)=>{
	console.error("decode image error" + error);
});

notifyMetadataBindingEvent(string)

notifyMetadataBindingEvent(metadata: string): void；推送待嵌入的信息给调用编码接口的应用或服务。 系统能力：SystemCapability.MultimodalAwareness.metadataBinding 系统API：此接口为系统接口

参数：

参数名	类型	必填	说明
metadata	string	是	要嵌入图片中的信息。

错误码：

以下错误码的详细介绍请参见回旋镖错误码和通用错误码。

错误码ID	错误信息
32100001	Internal handling failed. File creation failed.

示例：

import { metadataBinding } from '@kit.MultimodalAwarenessKit';
import { BusinessError } from '@kit.BasicServicesKit';

let metadata:string = '';
metadataBinding.notifyMetadataBindingEvent(metadata).catch((error: BusinessError)=>{
  console.error("notify metadata error" + error);
});