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