• 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深度信息表示图像中每个像素点与相机之间的距离关系，可以辅助实现更精准的对焦和背景虚化效果等。在相机应用预览、拍照和录像场景中，支持上报深度信息。
10
11## 开发步骤
12
13详细的API说明请参考[Camera API参考](../../reference/apis-camera-kit/arkts-apis-camera.md)。
14
151. 导入camera接口，接口中提供了相机相关的属性和方法，导入方法如下。
16
17   ```ts
18   import { camera } from '@kit.CameraKit';
19   import { BusinessError } from '@kit.BasicServicesKit';
20   ```
21
222. 通过[CameraOutputCapability](../../reference/apis-camera-kit/arkts-apis-camera-i.md#cameraoutputcapability)中的depthProfiles属性获取当前设备支持的深度能力，返回depthProfilesArray数组。通过[createDepthDataOutput](../../reference/apis-camera-kit/js-apis-camera-sys.md#createdepthdataoutput13)方法创建深度流。
23
24   ```ts
25   function getDepthDataOutput(cameraManager: camera.CameraManager,
26    cameraOutputCapability: camera.CameraOutputCapability): camera.DepthDataOutput | undefined {
27      let depthProfilesArray: Array<camera.DepthProfile> = cameraOutputCapability.depthProfiles;
28      if (!depthProfilesArray) {
29        console.error("createOutput depthProfilesArray is null");
30        return undefined;
31      }
32      let depthDataOutput: camera.DepthDataOutput | undefined = undefined;
33      try {
34        if (depthProfilesArray.length > 0) {
35          depthDataOutput = cameraManager.createDepthDataOutput(depthProfilesArray[0]);
36        } else {
37          console.log("the length of depthProfilesArray<=0!");
38          return undefined;
39        }
40      } catch (error) {
41        let err = error as BusinessError;
42        console.error(`Failed to create the DepthDataOutput instance. error: ${err}`);
43      }
44      return depthDataOutput;
45   }
46   ```
47
483. 使能。通过depthDataOutput的[start](../../reference/apis-camera-kit/js-apis-camera-sys.md#start13)方法输出深度流。接口调用失败会返回相应错误码，错误码类型参见[Camera错误码](../../reference/apis-camera-kit/arkts-apis-camera-e.md#cameraerrorcode)。
49
50   ```ts
51   async function startDepthDataOutput(depthDataOutput: camera.DepthDataOutput): Promise<void> {
52     if (!depthDataOutput) {
53       console.error('depthDataOutput Undefined');
54       return;
55     }
56     try {
57       await depthDataOutput.start();
58     } catch (err) {
59       const error = err as BusinessError;
60       console.error(`Failed to start depth data output. error: ${err}`);
61     }
62   }
63   ```
64
65## 状态监听
66
67在相机应用开发过程中，可以随时监听深度流的深度数据回调信息，以及深度流输出错误信息。
68
69- 通过注册固定的depthDataAvailable回调函数获取监听深度流数据。
70
71  ```ts
72  function onDepthDataAvailable(depthDataOutput: camera.DepthDataOutput): void {
73    depthDataOutput.on('depthDataAvailable', (err: BusinessError) => {
74      if (err !== undefined && err.code !== 0) {
75        return;
76      }
77      console.info('Depth data available');
78    });
79  }
80  ```
81
82- 通过注册固定的error回调函数获取监听深度流输出错误结果，callback返回深度输出接口使用错误时对应的错误码，错误码类型参见[Camera错误码](../../reference/apis-camera-kit/arkts-apis-camera-e.md#cameraerrorcode)。
83
84  ```ts
85  function onDepthDataOutputError(depthDataOutput: camera.DepthDataOutput): void {
86    depthDataOutput.on('error', (depthDataOutputError: BusinessError) => {
87      console.error(`Depth data output error code: ${depthDataOutputError.code}`);
88    });
89  }
90  ```
91