• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Interface (MacroQuery)
2<!--Kit: Camera Kit-->
3<!--Subsystem: Multimedia-->
4<!--Owner: @qano-->
5<!--SE: @leo_ysl-->
6<!--TSE: @xchaosioda-->
7
8> **NOTE**
9>
10> - The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
11> - The initial APIs of this interface are supported since API version 19.
12
13MacroQuery provides the API to check the support for macro photography.
14
15## Modules to Import
16
17```ts
18import { camera } from '@kit.CameraKit';
19```
20
21## isMacroSupported<sup>19+</sup>
22
23isMacroSupported(): boolean
24
25Checks whether macro photography is supported in the current state. This API must be called after [commitConfig](arkts-apis-camera-Session.md#commitconfig11).
26
27**Atomic service API**: This API can be used in atomic services since API version 19.
28
29**System capability**: SystemCapability.Multimedia.Camera.Core
30
31**Return value**
32
33| Type       | Description                         |
34| ---------- | ----------------------------- |
35|   boolean  | Check result for the support of macro photography. **true** if supported, **false** otherwise.|
36
37**Example**
38
39```ts
40function isMacroSupported(photoSession: camera.PhotoSession): boolean {
41  let isSupported: boolean = photoSession.isMacroSupported();
42  return isSupported;
43}
44```
45