跳到主要内容
版本：v5

@capacitor/camera

Camera API 提供了调用相机拍摄照片或从相册中选择现有照片的功能。

安装​

npm install @capacitor/camera@latest-5
npx cap sync

iOS​

iOS 需要在应用的 Info.plist 中添加并填写以下使用描述：

  • NSCameraUsageDescription (隐私 - 相机使用说明)
  • NSPhotoLibraryAddUsageDescription (隐私 - 相册添加使用说明)
  • NSPhotoLibraryUsageDescription (隐私 - 相册使用说明)

有关在 Xcode 中设置 iOS 权限的更多信息，请阅读 iOS 指南中的配置 Info.plist

Android​

此 API 需要在 AndroidManifest.xml 中添加以下权限：

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

你也可以仅为会请求这些权限的 Android 版本指定：

<uses-permission android:name="android.permission.READ_MEDIA_IMAGES"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="32"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="29"/>

存储权限用于读取/保存照片文件。

有关设置 Android 权限的更多信息，请阅读 Android 指南中的设置权限。

此外，由于 Camera API 会启动一个单独的 Activity 来处理拍照，你应该在 App 插件中监听 appRestoredResult，以处理在 Activity 运行时操作系统终止你的应用的情况下发送的任何相机数据。

变量​

此插件将使用以下项目变量（定义在你的应用的 variables.gradle 文件中）：

  • androidxExifInterfaceVersion: androidx.exifinterface:exifinterface 的版本 (默认: 1.3.6)
  • androidxMaterialVersion: com.google.android.material:material 的版本 (默认: 1.8.0)

PWA 注意事项​

Camera 插件需要 PWA Elements 才能正常工作。

示例​

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

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

  // image.webPath 包含可用作图像 src 的路径。
  // 你可以使用 image.path 访问原始文件，如果需要可以将其传递给 Filesystem API 读取图像的原始数据
  // （或者传递 resultType: CameraResultType.Base64 给 getPhoto）
  var imageUrl = image.webPath;

  // 现在可以设置为图像的 src
  imageElement.src = imageUrl;
};

API​

getPhoto(...)​

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

提示用户从相册中选择照片或使用相机拍摄新照片。

参数类型
options
ImageOptions

返回值: 

Promise<Photo>

自: 1.0.0

pickImages(...)​

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

允许用户从相册中选择多张图片。 在 iOS 13 及更早版本上只能选择一张图片。

参数类型
options
GalleryImageOptions

返回值: 

Promise<GalleryPhotos>

自: 1.2.0

pickLimitedLibraryPhotos()​

pickLimitedLibraryPhotos() => Promise<GalleryPhotos>

仅限 iOS 14+：允许用户更新他们的受限照片库选择。 在 iOS 15+ 上返回选择器关闭后所有受限照片。 在 iOS 14 或用户授予照片完全访问权限时返回空数组。

返回值: 

Promise<GalleryPhotos>

自: 4.1.0

getLimitedLibraryPhotos()​

getLimitedLibraryPhotos() => Promise<GalleryPhotos>

仅限 iOS 14+：返回从受限照片库中选择的照片数组。

返回值: 

Promise<GalleryPhotos>

自: 4.1.0

checkPermissions()​

checkPermissions() => Promise<PermissionStatus>

检查相机和相册权限

返回值: 

Promise<PermissionStatus>

自: 1.0.0

requestPermissions(...)​

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

请求相机和相册权限

参数类型
permissions
CameraPluginPermissions

返回值: 

Promise<PermissionStatus>

自: 1.0.0

Interfaces​

Photo​

属性类型描述自
base64Stringstring如果使用 CameraResultType.Base64，则为图像的 base64 编码字符串表示。1.0.0
dataUrlstring如果使用 CameraResultType.DataUrl，则为以 'data:image/jpeg;base64,' 开头的 URL 和图像的 base64 编码字符串表示。注意：在 Web 上，文件格式可能会因浏览器而异。1.0.0
pathstring如果使用 CameraResultType.Uri，则路径将包含一个完整的、平台特定的文件 URL，以后可以使用 Filesystem API 读取。1.0.0
webPathstringwebPath 返回一个可用于设置图像 src 属性的路径，以实现高效加载和渲染。1.0.0
exifany从图像检索的 Exif 数据（如果有）1.0.0
formatstring图像的格式，例如：jpeg、png、gif。iOS 和 Android 仅支持 jpeg。Web 支持 jpeg、png 和 gif，但确切的可用性可能因浏览器而异。仅当 webUseInput 设置为 true 或 source 设置为 Photos 时才支持 gif。1.0.0
savedboolean图像是否已保存到相册。在 Android 和 iOS 上，如果用户未授予所需权限，则保存到相册可能会失败。在 Web 上没有相册，因此始终返回 false。1.1.0

