3f5dff76创建于 2025年2月28日历史提交

相机启动恢复实现方案(ArkTS)

当前示例提供完整的相机应用从后台切换至前台启动恢复的流程介绍,方便开发者了解完整的接口调用顺序。

相机应用在前后台切换过程中的状态变化说明:

  • 当相机应用在退后台之后由于安全策略会被强制断流,并且此时相机状态回调会返回相机可用状态,表示当前相机设备已经被关闭,处于空闲状态。
  • 当相机应用从后台切换至前台时,相机状态回调会返回相机不可用状态,表示当前相机设备被打开,处于忙碌状态。
  • 相机应用从后台切换至前台时,需要重启相机设备的预览流、拍照流以及相机会话管理。

在参考以下示例前,建议开发者建议开发者查看相机开发指导(ArkTS)的具体章节,了解相机管理设备输入会话管理等单个操作。

开发流程

相机应用从后台切换至前台启动恢复调用流程图建议如下:

Camera Background recovery processing

完整示例

Context获取方式请参考:获取UIAbility的上下文信息

相机应用从后台切换至前台启动恢复需要在页面生命周期回调函数onPageShow中调用,重新初始化相机设备。

import { camera } from '@kit.CameraKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';

let context: common.BaseContext;
let surfaceId: string = '';
async function onPageShow(): Promise<void> {
   // 当应用从后台切换至前台页面显示时,重新初始化相机设备。
   await initCamera(context, surfaceId);
}

