Interface (Aperture)

Aperture inherits from ApertureQuery.

Describes a physical aperture object.

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 24.

Modules to Import

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

getPhysicalAperture²⁴⁺

getPhysicalAperture(): number

Obtains the physical aperture in use.

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

System capability: SystemCapability.Multimedia.Camera.Core

Returns

Type	Description
number	Physical aperture in use.

Error Codes

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

Error Code	Error Message
7400102	Operation not allowed, the inputDevice or the session is abnormal.
7400103	Session not config.

Example

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

function getPhysicalAperture(photoSession: camera.PhotoSession): number {
  let aperture = 0.0;
  try {
    aperture = photoSession.getPhysicalAperture();
  } catch (error) {
    // If the operation fails, error.code is returned and processed.
    let err = error as BusinessError;
    console.error(`The getPhysicalAperture call failed. error code: ${err.code}`);
  }
  return aperture;
}

setPhysicalAperture²⁴⁺

setPhysicalAperture(aperture: number): void

Sets a physical aperture.

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

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Parameter	Type	Mandatory	Description
aperture	number	Yes	Physical aperture.

Error Codes

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

Error Code	Error Message
7400102	Operation not allowed, the inputDevice or the session is abnormal.
7400103	Session not config.

Example

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

function setPhysicalAperture(photoSession: camera.PhotoSession, aperture: number): void {
  try {
    photoSession.setPhysicalAperture(aperture);
  } catch (error) {
    // If the operation fails, error.code is returned and processed.
    let err = error as BusinessError;
    console.error(`The setPhysicalAperture call failed. error code: ${err.code}`);
  }
}