• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Interface (Macro)
2<!--Kit: Camera Kit-->
3<!--Subsystem: Multimedia-->
4<!--Owner: @qano-->
5<!--Designer: @leo_ysl-->
6<!--Tester: @xchaosioda-->
7<!--Adviser: @zengyawen-->
8
9> **说明:**
10>
11> - 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
12> - 本Interface首批接口从API version 19开始支持。
13
14Macro 继承自 [MacroQuery](arkts-apis-camera-MacroQuery.md)。
15
16提供使能微距能力的接口。
17
18## 导入模块
19
20```ts
21import { camera } from '@kit.CameraKit';
22```
23
24## enableMacro<sup>19+</sup>
25
26enableMacro(enabled: boolean): void
27
28使能当前的微距能力。
29> **说明:**
30>
31> 使用该接口前,需要先通过[isMacroSupported](arkts-apis-camera-MacroQuery.md#ismacrosupported19)接口查询当前设备是否支持微距能力。
32
33**原子化服务API:** 从API version 19开始,该接口支持在原子化服务中使用。
34
35**系统能力:** SystemCapability.Multimedia.Camera.Core
36
37**参数:**
38
39| 参数名     | 类型                   | 必填 | 说明                  |
40| -------- | -------------------- | ---- | -------------------- |
41| enabled | boolean | 是   | 是否开启微距能力。true表示开启微距能力,false表示关闭微距能力。 |
42
43**错误码:**
44
45以下错误码的详细介绍请参见[Camera错误码](errorcode-camera.md)。
46
47| 错误码ID    | 错误信息                     |
48|----------|--------------------------|
49| 7400102  | Operation not allowed.   |
50| 7400103  | Session not config.      |
51
52**示例:**
53
54```ts
55function enableMacro(photoSession: camera.PhotoSession): void {
56  let isSupported: boolean = photoSession.isMacroSupported();
57  if (isSupported) {
58    photoSession.enableMacro(true);
59  }
60}
61```
62