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