ImageOptions​

属性类型描述默认自
qualitynumber返回的 JPEG 图像质量，从 0-100 注意：此选项仅在 Android 和 iOS 上受支持1.0.0
allowEditingboolean是否允许用户裁剪或进行小编辑（平台特定）。在 iOS 14+ 上仅支持 CameraSource.Camera，不支持 CameraSource.Photos。1.0.0
resultType
CameraResultType
数据应如何返回。当前仅支持 'Base64'、'DataUrl' 或 'Uri'1.0.0
saveToGalleryboolean是否将照片保存到相册。如果照片是从相册中选取的，则仅在编辑后才会保存。: false1.0.0
widthnumber保存图像的所需最大宽度。保持纵横比。1.0.0
heightnumber保存图像的所需最大高度。保持纵横比。1.0.0
correctOrientationboolean是否自动将图像"向上"旋转以校正纵向模式下的方向: true1.0.0
source
CameraSource
获取照片的来源。默认情况下，这会提示用户选择相册或拍照。: CameraSource.Prompt1.0.0
direction
CameraDirection
仅限 iOS 和 Web：相机方向。: CameraDirection.Rear1.0.0
presentationStyle'fullscreen' | 'popover'仅限 iOS：相机的呈现样式。: 'fullscreen'1.0.0
webUseInputboolean仅限 Web：是否使用 PWA Element 体验或文件输入。默认是使用 PWA Elements（如果已安装）并回退到文件输入。要始终使用文件输入，请将此设置为 true。了解有关 PWA Elements 的更多信息：https://capacitorjs.com/docs/web/pwa-elements1.0.0
promptLabelHeaderstring显示提示时使用的文本值。: 'Photo'1.0.0
promptLabelCancelstring显示提示时使用的文本值。仅限 iOS：'取消'按钮的标签。: 'Cancel'1.0.0
promptLabelPhotostring显示提示时使用的文本值。选择已保存图像的按钮的标签。: 'From Photos'1.0.0
promptLabelPicturestring显示提示时使用的文本值。打开相机的按钮的标签。: 'Take Picture'1.0.0

GalleryPhotos​

属性类型描述自
photosGalleryPhoto[]所有选中照片的数组。1.2.0

GalleryPhoto​

属性类型描述自
pathstring完整的、平台特定的文件 URL，以后可以使用 Filesystem API 读取。1.2.0
webPathstringwebPath 返回一个可用于设置图像 src 属性的路径，以实现高效加载和渲染。1.2.0
exifany从图像检索的 Exif 数据（如果有）1.2.0
formatstring图像的格式，例如：jpeg、png、gif。iOS 和 Android 仅支持 jpeg。Web 支持 jpeg、png 和 gif。1.2.0

GalleryImageOptions​

属性类型描述默认自
qualitynumber返回的 JPEG 图像质量，从 0-100 注意：此选项仅在 Android 和 iOS 上受支持。1.2.0
widthnumber保存图像的所需最大宽度。保持纵横比。1.2.0
heightnumber保存图像的所需最大高度。保持纵横比。1.2.0
correctOrientationboolean是否自动将图像"向上"旋转以校正纵向模式下的方向: true1.2.0
presentationStyle'fullscreen' | 'popover'仅限 iOS：相机的呈现样式。: 'fullscreen'1.2.0
limitnumber仅限 iOS：用户可以选择的最大图片数量。0 (unlimited)1.2.0

PermissionStatus​

属性类型
camera
CameraPermissionState
photos
CameraPermissionState

CameraPluginPermissions​

属性类型
permissionsCameraPermissionType[]

Type Aliases​

CameraPermissionState​


  PermissionState | 'limited'

PermissionState​

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

CameraPermissionType​

'camera' | 'photos'

Enums​

CameraResultType​

成员值
Uri'uri'
Base64'base64'
DataUrl'dataUrl'

CameraSource​

成员值描述
Prompt'PROMPT'提示用户选择相册或拍照。
Camera'CAMERA'使用相机拍摄新照片。

| **`

Contents

编辑此页