Interface (Macro)

Macro inherits from MacroQuery.

It provides the API to enable macro photography.

NOTE

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.

The initial APIs of this interface are supported since API version 19.

Modules to Import

import { camera } from '@kit.CameraKit';

enableMacro¹⁹⁺

enableMacro(enabled: boolean): void

Enables or disables macro photography.

NOTE

Before calling this API, call isMacroSupported to check whether the current device supports macro photography.

Atomic service API: This API can be used in atomic services since API version 19.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Name	Type	Mandatory	Description
enabled	boolean	Yes	Whether to enable macro photography. true to enable, false otherwise.

Error codes

For details about the error codes, see Camera Error Codes.

ID	Error Message
7400102	Operation not allowed.
7400103	Session not config.

Example

function enableMacro(photoSession: camera.PhotoSession): void {
  let isSupported: boolean = photoSession.isMacroSupported();
  if (isSupported) {
    photoSession.enableMacro(true);
  }
}