async function initCamera(baseContext: common.BaseContext, surfaceId: string): Promise<void> {
   console.info('onForeGround recovery begin.');
   let cameraManager: camera.CameraManager = camera.getCameraManager(context);
   if (!cameraManager) {
     console.error("camera.getCameraManager error");
     return;
   }
   // 监听相机状态变化。
   cameraManager.on('cameraStatus', (err: BusinessError, cameraStatusInfo: camera.CameraStatusInfo) => {
       if (err !== undefined && err.code !== 0) {
         console.error('cameraStatus with errorCode = ' + err.code);
         return;
       }
       console.info(`camera : ${cameraStatusInfo.camera.cameraId}`);
       console.info(`status: ${cameraStatusInfo.status}`);
     });

   // 获取相机列表。
   let cameraArray: Array<camera.CameraDevice> = cameraManager.getSupportedCameras();
   if (cameraArray.length <= 0) {
     console.error("cameraManager.getSupportedCameras error");
     return;
   }

   for (let index = 0; index < cameraArray.length; index++) {
     console.info('cameraId : ' + cameraArray[index].cameraId);                       // 获取相机ID。
     console.info('cameraPosition : ' + cameraArray[index].cameraPosition);           // 获取相机位置。
     console.info('cameraType : ' + cameraArray[index].cameraType);                   // 获取相机类型。
     console.info('connectionType : ' + cameraArray[index].connectionType);           // 获取相机连接类型。
   }

   // 创建相机输入流。
   let cameraInput: camera.CameraInput | undefined = undefined;
   try {
     cameraInput = cameraManager.createCameraInput(cameraArray[0]);
   } catch (error) {
       let err = error as BusinessError;
       console.error('Failed to createCameraInput errorCode = ' + err.code);
   }
   if (cameraInput === undefined) {
     return;
   }

   // 监听cameraInput错误信息。
   let cameraDevice: camera.CameraDevice = cameraArray[0];
     cameraInput.on('error', cameraDevice, (error: BusinessError) => {
     console.error(`Camera input error code: ${error.code}`);
   });

   // 打开相机。
   await cameraInput.open();

   // 获取支持的模式类型。
   let sceneModes: Array<camera.SceneMode> = cameraManager.getSupportedSceneModes(cameraArray[0]);
   let isSupportPhotoMode: boolean = sceneModes.indexOf(camera.SceneMode.NORMAL_PHOTO) >= 0;
   if (!isSupportPhotoMode) {
     console.error('photo mode not support');
     return;
   }
   // 获取相机设备支持的输出流能力。
   let cameraOutputCap: camera.CameraOutputCapability = cameraManager.getSupportedOutputCapability(cameraArray[0], camera.SceneMode.NORMAL_PHOTO);
   if (!cameraOutputCap) {
     console.error("cameraManager.getSupportedOutputCapability error");
     return;
   }
   console.info("outputCapability: " + JSON.stringify(cameraOutputCap));

   let previewProfilesArray: Array<camera.Profile> = cameraOutputCap.previewProfiles;
   if (!previewProfilesArray) {
     console.error("createOutput previewProfilesArray == null || undefined");
   }

   let photoProfilesArray: Array<camera.Profile> = cameraOutputCap.photoProfiles;
   if (!photoProfilesArray) {
     console.error("createOutput photoProfilesArray == null || undefined");
   }

   // 创建预览输出流,其中参数 surfaceId 参考上文 XComponent 组件,预览流为XComponent组件提供的surface。
   let previewOutput: camera.PreviewOutput | undefined = undefined;
   try {
     previewOutput = cameraManager.createPreviewOutput(previewProfilesArray[0], surfaceId);
   } catch (error) {
     let err = error as BusinessError;
     console.error(`Failed to create the PreviewOutput instance. error code: ${err.code}`);
   }
   if (previewOutput === undefined) {
     return;
   }
   // 监听预览输出错误信息。
   previewOutput.on('error', (error: BusinessError) => {
     console.error(`Preview output error code: ${error.code}`);
   });

   // 创建拍照输出流。
   let photoOutput: camera.PhotoOutput | undefined = undefined;
   try {
     photoOutput = cameraManager.createPhotoOutput(photoProfilesArray[0]);
   } catch (error) {
       let err = error as BusinessError;
       console.error('Failed to createPhotoOutput errorCode = ' + err.code);
   }
   if (photoOutput === undefined) {
     return;
   }

   //创建会话。
   let photoSession: camera.PhotoSession | undefined = undefined;
   try {
     photoSession = cameraManager.createSession(camera.SceneMode.NORMAL_PHOTO) as camera.PhotoSession;
   } catch (error) {
       let err = error as BusinessError;
       console.error('Failed to create the session instance. errorCode = ' + err.code);
   }
   if (photoSession === undefined) {
     return;
   }
   // 监听session错误信息。
   photoSession.on('error', (error: BusinessError) => {
     console.error(`Capture session error code: ${error.code}`);
   });

   // 开始配置会话。
   try {
     photoSession.beginConfig();
   } catch (error) {
       let err = error as BusinessError;
       console.error('Failed to beginConfig. errorCode = ' + err.code);
   }

   // 向会话中添加相机输入流。
   try {
     photoSession.addInput(cameraInput);
   } catch (error) {
       let err = error as BusinessError;
       console.error('Failed to addInput. errorCode = ' + err.code);
   }

   // 向会话中添加预览输出流。
   try {
     photoSession.addOutput(previewOutput);
   } catch (error) {
       let err = error as BusinessError;
       console.error('Failed to addOutput(previewOutput). errorCode = ' + err.code);
   }

   // 向会话中添加拍照输出流。
   try {
     photoSession.addOutput(photoOutput);
   } catch (error) {
       let err = error as BusinessError;
       console.error('Failed to addOutput(photoOutput). errorCode = ' + err.code);
   }

   // 提交会话配置。
   await photoSession.commitConfig();

   // 启动会话。
   await photoSession.start().then(() => {
     console.info('Promise returned to indicate the session start success.');
   });
   // 判断设备是否支持闪光灯。
   let flashStatus: boolean = false;
     try {
       flashStatus = photoSession.hasFlash();
   } catch (error) {
       let err = error as BusinessError;
       console.error('Failed to hasFlash. errorCode = ' + err.code);
   }
   console.info('Returned with the flash light support status:' + flashStatus);

   if (flashStatus) {
     // 判断是否支持自动闪光灯模式。
     let flashModeStatus: boolean = false;
     try {
       let status: boolean = photoSession.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO);
       flashModeStatus = status;
     } catch (error) {
         let err = error as BusinessError;
         console.error('Failed to check whether the flash mode is supported. errorCode = ' + err.code);
     }
     if(flashModeStatus) {
       // 设置自动闪光灯模式。
       try {
         photoSession.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO);
       } catch (error) {
           let err = error as BusinessError;
           console.error('Failed to set the flash mode. errorCode = ' + err.code);
       }
     }
   }

   // 判断是否支持连续自动变焦模式。
   let focusModeStatus: boolean = false;
   try {
     let status: boolean = photoSession.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_CONTINUOUS_AUTO);
     focusModeStatus = status;
   } catch (error) {
       let err = error as BusinessError;
       console.error('Failed to check whether the focus mode is supported. errorCode = ' + err.code);
   }

   if (focusModeStatus) {
     // 设置连续自动变焦模式。
     try {
       photoSession.setFocusMode(camera.FocusMode.FOCUS_MODE_CONTINUOUS_AUTO);
     } catch (error) {
         let err = error as BusinessError;
         console.error('Failed to set the focus mode. errorCode = ' + err.code);
     }
   }

   // 获取相机支持的可变焦距比范围。
   let zoomRatioRange: Array<number> = [];
   try {
     zoomRatioRange = photoSession.getZoomRatioRange();
   } catch (error) {
       let err = error as BusinessError;
       console.error('Failed to get the zoom ratio range. errorCode = ' + err.code);
   }
   if (zoomRatioRange.length <= 0) {
     return;
   }
   // 设置可变焦距比。
   try {
     photoSession.setZoomRatio(zoomRatioRange[0]);
   } catch (error) {
       let err = error as BusinessError;
       console.error('Failed to set the zoom ratio value. errorCode = ' + err.code);
   }
   let photoCaptureSetting: camera.PhotoCaptureSetting = {
     quality: camera.QualityLevel.QUALITY_LEVEL_HIGH, // 设置图片质量高。
     rotation: camera.ImageRotation.ROTATION_0 // 设置图片旋转角度0。
   }
   // 使用当前拍照设置进行拍照。
   photoOutput.capture(photoCaptureSetting, (err: BusinessError) => {
     if (err) {
       console.error(`Failed to capture the photo ${err.message}`);
       return;
     }
     console.info('Callback invoked to indicate the photo capture request success.');
   });

   console.info('onForeGround recovery end.');
}