• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 预览(ArkTS)
2
3在开发相机应用时，需要先参考开发准备[申请相关权限](camera-preparation.md)。
4
5预览是启动相机后看见的画面，通常在拍照和录像前执行。
6
7## 开发步骤
8
9详细的API说明请参考[Camera API参考](../../reference/apis-camera-kit/js-apis-camera.md)。
10
111. 导入camera接口，接口中提供了相机相关的属性和方法，导入方法如下。
12
13   ```ts
14   import { camera } from '@kit.CameraKit';
15   import { BusinessError } from '@kit.BasicServicesKit';
16   ```
17
182. 创建Surface。
19
20    相机开发模型为Surface模型，该模型主要通过Surface实现数据交互。在开发相机应用界面时，首先需要通过创建XComponent组件为预览流提供Surface，再通过获取XComponent组件对应Surface的ID创建预览流，预览流画面即可直接在XComponent组件内渲染，详细获取surfaceId请参考[getXComponentSurfaceId](../../reference/apis-arkui/arkui-ts/ts-basic-components-xcomponent.md#getxcomponentsurfaceid9)方法。而XComponent的能力由UI提供，相关介绍可参考[XComponent组件参考](../../reference/apis-arkui/arkui-ts/ts-basic-components-xcomponent.md)。
21
22    > **说明：**
23    > 预览流与录像输出流的分辨率的宽高比要保持一致，如果设置XComponent组件中的Surface显示区域宽高比为1920:1080 = 16:9，则需要预览流中的分辨率的宽高比也为16:9，如分辨率选择640:360，或960:540，或1920:1080，以此类推。
24
253. 通过[CameraOutputCapability](../../reference/apis-camera-kit/js-apis-camera.md#cameraoutputcapability)类中的previewProfiles属性获取当前设备支持的预览能力，返回previewProfilesArray数组 。通过[createPreviewOutput](../../reference/apis-camera-kit/js-apis-camera.md#createpreviewoutput)方法创建预览输出流，其中，[createPreviewOutput](../../reference/apis-camera-kit/js-apis-camera.md#createpreviewoutput)方法中的两个参数分别是当前设备支持的预览配置信息previewProfile和步骤二中获取的surfaceId。
26
27   ```ts
28   function getPreviewOutput(cameraManager: camera.CameraManager, cameraOutputCapability: camera.CameraOutputCapability, surfaceId: string): camera.PreviewOutput | undefined {
29     let previewProfilesArray: Array<camera.Profile> = cameraOutputCapability.previewProfiles;
30     let previewOutput: camera.PreviewOutput | undefined = undefined;
31     try {
32       //previewProfilesArray要选择与步骤二设置宽高比一致的previewProfile配置信息，此处选择数组第一项仅供接口使用示例参考。
33       previewOutput = cameraManager.createPreviewOutput(previewProfilesArray[0], surfaceId);
34     } catch (error) {
35       let err = error as BusinessError;
36       console.error("Failed to create the PreviewOutput instance. error code: " + err.code);
37     }
38     return previewOutput;
39   }
40   ```
41
424. 使能。通过[Session.start](../../reference/apis-camera-kit/js-apis-camera.md#start11)方法输出预览流，接口调用失败会返回相应错误码，错误码类型参见[Camera错误码](../../reference/apis-camera-kit/js-apis-camera.md#cameraerrorcode)。
43
44   ```ts
45   async function startPreviewOutput(cameraManager: camera.CameraManager, previewOutput: camera.PreviewOutput): Promise<void> {
46     let cameraArray: Array<camera.CameraDevice> = [];
47     cameraArray = cameraManager.getSupportedCameras();
48     if (cameraArray.length == 0) {
49       console.error('no camera.');
50       return;
51     }
52     // 获取支持的模式类型。
53     let sceneModes: Array<camera.SceneMode> = cameraManager.getSupportedSceneModes(cameraArray[0]);
54     let isSupportPhotoMode: boolean = sceneModes.indexOf(camera.SceneMode.NORMAL_PHOTO) >= 0;
55     if (!isSupportPhotoMode) {
56       console.error('photo mode not support');
57       return;
58     }
59     let cameraInput: camera.CameraInput | undefined = undefined;
60     cameraInput = cameraManager.createCameraInput(cameraArray[0]);
61     if (cameraInput === undefined) {
62       console.error('cameraInput is undefined');
63       return;
64     }
65     // 打开相机。
66     await cameraInput.open();
67     let session: camera.PhotoSession = cameraManager.createSession(camera.SceneMode.NORMAL_PHOTO) as camera.PhotoSession;
68     session.beginConfig();
69     session.addInput(cameraInput);
70     session.addOutput(previewOutput);
71     await session.commitConfig();
72     await session.start();
73   }
74   ```
75
76
77## 状态监听
78
79在相机应用开发过程中，可以随时监听预览输出流状态，包括预览流启动、预览流结束、预览流输出错误。
80
81- 通过注册固定的frameStart回调函数获取监听预览启动结果，previewOutput创建成功时即可监听，预览第一次曝光时触发，有该事件返回结果则认为预览流已启动。
82
83  ```ts
84  function onPreviewOutputFrameStart(previewOutput: camera.PreviewOutput): void {
85    previewOutput.on('frameStart', (err: BusinessError) => {
86      if (err !== undefined && err.code !== 0) {
87        return;
88      }
89      console.info('Preview frame started');
90    });
91  }
92  ```
93
94- 通过注册固定的frameEnd回调函数获取监听预览结束结果，previewOutput创建成功时即可监听，预览完成最后一帧时触发，有该事件返回结果则认为预览流已结束。
95
96  ```ts
97  function onPreviewOutputFrameEnd(previewOutput: camera.PreviewOutput): void {
98    previewOutput.on('frameEnd', (err: BusinessError) => {
99      if (err !== undefined && err.code !== 0) {
100        return;
101      }
102      console.info('Preview frame ended');
103    });
104  }
105  ```
106
107- 通过注册固定的error回调函数获取监听预览输出错误结果，回调返回预览输出接口使用错误时对应的错误码，错误码类型参见[Camera错误码](../../reference/apis-camera-kit/js-apis-camera.md#cameraerrorcode)。
108
109  ```ts
110  function onPreviewOutputError(previewOutput: camera.PreviewOutput): void {
111    previewOutput.on('error', (previewOutputError: BusinessError) => {
112      console.error(`Preview output error code: ${previewOutputError.code}`);
113    });
114  }
115  ```
116