• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 元数据(ArkTS)
2<!--Kit: Camera Kit-->
3<!--Subsystem: Multimedia-->
4<!--Owner: @qano-->
5<!--Designer: @leo_ysl-->
6<!--Tester: @xchaosioda-->
7<!--Adviser: @zengyawen-->
8
9在开发相机应用时，需要先[申请相关权限](camera-preparation.md)。
10
11元数据（Metadata）是对相机返回的图像信息数据的描述和上下文，针对图像信息，提供的更详细的数据，如照片或视频中，识别人像的取景框坐标等信息。
12
13Metadata主要是通过一个TAG（Key），去找对应的Data，用于传递参数和配置信息，减少内存拷贝操作。
14
15## 开发步骤
16
17详细的API说明请参考[Camera API参考](../../reference/apis-camera-kit/arkts-apis-camera.md)。
18
191. 导入相关接口，导入方法如下。
20   ```ts
21   import { camera } from '@kit.CameraKit';
22   import { BusinessError } from '@kit.BasicServicesKit';
23   ```
24
252. 调用[CameraOutputCapability](../../reference/apis-camera-kit/arkts-apis-camera-i.md#cameraoutputcapability)中的supportedMetadataObjectTypes属性，获取当前设备支持的元数据类型，并通过[createMetadataOutput](../../reference/apis-camera-kit/arkts-apis-camera-CameraManager.md#createmetadataoutput)方法创建元数据输出流。
26
27   ```ts
28   function getMetadataOutput(cameraManager: camera.CameraManager, cameraOutputCapability: camera.CameraOutputCapability): camera.MetadataOutput | undefined {
29     let metadataObjectTypes: Array<camera.MetadataObjectType> = cameraOutputCapability.supportedMetadataObjectTypes;
30     let metadataOutput: camera.MetadataOutput | undefined = undefined;
31     try {
32       metadataOutput = cameraManager.createMetadataOutput(metadataObjectTypes);
33     } catch (error) {
34       let err = error as BusinessError;
35       console.error(`Failed to createMetadataOutput, error code: ${err.code}`);
36     }
37     return metadataOutput;
38   }
39   ```
40
413. 调用[Session.start](../../reference/apis-camera-kit/arkts-apis-camera-Session.md#start11)方法开启metadata数据输出，再通过监听事件metadataObjectsAvailable回调拿到数据，接口调用失败时，会返回相应错误码，错误码类型参见[Camera错误码](../../reference/apis-camera-kit/arkts-apis-camera-e.md#cameraerrorcode)。
42
43   previewOutput获取方式请参考[相机预览开发步骤](camera-preview.md#开发步骤)。
44
45   ```ts
46   async function startMetadataOutput(previewOutput: camera.PreviewOutput, metadataOutput: camera.MetadataOutput, cameraManager: camera.CameraManager): Promise<void> {
47     let cameraArray: Array<camera.CameraDevice> = [];
48     cameraArray = cameraManager.getSupportedCameras();
49     if (cameraArray.length == 0) {
50       console.error('no camera.');
51       return;
52     }
53     // 获取支持的模式类型。
54     let sceneModes: Array<camera.SceneMode> = cameraManager.getSupportedSceneModes(cameraArray[0]);
55     let isSupportPhotoMode: boolean = sceneModes.indexOf(camera.SceneMode.NORMAL_PHOTO) >= 0;
56     if (!isSupportPhotoMode) {
57       console.error('photo mode not support');
58       return;
59     }
60     let cameraInput: camera.CameraInput | undefined = undefined;
61     cameraInput = cameraManager.createCameraInput(cameraArray[0]);
62     if (cameraInput === undefined) {
63       console.error('cameraInput is undefined');
64       return;
65     }
66     // 打开相机。
67     await cameraInput.open();
68     let session: camera.PhotoSession = cameraManager.createSession(camera.SceneMode.NORMAL_PHOTO) as camera.PhotoSession;
69     session.beginConfig();
70     session.addInput(cameraInput);
71     session.addOutput(previewOutput);
72     session.addOutput(metadataOutput);
73     await session.commitConfig();
74     await session.start();
75   }
76   ```
77
784. 调用[Session.stop](../../reference/apis-camera-kit/arkts-apis-camera-Session.md#stop11)方法停止输出metadata数据，接口调用失败会返回相应错误码，错误码类型参见[Camera错误码](../../reference/apis-camera-kit/arkts-apis-camera-e.md#cameraerrorcode)。
79
80   ```ts
81   function stopMetadataOutput(session: camera.Session): void {
82     session.stop().then(() => {
83       console.info('Callback returned with session stopped.');
84     }).catch((err: BusinessError) => {
85       console.error(`Failed to session stop, error code: ${err.code}`);
86     });
87   }
88   ```
89
90## 状态监听
91
92在相机应用开发过程中，可以随时监听metadata数据以及输出流的状态。
93
94- 通过注册监听获取metadata对象，监听事件固定为metadataObjectsAvailable。检测到有效metadata数据时，callback返回相应的metadata数据信息，metadataOutput创建成功时可监听。
95
96  ```ts
97  function onMetadataObjectsAvailable(metadataOutput: camera.MetadataOutput): void {
98    metadataOutput.on('metadataObjectsAvailable', (err: BusinessError, metadataObjectArr: Array<camera.MetadataObject>) => {
99      if (err !== undefined && err.code !== 0) {
100        return;
101      }
102      console.info('metadata output metadataObjectsAvailable');
103    });
104  }
105  ```
106
107  > **说明：**
108  >
109  > 当前的元数据类型仅支持人脸检测（FACE_DETECTION）功能。元数据信息对象为识别到的人脸区域的矩形信息（Rect），包含矩形区域的左上角x坐标、y坐标和矩形的宽高数据。
110
111- 通过注册回调函数，获取监听metadata流的错误结果，callback返回metadata输出接口使用错误时返回的错误码，错误码类型参见[Camera错误码](../../reference/apis-camera-kit/arkts-apis-camera-e.md#cameraerrorcode)。
112
113  ```ts
114  function onMetadataError(metadataOutput: camera.MetadataOutput): void {
115    metadataOutput.on('error', (metadataOutputError: BusinessError) => {
116      console.error(`Metadata output error code: ${metadataOutputError.code}`);
117    });
118  }
119  ```
120