harmony 鸿蒙Interface (PhotoOutput)

  • 2025-06-12
  • 浏览 (4)

Interface (PhotoOutput)

说明：

本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

拍照会话中使用的输出信息，继承CameraOutput。

capture

capture(callback: AsyncCallback<void>): void

以默认设置触发一次拍照，通过注册回调函数获取结果。使用callback异步回调。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
callback AsyncCallback<void> 是 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode。

错误码：

以下错误码的详细介绍请参见Camera错误码。

错误码ID 错误信息
7400104 Session not running.
7400201 Camera service fatal error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function capture(photoOutput: camera.PhotoOutput): void {
  photoOutput.capture((err: BusinessError) => {
    if (err) {
      console.error(`Failed to capture the photo, error code: ${err.code}.`);
      return;
    }
    console.info('Callback invoked to indicate the photo capture request success.');
  });
}

capture

capture(): Promise<void>

以默认设置触发一次拍照，通过Promise获取结果。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见Camera错误码。

错误码ID 错误信息
7400104 Session not running.
7400201 Camera service fatal error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function capture(photoOutput: camera.PhotoOutput): void {
  photoOutput.capture().then(() => {
    console.info('Promise returned to indicate that photo capture request success.');
  }).catch((error: BusinessError) => {
    console.error(`Failed to photo output capture, error code: ${error.code}.`);
  });
}

capture

capture(setting: PhotoCaptureSetting, callback: AsyncCallback<void>): void

以指定参数触发一次拍照，通过注册回调函数获取结果。使用callback异步回调。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
setting PhotoCaptureSetting 是 拍照设置。
callback AsyncCallback<void> 是 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode。

错误码：

以下错误码的详细介绍请参见Camera错误码。

