文档管理中心
我的

您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明。

指南与API参考API参考媒体Camera Kit(相机服务)ArkTS API@ohos.multimedia.camera (相机管理)Interface (Macro)

Interface (Macro)

Phone19+PC/2in119+Tablet19+TV19+Wearable23+

Macro继承自MacroQuery。

提供使能微距能力的接口。

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

导入模块

收起
自动换行
深色代码主题
复制
  1. import { camera } from '@kit.CameraKit';

enableMacro19+

Phone19+PC/2in119+Tablet19+TV19+Wearable23+

enableMacro(enabled: boolean): void

使能当前的微距能力。

说明

使用该接口前,需要先通过isMacroSupported接口查询当前设备是否支持微距能力。

元服务API: 从API version 19开始,该接口支持在元服务中使用。

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

参数:

展开
参数名 类型 必填 说明
enabled boolean 是 是否开启微距能力。true表示开启微距能力,false表示关闭微距能力。

错误码:

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

展开
错误码ID 错误信息
7400102 Operation not allowed.
7400103 Session not config.

示例:

收起
自动换行
深色代码主题
复制
  1. function enableMacro(photoSession: camera.PhotoSession): void {
  2. let isSupported: boolean = photoSession.isMacroSupported();
  3. if (isSupported) {
  4. photoSession.enableMacro(true);
  5. }
  6. }