• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 高性能拍照实践(仅对系统应用开放)(ArkTS)
2
3在开发相机应用时,需要先参考开发准备[申请相关权限](camera-preparation.md)。
4
5当前示例提供完整的高性能拍照流程介绍,方便开发者了解完整的接口调用顺序。
6
7在参考以下示例前,建议开发者查看[高性能拍照(仅对系统应用开放)(ArkTS)](camera-deferred-photo.md)的具体章节,了解[设备输入](camera-device-input.md)、[会话管理](camera-session-management.md)、[拍照](camera-shooting.md)等单个流程。
8
9## 开发流程
10
11在获取到相机支持的输出流能力后,开始创建拍照流,开发流程如下。
12
13![deferred-photo-development-process](figures/deferred-photo-development-process.png)
14
15## 完整示例
16
17Context获取方式请参考:[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
18
19```ts
20import { camera } from '@kit.CameraKit';
21import { image } from '@kit.ImageKit';
22import { BusinessError } from '@kit.BasicServicesKit';
23import { fileIo, fileUri } from '@kit.CoreFileKit';
24import { photoAccessHelper } from '@kit.MediaLibraryKit';
25
26// 写文件方式落盘真图。
27async function savePicture(photoObj: camera.Photo, context: Context, showSaveToMediaLibrary: boolean = true): Promise<void> {
28  let filePath = `${context.filesDir}/${Date.now()}.jpg`;
29  let file = fileIo.openSync(filePath, fileIo.OpenMode.READ_WRITE | fileIo.OpenMode.CREATE);
30  let buffer: ArrayBuffer | undefined = undefined;
31  let component = await photoObj.main.getComponent(image.ComponentType.JPEG);
32  if (component === undefined) {
33    console.error('getComponent failed');
34    return;
35  }
36  if (component.byteBuffer) {
37    buffer = component.byteBuffer;
38  } else {
39    console.error('byteBuffer is null');
40    return;
41  }
42  if (buffer) {
43    fileIo.writeSync(file.fd, buffer);
44    if (showSaveToMediaLibrary) {
45      await saveToMediaLibrary(context, filePath, file.fd);
46    } else {
47      fileIo.closeSync(file.fd);
48    }
49  }
50}
51
52async function saveToMediaLibrary(context: Context, filePath: string, fd: number): Promise<void> {
53  let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(context);
54  try {
55    let res = fileIo.accessSync(filePath);
56    if (res) {
57      await fileIo.unlink(filePath);
58    }
59    // 指定待保存到媒体库的位于应用沙箱的图片uri。
60    let srcFileUri = fileUri.getUriFromPath(filePath); // 获取资源的绝对路径
61    let srcFileUris: Array<string> = [
62      srcFileUri // 需要传入绝对路径
63    ];
64    // 指定待保存照片的创建选项,包括文件后缀和照片类型,标题和照片子类型可选。
65    let photoCreationConfigs: Array<photoAccessHelper.PhotoCreationConfig> = [
66      {
67        title: 'test', // 可选。
68        fileNameExtension: 'jpg',
69        photoType: photoAccessHelper.PhotoType.IMAGE,
70        subtype: photoAccessHelper.PhotoSubtype.DEFAULT, // 可选。
71      }
72    ];
73    // 基于弹窗授权的方式获取媒体库的目标uri。
74    let desFileUris: Array<string> = await phAccessHelper.showAssetsCreationDialog(srcFileUris, photoCreationConfigs);
75    // 将来源于应用沙箱的照片内容写入媒体库的目标uri。
76    let desFile: fileIo.File = await fileIo.open(desFileUris[0], fileIo.OpenMode.WRITE_ONLY);
77    await fileIo.copyFile(fd, desFile.fd);
78    fileIo.closeSync(fd);
79    fileIo.closeSync(desFile);
80    console.info('create asset by dialog successfully');
81  } catch (err) {
82    console.error(`failed to create asset by dialog successfully errCode is: ${err.code}, ${err.message}`);
83  }
84}
85
86// 调用媒体库方式落盘缩略图。
87async function saveDeferredPhoto(proxyObj: camera.DeferredPhotoProxy, context: Context): Promise<void> {
88  try {
89    // 创建 photoAsset。
90    let accessHelper = photoAccessHelper.getPhotoAccessHelper(context);
91    let testFileName = 'testFile' + Date.now() + '.jpg';
92    let photoAsset = await accessHelper.createAsset(testFileName);
93    // 将缩略图代理类传递给媒体库。
94    let mediaRequest: photoAccessHelper.MediaAssetChangeRequest = new photoAccessHelper.MediaAssetChangeRequest(photoAsset);
95    mediaRequest.addResource(photoAccessHelper.ResourceType.PHOTO_PROXY, proxyObj);
96    let res = await accessHelper.applyChanges(mediaRequest);
97    console.info('saveDeferredPhoto success.');
98  } catch (err) {
99    console.error(`Failed to saveDeferredPhoto. error: ${err}`);
100  }
101}
102
103async function deferredPhotoCase(context: Context, surfaceId: string): Promise<void> {
104  // 创建CameraManager对象。
105  let cameraManager: camera.CameraManager = camera.getCameraManager(context);
106  if (!cameraManager) {
107    console.error("camera.getCameraManager error");
108    return;
109  }
110  // 监听相机状态变化。
111  cameraManager.on('cameraStatus', (err: BusinessError, cameraStatusInfo: camera.CameraStatusInfo) => {
112    if (err !== undefined && err.code !== 0) {
113      console.error(`cameraStatus with errorCode: ${err.code}`);
114      return;
115    }
116    console.info(`camera : ${cameraStatusInfo.camera.cameraId}`);
117    console.info(`status: ${cameraStatusInfo.status}`);
118  });
119
120  // 获取相机列表。
121  let cameraArray: Array<camera.CameraDevice> = cameraManager.getSupportedCameras();
122  if (cameraArray.length <= 0) {
123    console.error("cameraManager.getSupportedCameras error");
124    return;
125  }
126
127  for (let index = 0; index < cameraArray.length; index++) {
128    console.info('cameraId : ' + cameraArray[index].cameraId);                          // 获取相机ID。
129    console.info('cameraPosition : ' + cameraArray[index].cameraPosition);              // 获取相机位置。
130    console.info('cameraType : ' + cameraArray[index].cameraType);                      // 获取相机类型。
131    console.info('connectionType : ' + cameraArray[index].connectionType);              // 获取相机连接类型。
132  }
133
134  // 创建相机输入流。
135  let cameraInput: camera.CameraInput | undefined = undefined;
136  try {
137    cameraInput = cameraManager.createCameraInput(cameraArray[0]);
138  } catch (error) {
139    let err = error as BusinessError;
140    console.error('Failed to createCameraInput errorCode = ' + err.code);
141  }
142  if (cameraInput === undefined) {
143    return;
144  }
145
146  // 监听cameraInput错误信息。
147  let cameraDevice: camera.CameraDevice = cameraArray[0];
148  cameraInput.on('error', cameraDevice, (error: BusinessError) => {
149    console.error(`Camera input error code: ${error.code}`);
150  })
151
152  // 打开相机。
153  await cameraInput.open();
154
155  // 获取支持的模式类型。
156  let sceneModes: Array<camera.SceneMode> = cameraManager.getSupportedSceneModes(cameraArray[0]);
157  let isSupportPhotoMode: boolean = sceneModes.indexOf(camera.SceneMode.NORMAL_PHOTO) >= 0;
158  if (!isSupportPhotoMode) {
159    console.error('photo mode not support');
160    return;
161  }
162  // 获取相机设备支持的输出流能力。
163  let cameraOutputCap: camera.CameraOutputCapability = cameraManager.getSupportedOutputCapability(cameraArray[0], camera.SceneMode.NORMAL_PHOTO);
164  if (!cameraOutputCap) {
165    console.error("cameraManager.getSupportedOutputCapability error");
166    return;
167  }
168  console.info("outputCapability: " + JSON.stringify(cameraOutputCap));
169
170  let previewProfilesArray: Array<camera.Profile> = cameraOutputCap.previewProfiles;
171  if (!previewProfilesArray) {
172    console.error("createOutput previewProfilesArray == null || undefined");
173  }
174
175  let photoProfilesArray: Array<camera.Profile> = cameraOutputCap.photoProfiles;
176  if (!photoProfilesArray) {
177    console.error("createOutput photoProfilesArray == null || undefined");
178  }
179
180  // 创建预览输出流,其中参数 surfaceId 参考上文 XComponent 组件,预览流为XComponent组件提供的surface。
181  let previewOutput: camera.PreviewOutput | undefined = undefined;
182  try {
183    previewOutput = cameraManager.createPreviewOutput(previewProfilesArray[0], surfaceId);
184  } catch (error) {
185    let err = error as BusinessError;
186    console.error(`Failed to create the PreviewOutput instance. error code: ${err.code}`);
187  }
188  if (previewOutput === undefined) {
189    return;
190  }
191  // 监听预览输出错误信息。
192  previewOutput.on('error', (error: BusinessError) => {
193    console.error(`Preview output error code: ${error.code}`);
194  });
195  // 创建拍照输出流。
196  let photoOutput: camera.PhotoOutput | undefined = undefined;
197  try {
198    photoOutput = cameraManager.createPhotoOutput(photoProfilesArray[0]);
199  } catch (error) {
200    let err = error as BusinessError;
201    console.error('Failed to createPhotoOutput errorCode = ' + err.code);
202  }
203  if (photoOutput === undefined) {
204    return;
205  }
206  //创建会话。
207  let photoSession: camera.PhotoSession | undefined = undefined;
208  try {
209    photoSession = cameraManager.createSession(camera.SceneMode.NORMAL_PHOTO) as camera.PhotoSession;
210  } catch (error) {
211    let err = error as BusinessError;
212    console.error('Failed to create the photoSession instance. errorCode = ' + err.code);
213  }
214  if (photoSession === undefined) {
215    return;
216  }
217  // 监听session错误信息。
218  photoSession.on('error', (error: BusinessError) => {
219    console.error(`Capture session error code: ${error.code}`);
220  });
221
222  // 开始配置会话。
223  try {
224    photoSession.beginConfig();
225  } catch (error) {
226    let err = error as BusinessError;
227    console.error('Failed to beginConfig. errorCode = ' + err.code);
228  }
229
230  // 向会话中添加相机输入流。
231  try {
232    photoSession.addInput(cameraInput);
233  } catch (error) {
234    let err = error as BusinessError;
235    console.error('Failed to addInput. errorCode = ' + err.code);
236  }
237
238  // 向会话中添加预览输出流。
239  try {
240    photoSession.addOutput(previewOutput);
241  } catch (error) {
242    let err = error as BusinessError;
243    console.error('Failed to addOutput(previewOutput). errorCode = ' + err.code);
244  }
245
246  // 向会话中添加拍照输出流。
247  try {
248    photoSession.addOutput(photoOutput);
249  } catch (error) {
250    let err = error as BusinessError;
251    console.error('Failed to addOutput(photoOutput). errorCode = ' + err.code);
252  }
253
254  // 注册原图回调监听。
255  photoOutput.on('photoAvailable', (err: BusinessError, photoObj: camera.Photo): void => {
256    if (err) {
257      console.info(`photoAvailable error: ${err}.`);
258      return;
259    }
260    savePicture(photoObj, context).then(() => {
261      // 落盘完成后,释放photo对象。
262      photoObj.release();
263    });
264  });
265
266  // 注册分段式缩略图代理回调监听。
267  photoOutput.on('deferredPhotoProxyAvailable', (err: BusinessError, proxyObj: camera.DeferredPhotoProxy): void => {
268    if (err) {
269      console.info(`deferredPhotoProxyAvailable error: ${err}.`);
270      return;
271    }
272    console.info('photoOutPutCallBack deferredPhotoProxyAvailable');
273    // 获取缩略图 pixelMap。
274    proxyObj.getThumbnail().then((thumbnail: image.PixelMap) => {
275      AppStorage.setOrCreate('proxyThumbnail', thumbnail);
276    });
277    // 调用媒体库接口落盘缩略图。
278    saveDeferredPhoto(proxyObj, context).then(() => {
279      // 落盘完成后,释放代理类对象。
280      proxyObj.release();
281    });
282  });
283
284  // 判断是否支持分段式拍照能力。
285  let isSupportDeferred: boolean = photoOutput.isDeferredImageDeliverySupported(camera.DeferredDeliveryImageType.PHOTO);
286  console.info('isDeferredImageDeliverySupported res:' + isSupportDeferred);
287  if (isSupportDeferred) {
288    // 使能分段式拍照。
289	photoOutput.deferImageDelivery(camera.DeferredDeliveryImageType.PHOTO);
290    // 查询使能分段式结果。
291    let isSupportEnabled: boolean = photoOutput.isDeferredImageDeliveryEnabled(camera.DeferredDeliveryImageType.PHOTO);
292    console.info('isDeferredImageDeliveryEnabled res:' + isSupportEnabled);
293  }
294
295  // 提交会话配置。
296  await photoSession.commitConfig();
297
298  // 启动会话。
299  await photoSession.start().then(() => {
300    console.info('Promise returned to indicate the session start success.');
301  });
302  // 判断设备是否支持闪光灯。
303  let flashStatus: boolean = false;
304  try {
305    flashStatus = photoSession.hasFlash();
306  } catch (error) {
307    let err = error as BusinessError;
308    console.error('Failed to hasFlash. errorCode = ' + err.code);
309  }
310  console.info('Returned with the flash light support status:' + flashStatus);
311
312  if (flashStatus) {
313    // 判断是否支持自动闪光灯模式。
314    let flashModeStatus: boolean = false;
315    try {
316      let status: boolean = photoSession.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO);
317      flashModeStatus = status;
318    } catch (error) {
319      let err = error as BusinessError;
320      console.error('Failed to check whether the flash mode is supported. errorCode = ' + err.code);
321    }
322    if(flashModeStatus) {
323      // 设置自动闪光灯模式。
324      try {
325        photoSession.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO);
326      } catch (error) {
327        let err = error as BusinessError;
328        console.error('Failed to set the flash mode. errorCode = ' + err.code);
329      }
330    }
331  }
332
333  // 判断是否支持连续自动变焦模式。
334  let focusModeStatus: boolean = false;
335  try {
336    let status: boolean = photoSession.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_CONTINUOUS_AUTO);
337    focusModeStatus = status;
338  } catch (error) {
339    let err = error as BusinessError;
340    console.error('Failed to check whether the focus mode is supported. errorCode = ' + err.code);
341  }
342
343  if (focusModeStatus) {
344    // 设置连续自动变焦模式。
345    try {
346      photoSession.setFocusMode(camera.FocusMode.FOCUS_MODE_CONTINUOUS_AUTO);
347    } catch (error) {
348      let err = error as BusinessError;
349      console.error('Failed to set the focus mode. errorCode = ' + err.code);
350    }
351  }
352
353  // 获取相机支持的可变焦距比范围。
354  let zoomRatioRange: Array<number> = [];
355  try {
356    zoomRatioRange = photoSession.getZoomRatioRange();
357  } catch (error) {
358    let err = error as BusinessError;
359    console.error('Failed to get the zoom ratio range. errorCode = ' + err.code);
360  }
361  if (zoomRatioRange.length <= 0) {
362    return;
363  }
364  // 设置可变焦距比。
365  try {
366    photoSession.setZoomRatio(zoomRatioRange[0]);
367  } catch (error) {
368    let err = error as BusinessError;
369    console.error('Failed to set the zoom ratio value. errorCode = ' + err.code);
370  }
371  let photoCaptureSetting: camera.PhotoCaptureSetting = {
372    quality: camera.QualityLevel.QUALITY_LEVEL_HIGH, // 设置图片质量高。
373    rotation: camera.ImageRotation.ROTATION_0 // 设置图片旋转角度0。
374  }
375  // 使用当前拍照设置进行拍照。
376  photoOutput.capture(photoCaptureSetting, (err: BusinessError) => {
377    if (err) {
378      console.error(`Failed to capture the photo ${err.message}`);
379      return;
380    }
381    console.info('Callback invoked to indicate the photo capture request success.');
382  });
383
384  // 需要在拍照结束之后调用以下关闭相机和释放会话流程,避免拍照未结束就将会话释放。
385  // 停止当前会话。
386  await photoSession.stop();
387
388  // 释放相机输入流。
389  await cameraInput.close();
390
391  // 释放预览输出流。
392  await previewOutput.release();
393
394  // 释放拍照输出流。
395  await photoOutput.release();
396
397  // 释放会话。
398  await photoSession.release();
399
400  // 会话置空。
401  photoSession = undefined;
402}
403```