错误码ID 错误信息
7400101 Parameter missing or parameter type incorrect.
7400104 Session not running.
7400201 Camera service fatal error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function capture(photoOutput: camera.PhotoOutput): void {
  let captureLocation: camera.Location = {
    latitude: 0,
    longitude: 0,
    altitude: 0
  }
  let settings: camera.PhotoCaptureSetting = {
    quality: camera.QualityLevel.QUALITY_LEVEL_LOW,
    rotation: camera.ImageRotation.ROTATION_0,
    location: captureLocation,
    mirror: false
  }
  photoOutput.capture(settings, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to capture the photo, error code: ${err.code}.`);
      return;
    }
    console.info('Callback invoked to indicate the photo capture request success.');
  });
}

capture

capture(setting: PhotoCaptureSetting): Promise<void>

以指定参数触发一次拍照，通过Promise获取结果。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
setting PhotoCaptureSetting 是 拍照设置，传入undefined类型数据按默认无参处理。

返回值：

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见Camera错误码。

错误码ID 错误信息
7400101 Parameter missing or parameter type incorrect.
7400104 Session not running.
7400201 Camera service fatal error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function capture(photoOutput: camera.PhotoOutput): void {
  let captureLocation: camera.Location = {
    latitude: 0,
    longitude: 0,
    altitude: 0
  }
  let settings: camera.PhotoCaptureSetting = {
    quality: camera.QualityLevel.QUALITY_LEVEL_LOW,
    rotation: camera.ImageRotation.ROTATION_0,
    location: captureLocation,
    mirror: false
  }
  photoOutput.capture(settings).then(() => {
    console.info('Promise returned to indicate that photo capture request success.');
  }).catch((error: BusinessError) => {
    console.error(`Failed to photo output capture, error code: ${error.code}.`);
  });
}

on(‘photoAvailable’)11+

on(type: ‘photoAvailable’, callback: AsyncCallback<Photo>): void

注册监听全质量图上报。使用callback异步回调。

说明：

当前注册监听接口，不支持在on监听的回调方法里，调用off注销回调。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’photoAvailable’，photoOutput创建成功后可监听。
callback AsyncCallback<Photo> 是 回调函数，用于监听全质量图上报。

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { image } from '@kit.ImageKit';

function callback(err: BusinessError, photo: camera.Photo): void {
  if (err !== undefined && err.code !== 0) {
    console.error(`Callback Error, errorCode: ${err.code}`);
    return;
  }
  let mainImage: image.Image = photo.main;
}

function registerPhotoOutputPhotoAvailable(photoOutput: camera.PhotoOutput): void {
  photoOutput.on('photoAvailable', callback);
}

off(‘photoAvailable’)11+

off(type: ‘photoAvailable’, callback?: AsyncCallback<Photo>): void

注销监听全质量图上报。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’photoAvailable’，photoOutput创建成功后可监听。
callback AsyncCallback<Photo> 否 回调函数，如果指定参数则取消对应callback（callback对象不可是匿名函数），否则取消所有callback。

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { image } from '@kit.ImageKit';

function callback(err: BusinessError, photo: camera.Photo): void {
  if (err !== undefined && err.code !== 0) {
    console.error(`Callback Error, errorCode: ${err.code}`);
    return;
  }
  let mainImage: image.Image = photo.main;
}

function unRegisterPhotoOutputPhotoAvailable(photoOutput: camera.PhotoOutput): void {
  photoOutput.off('photoAvailable', callback);
}

on(‘captureStartWithInfo’)11+

on(type: ‘captureStartWithInfo’, callback: AsyncCallback<CaptureStartInfo>): void

监听拍照开始，通过注册回调函数获取CaptureStartInfo。使用callback异步回调。

说明：

当前注册监听接口，不支持在on监听的回调方法里，调用off注销回调。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’captureStartWithInfo’，photoOutput创建成功后可监听。
callback AsyncCallback<CaptureStartInfo> 是 使用callback的方式获取Capture ID。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function callback(err: BusinessError, captureStartInfo: camera.CaptureStartInfo): void {
  if (err !== undefined && err.code !== 0) {
    console.error(`Callback Error, errorCode: ${err.code}`);
    return;
  }
  console.info(`photo capture started, captureStartInfo : ${captureStartInfo}`);
}

function registerCaptureStartWithInfo(photoOutput: camera.PhotoOutput): void {
  photoOutput.on('captureStartWithInfo', callback);
}

off(‘captureStartWithInfo’)11+

off(type: ‘captureStartWithInfo’, callback?: AsyncCallback<CaptureStartInfo>): void

注销监听拍照。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’captureStartWithInfo’，photoOutput创建成功后可监听。
callback AsyncCallback<CaptureStartInfo> 否 回调函数，如果指定参数则取消对应callback（callback对象不可是匿名函数），否则取消所有callback。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function unRegisterCaptureStartWithInfo(photoOutput: camera.PhotoOutput): void {
  photoOutput.off('captureStartWithInfo');
}

isMovingPhotoSupported12+

isMovingPhotoSupported(): boolean

查询是否支持动态照片拍摄。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型 说明
boolean 返回是否支持动态照片拍照。true表示支持，false表示不支持。

错误码：

以下错误码的详细介绍请参见Camera错误码。

错误码ID 错误信息
7400201 Camera service fatal error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function isMovingPhotoSupported(photoOutput: camera.PhotoOutput): boolean {
  let isSupported: boolean = false;
  try {
    isSupported = photoOutput.isMovingPhotoSupported();
  } catch (error) {
    // 失败返回错误码error.code并处理。
    let err = error as BusinessError;
    console.error(`The isMovingPhotoSupported call failed. error code: ${err.code}`);
  }
  return isSupported;
}

enableMovingPhoto12+

enableMovingPhoto(enabled: boolean): void

使能动态照片拍照。

需要权限： ohos.permission.MICROPHONE

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
enabled boolean 是 使能动态照片拍照。true为开启动态照片，false为关闭动态照片。

错误码：

以下错误码的详细介绍请参见Camera错误码。

错误码ID 错误信息
201 permission denied.
7400101 Parameter missing or parameter type incorrect.
7400201 Camera service fatal error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function enableMovingPhoto(photoOutput: camera.PhotoOutput): void {
  try {
    photoOutput.enableMovingPhoto(true);
  } catch (error) {
    // 失败返回错误码error.code并处理。
    let err = error as BusinessError;
    console.error(`The enableMovingPhoto call failed. error code: ${err.code}`);
  }
}

on(‘photoAssetAvailable’)12+

on(type: ‘photoAssetAvailable’, callback: AsyncCallback<photoAccessHelper.PhotoAsset>): void

注册监听photoAsset上报。使用callback异步回调。

说明：

当前注册监听接口，不支持在on监听的回调方法里，调用off注销回调。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’photoAssetAvailable’，photoOutput创建成功后可监听。
callback AsyncCallback<photoAccessHelper.PhotoAsset> 是 回调函数，用于监听photoAsset上报。

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { photoAccessHelper } from '@kit.MediaLibraryKit';

function photoAssetAvailableCallback(err: BusinessError, photoAsset: photoAccessHelper.PhotoAsset): void {
  if (err) {
    console.info(`photoAssetAvailable error: ${JSON.stringify(err)}.`);
    return;
  }
  console.info('photoOutPutCallBack photoAssetAvailable');
  // 开发者可通过photoAsset获取图片相关信息。
}

function onPhotoOutputPhotoAssetAvailable(photoOutput: camera.PhotoOutput): void {
  photoOutput.on('photoAssetAvailable', photoAssetAvailableCallback);
}

off(‘photoAssetAvailable’)12+

off(type: ‘photoAssetAvailable’, callback?: AsyncCallback<photoAccessHelper.PhotoAsset>): void

注销photoAsset上报。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’photoAssetAvailable’，photoOutput创建成功后可监听。
callback AsyncCallback<photoAccessHelper.PhotoAsset> 否 需要解监听的回调方法。如果callback不为空且与此对应的监听方法一致，不为匿名方法，则解注册该方法；如果callback为空，则解监听所有回调。

示例：

function offPhotoOutputPhotoAssetAvailable(photoOutput: camera.PhotoOutput): void {
  photoOutput.off('photoAssetAvailable');
}

isMirrorSupported

isMirrorSupported(): boolean

查询是否支持镜像拍照。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型 说明
boolean 返回是否支持镜像拍照，true表示支持，false表示不支持。

示例：

function isMirrorSupported(photoOutput: camera.PhotoOutput): boolean {
  let isSupported: boolean = photoOutput.isMirrorSupported();
  return isSupported;
}

enableMirror13+

enableMirror(enabled: boolean): void

是否启用动态照片镜像拍照。

调用该接口前，需要通过isMovingPhotoSupported查询是否支持动态照片拍摄功能以及通过isMirrorSupported查询是否支持镜像拍照功能。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
enabled boolean 是 是否启用动态照片镜像拍照。true为开启动态照片镜像拍照，false为关闭动态照片镜像拍照。

错误码：

以下错误码的详细介绍请参见Camera错误码。

错误码ID 错误信息
7400101 Parameter missing or parameter type incorrect.
7400103 Session not config.
7400201 Camera service fatal error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function enableMirror(photoOutput: camera.PhotoOutput): void {
  try {
    photoOutput.enableMirror(true);
  } catch (error) {
    // 失败返回错误码error.code并处理。
    let err = error as BusinessError;
    console.error(`The enableMirror call failed. error code: ${err.code}`);
  }
}

getSupportedMovingPhotoVideoCodecTypes13+

getSupportedMovingPhotoVideoCodecTypes(): Array<VideoCodecType>

查询支持的动态照片短视频编码类型。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型 说明
Array<VideoCodecType> 支持的动态照片短视频编码类型列表。

错误码：

以下错误码的详细介绍请参见Camera错误码。

错误码ID 错误信息
7400201 Camera service fatal error.

示例：

function getSupportedMovingPhotoVideoCodecType(photoOutput: camera.PhotoOutput): Array<camera.VideoCodecType> {
  let supportedVideoCodecTypesArray: Array<camera.VideoCodecType> = photoOutput.getSupportedMovingPhotoVideoCodecTypes();
  return supportedVideoCodecTypesArray;
}

setMovingPhotoVideoCodecType13+

setMovingPhotoVideoCodecType(codecType: VideoCodecType): void

设置动态照片短视频编码类型。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
codecType VideoCodecType 是 获取动态照片短视频编码类型。

错误码：

以下错误码的详细介绍请参见Camera错误码。

错误码ID 错误信息
7400201 Camera service fatal error.

示例：

function setMovingPhotoVideoCodecTypes(photoOutput: camera.PhotoOutput, videoCodecType: camera.VideoCodecType): void {
   photoOutput.setMovingPhotoVideoCodecType(videoCodecType);
}

on(‘frameShutter’)

on(type: ‘frameShutter’, callback: AsyncCallback<FrameShutterInfo>): void

监听拍照帧输出捕获，通过注册回调函数获取结果。使用callback异步回调。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’frameShutter’，photoOutput创建成功后可监听。
callback AsyncCallback<FrameShutterInfo> 是 回调函数，用于获取相关信息。该回调返回意味着可以再次下发拍照请求。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function callback(err: BusinessError, frameShutterInfo: camera.FrameShutterInfo): void {
  if (err !== undefined && err.code !== 0) {
    console.error(`Callback Error, errorCode: ${err.code}`);
    return;
  }
  console.info(`CaptureId for frame : ${frameShutterInfo.captureId}`);
  console.info(`Timestamp for frame : ${frameShutterInfo.timestamp}`);
}

function registerPhotoOutputFrameShutter(photoOutput: camera.PhotoOutput): void {
  photoOutput.on('frameShutter', callback);
}

off(‘frameShutter’)

off(type: ‘frameShutter’, callback?: AsyncCallback<FrameShutterInfo>): void

注销监听拍照帧输出捕获。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’frameShutter’，photoOutput创建成功后可监听。
callback AsyncCallback<FrameShutterInfo> 否 回调函数，如果指定参数则取消对应callback（callback对象不可是匿名函数），否则取消所有callback。

示例：

function unregisterPhotoOutputFrameShutter(photoOutput: camera.PhotoOutput): void {
  photoOutput.off('frameShutter');
}

on(‘captureEnd’)

on(type: ‘captureEnd’, callback: AsyncCallback<CaptureEndInfo>): void

监听拍照结束，通过注册回调函数获取结果。使用callback异步回调。

说明：

当前注册监听接口，不支持在on监听的回调方法里，调用off注销回调。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’captureEnd’。photoOutput创建成功后可监听。拍照完全结束可触发该事件发生并返回相应信息。
callback AsyncCallback<CaptureEndInfo> 是 回调函数，用于获取相关信息。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function callback(err: BusinessError, captureEndInfo: camera.CaptureEndInfo): void {
  if (err !== undefined && err.code !== 0) {
    console.error(`Callback Error, errorCode: ${err.code}`);
    return;
  }
  console.info(`photo capture end, captureId : ${captureEndInfo.captureId}`);
  console.info(`frameCount : ${captureEndInfo.frameCount}`);
}

function registerPhotoOutputCaptureEnd(photoOutput: camera.PhotoOutput): void {
  photoOutput.on('captureEnd', callback);
}

off(‘captureEnd’)

off(type: ‘captureEnd’, callback?: AsyncCallback<CaptureEndInfo>): void

注销监听拍照结束。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’captureEnd’，photoOutput创建成功后可监听。
callback AsyncCallback<CaptureEndInfo> 否 回调函数，如果指定参数则取消对应callback（callback对象不可是匿名函数），否则取消所有callback。

示例：

function unregisterPhotoOutputCaptureEnd(photoOutput: camera.PhotoOutput): void {
  photoOutput.off('captureEnd');
}

on(‘frameShutterEnd’)12+

on(type: ‘frameShutterEnd’, callback: AsyncCallback<FrameShutterEndInfo>): void

监听拍照曝光结束捕获，通过注册回调函数获取结果。使用callback异步回调。

说明：

当前注册监听接口，不支持在on监听的回调方法里，调用off注销回调。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’frameShutterEnd’，photoOutput创建成功后可监听。
callback AsyncCallback<FrameShutterEndInfo> 是 回调函数，用于获取相关信息。该回调返回表示拍照曝光结束。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function callback(err: BusinessError, frameShutterEndInfo: camera.FrameShutterEndInfo): void {
  if (err !== undefined && err.code !== 0) {
    console.error(`Callback Error, errorCode: ${err.code}`);
    return;
  }
  console.info(`CaptureId for frame : ${frameShutterEndInfo.captureId}`);
}

function registerPhotoOutputFrameShutterEnd(photoOutput: camera.PhotoOutput): void {
  photoOutput.on('frameShutterEnd', callback);
}

off(‘frameShutterEnd’)12+

off(type: ‘frameShutterEnd’, callback?: AsyncCallback<FrameShutterEndInfo>): void

注销监听拍照帧输出捕获。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’frameShutterEnd’，photoOutput创建成功后可监听。
callback AsyncCallback<FrameShutterEndInfo> 否 回调函数，如果指定参数则取消对应callback（callback对象不可是匿名函数），否则取消所有callback。

示例：

function unregisterPhotoOutputFrameShutterEnd(photoOutput: camera.PhotoOutput): void {
  photoOutput.off('frameShutterEnd');
}

on(‘captureReady’)12+

on(type: ‘captureReady’, callback: AsyncCallback<void>): void

监听可拍下一张，通过注册回调函数获取结果。使用callback异步回调。

说明：

当前注册监听接口，不支持在on监听的回调方法里，调用off注销回调。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’captureReady’，photoOutput创建成功后可监听。当下一张可拍时可触发该事件发生并返回相应信息。
callback AsyncCallback<void> 是 回调函数，用于获取相关信息。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function callback(err: BusinessError): void {
  if (err !== undefined && err.code !== 0) {
    console.error(`Callback Error, errorCode: ${err.code}`);
    return;
  }
  console.info(`photo capture ready`);
}

function registerPhotoOutputCaptureReady(photoOutput: camera.PhotoOutput): void {
  photoOutput.on('captureReady', callback);
}

off(‘captureReady’)12+

off(type: ‘captureReady’, callback?: AsyncCallback<void>): void

注销监听可拍下一张。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’captureReady’，photoOutput创建成功后可监听。
callback AsyncCallback<void> 否 回调函数，如果指定参数则取消对应callback（callback对象不可是匿名函数），否则取消所有callback。

示例：

function unregisterPhotoOutputCaptureReady(photoOutput: camera.PhotoOutput): void {
  photoOutput.off('captureReady');
}

on(‘estimatedCaptureDuration’)12+

on(type: ‘estimatedCaptureDuration’, callback: AsyncCallback<number>): void

监听预估的拍照时间，通过注册回调函数获取结果。使用callback异步回调。

说明：

当前注册监听接口，不支持在on监听的回调方法里，调用off注销回调。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’estimatedCaptureDuration’，photoOutput创建成功后可监听。拍照完全结束可触发该事件发生并返回相应信息。
callback AsyncCallback<number> 是 回调函数，用于获取预估的单次拍照底层出sensor采集帧时间，如果上报-1，代表没有预估时间。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function callback(err: BusinessError, duration: number): void {
  if (err !== undefined && err.code !== 0) {
    console.error(`Callback Error, errorCode: ${err.code}`);
    return;
  }
  console.info(`photo estimated capture duration : ${duration}`);
}

function registerPhotoOutputEstimatedCaptureDuration(photoOutput: camera.PhotoOutput): void {
  photoOutput.on('estimatedCaptureDuration', callback);
}

off(‘estimatedCaptureDuration’)12+

off(type: ‘estimatedCaptureDuration’, callback?: AsyncCallback<number>): void

注销监听预估的拍照时间。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’estimatedCaptureDuration’，photoOutput创建成功后可监听。
callback AsyncCallback<number> 否 回调函数，如果指定参数则取消对应callback（callback对象不可是匿名函数），否则取消所有callback。

示例：

function unregisterPhotoOutputEstimatedCaptureDuration(photoOutput: camera.PhotoOutput): void {
  photoOutput.off('estimatedCaptureDuration');
}

on(‘error’)

on(type: ‘error’, callback: ErrorCallback): void

监听拍照输出发生错误，通过注册回调函数获取结果。使用callback异步回调。

说明：

当前注册监听接口，不支持在on监听的回调方法里，调用off注销回调。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’error’，photoOutput创建成功后可监听。拍照接口调用时出现错误触发该事件并返回错误信息。
callback ErrorCallback 是 回调函数，用于获取错误信息。返回错误码，错误码类型CameraErrorCode。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function callback(err: BusinessError): void {
  console.error(`Photo output error code: ${err.code}`);
}

function registerPhotoOutputError(photoOutput: camera.PhotoOutput): void {
  photoOutput.on('error', callback);
}

off(‘error’)

off(type: ‘error’, callback?: ErrorCallback): void

注销监听拍照输出发生错误。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’error’，photoOutput创建成功后可监听。
callback ErrorCallback 否 回调函数，如果指定参数则取消对应callback（callback对象不可是匿名函数），否则取消所有callback。

示例：

function unregisterPhotoOutputError(photoOutput: camera.PhotoOutput): void {
  photoOutput.off('error');
}

getActiveProfile12+

getActiveProfile(): Profile

获取当前生效的配置信息。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型 说明
Profile 当前生效的配置信息

错误码：

以下错误码的详细介绍请参见Camera错误码。

错误码ID 错误信息
7400201 Camera service fatal error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function testGetActiveProfile(photoOutput: camera.PhotoOutput): camera.Profile|undefined {
  let activeProfile: camera.Profile|undefined = undefined;
  try {
    activeProfile = photoOutput.getActiveProfile();
  } catch (error) {
    // 失败返回错误码error.code并处理。
    let err = error as BusinessError;
    console.error(`The photoOutput.getActiveProfile call failed. error code: ${err.code}`);
  }
  return activeProfile;
}

getPhotoRotation12+

getPhotoRotation(deviceDegree: number): ImageRotation

获取拍照旋转角度。

  • 设备自然方向：设备默认使用方向，手机为竖屏（充电口向下）。
  • 相机镜头角度：值等于相机图像顺时针旋转到设备自然方向的角度，手机后置相机传感器是横屏安装的，所以需要顺时针旋转90度到设备自然方向。
  • 屏幕显示方向：需要屏幕显示的图片左上角为第一个像素点为坐标原点。锁屏时与自然方向一致。

原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
deviceDegree number 是 设备旋转角度

返回值：

类型 说明
ImageRotation 获取拍照旋转角度。

错误码：

以下错误码的详细介绍请参见Camera错误码。

错误码ID 错误信息
7400101 Parameter missing or parameter type incorrect.
7400201 Camera service fatal error.

示例：

function testGetPhotoRotation(photoOutput: camera.PhotoOutput, deviceDegree : number): camera.ImageRotation {
  let photoRotation: camera.ImageRotation = camera.ImageRotation.ROTATION_0;
  try {
    photoRotation = photoOutput.getPhotoRotation(deviceDegree);
    console.log(`Photo rotation is: ${photoRotation}`);
  } catch (error) {
    // 失败返回错误码error.code并处理。
    let err = error as BusinessError;
    console.error(`The photoOutput.getPhotoRotation call failed. error code: ${err.code}`);
  }
  return photoRotation;
}

on(‘captureStart’)(deprecated)

on(type: ‘captureStart’, callback: AsyncCallback<number>): void

监听拍照开始，通过注册回调函数获取Capture ID。使用callback异步回调。

说明： 从 API version 10开始支持，从API version 11开始废弃。建议使用on(‘captureStartWithInfo’)替代。

当前注册监听接口，不支持在on监听的回调方法里，调用off注销回调。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’captureStart’，photoOutput创建成功后可监听。每次拍照，底层开始曝光时触发该事件并返回。
callback AsyncCallback<number> 是 使用callback的方式获取Capture ID。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function callback(err: BusinessError, captureId: number): void {
  if (err !== undefined && err.code !== 0) {
    console.error(`Callback Error, errorCode: ${err.code}`);
    return;
  }
  console.info(`photo capture started, captureId : ${captureId}`);
}

function registerPhotoOutputCaptureStart(photoOutput: camera.PhotoOutput): void {
  photoOutput.on('captureStart', callback);
}

off(‘captureStart’)(deprecated)

off(type: ‘captureStart’, callback?: AsyncCallback<number>): void

注销拍照开始的监听。

说明： 从 API version 10开始支持，从API version 11开始废弃。建议使用off(‘captureStartWithInfo’)替代。

当前注册监听接口，不支持在on监听的回调方法里，调用off注销回调。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

参数名 类型 必填 说明
type string 是 监听事件，固定为’captureStart’，photoOutput创建成功后可监听。
callback AsyncCallback<number> 否 回调函数，如果指定参数则取消对应callback（callback对象不可是匿名函数），否则取消所有callback。

示例：

function unregisterPhotoOutputCaptureStart(photoOutput: camera.PhotoOutput): void {
  photoOutput.off('captureStart');
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Camera Kit（相机服务）

harmony 鸿蒙Interface (AutoDeviceSwitch)

harmony 鸿蒙Interface (AutoDeviceSwitchQuery)

harmony 鸿蒙Interface (AutoExposure)

harmony 鸿蒙Interface (AutoExposureQuery)

harmony 鸿蒙Interface (CameraInput)

harmony 鸿蒙Interface (CameraManager)

harmony 鸿蒙Interface (CameraOutput)

harmony 鸿蒙废弃的Interface (CaptureSession, deprecated)

harmony 鸿蒙Interface (ColorManagement)

0  赞
  • 所属分类： 后端技术
  • 本文标签：
  • 版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/fDUpo9
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录