The Camera API provides the ability to take a photo with the camera or choose an existing one from the photo album.

npm install @capacitor/camera
npx cap sync

iOS requires the following usage description be added and filled out for your app in Info.plist:

• NSCameraUsageDescription (Privacy - Camera Usage Description)
• NSPhotoLibraryAddUsageDescription (Privacy - Photo Library Additions Usage Description)
• NSPhotoLibraryUsageDescription (Privacy - Photo Library Usage Description)

Read about Configuring Info.plist in the iOS Guide for more information on setting iOS permissions in Xcode

This API requires the following permissions be added to your AndroidManifest.xml:

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

The storage permissions are for reading/saving photo files.

Read about Setting Permissions in the Android Guide for more information on setting Android permissions.

Additionally, because the Camera API launches a separate Activity to handle taking the photo, you should listen for appRestoredResult in the App plugin to handle any camera data that was sent in the case your app was terminated by the operating system while the Activity was running.

This plugin will use the following project variables (defined in your app's variables.gradle file):

• $androidxExifInterfaceVersion: version of androidx.exifinterface:exifinterface (default: 1.3.2)
• $androidxMaterialVersion: version of com.google.android.material:material (default: 1.3.0)

PWA Elements are required for Camera plugin to work.

import { Camera, CameraResultType } from '@capacitor/camera';

const takePicture = async () => {
  const image = await Camera.getPhoto({
    quality: 90,
    allowEditing: true,
    resultType: CameraResultType.Uri
  });

  // image.webPath will contain a path that can be set as an image src.
  // You can access the original file using image.path, which can be
  // passed to the Filesystem API to read the raw data of the image,
  // if desired (or pass resultType: CameraResultType.Base64 to getPhoto)
  var imageUrl = image.webPath;

  // Can be set to the src of an image now
  imageElement.src = imageUrl;
};

• getPhoto(...)
• pickImages(...)
• checkPermissions()
• requestPermissions(...)
• Interfaces
• Type Aliases
• Enums

getPhoto(options: ImageOptions) => Promise<Photo>

Prompt the user to pick a photo from an album, or take a new photo with the camera.

Returns: Promise<Photo>

Since: 1.0.0

pickImages(options: GalleryImageOptions) => Promise<GalleryPhotos>

Allows the user to pick multiple pictures from the photo gallery. On iOS 13 and older it only allows to pick one picture.

Returns: Promise<GalleryPhotos>

Since: 1.2.0

checkPermissions() => Promise<PermissionStatus>

Check camera and photo album permissions

Returns: Promise<PermissionStatus>

Since: 1.0.0

requestPermissions(permissions?: CameraPluginPermissions | undefined) => Promise<PermissionStatus>

Request camera and photo album permissions

Returns: Promise<PermissionStatus>

Since: 1.0.0

PermissionState | 'limited'

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

'camera' | 'photos'