跳到主要内容
版本：v8

@capacitor/camera

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

安装​

npm install @capacitor/camera
npx cap sync

iOS​

iOS 要求在应用的 Info.plist 中添加并填写以下使用说明：

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

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

Android​

当从设备相册中选择现有图片时，现在会使用 Android 照片选择器组件。照片选择器适用于满足以下条件的设备：

  • 运行 Android 11 (API 等级 30) 或更高版本
  • 通过 Google 系统更新接收模块化系统组件的变更

较旧的设备以及运行 Android 11 或 12 并支持 Google Play 服务的 Android Go 设备可以安装照片选择器的向后移植版本。要通过 Google Play 服务启用向后移植照片选择器模块的自动安装，请在 AndroidManifest.xml 文件的 <application> 标签中添加以下条目：

<!-- 触发 Google Play 服务安装向后移植的照片选择器模块。 -->
<!--suppress AndroidDomInspection -->
<service android:name="com.google.android.gms.metadata.ModuleDependencies"
    android:enabled="false"
    android:exported="false"
    tools:ignore="MissingClass">
    <intent-filter>
        <action android:name="com.google.android.gms.metadata.MODULE_DEPENDENCIES" />
    </intent-filter>
    <meta-data android:name="photopicker_activity:0:required" android:value="" />
</service>

如果未添加该条目，对于不支持照片选择器的设备，照片选择器组件将回退到 Intent.ACTION_OPEN_DOCUMENT。

Camera 插件不需要任何权限，除非使用 saveToGallery: true，在这种情况下，应将以下权限添加到 AndroidManifest.xml：

<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_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.4.1)
  • androidxMaterialVersion: com.google.android.material:material 的版本 (默认: 1.13.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>

允许用户从相册中选择多张图片。

参数类型
options
GalleryImageOptions

返回值: 

Promise<GalleryPhotos>

起始版本: 1.2.0

pickLimitedLibraryPhotos()​

pickLimitedLibraryPhotos() => Promise<GalleryPhotos>

允许用户更新其受限照片库的选择。 在选择器关闭后返回所有受限的照片。 如果用户授予了照片的完全访问权限，则返回一个空数组。

返回值: 

Promise<GalleryPhotos>

起始版本: 4.1.0

getLimitedLibraryPhotos()​

getLimitedLibraryPhotos() => Promise<GalleryPhotos>

返回从受限照片库中选择的照片数组。

返回值: 

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

接口​

Photo​

属性类型描述自版本
base64Stringstring图片的 base64 编码字符串表示，如果使用 CameraResultType.Base64。1.0.0
dataUrlstring以 'data:image/jpeg;base64,' 开头并包含图片 base64 编码字符串的 URL，如果使用 CameraResultType.DataUrl。注意：在 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
属性类型描述默认值起始版本
qualitynumber返回的 JPEG 图像质量，范围从 0 到 100。注意：此选项仅在 Android 和 iOS 上受支持。1.0.0
allowEditingboolean是否允许用户裁剪或进行小幅编辑（具体取决于平台）。在 iOS 上，仅当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 元素体验还是文件输入。默认情况下，如果安装了 PWA 元素则使用它，否则回退到文件输入。若要始终使用文件输入，请将其设置为 true。了解更多关于 PWA 元素的信息：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
属性类型描述始于
pathstring完整的、平台特定的文件 URL，之后可以使用文件系统 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用户能够选择的图片的最大数量。注意：此选项仅在 Android 13+ 和 iOS 上受支持。0 (无限制)1.2.0

PermissionStatus​

属性类型
camera
CameraPermissionState
photos
CameraPermissionState

CameraPluginPermissions​

属性类型
permissionsCameraPermissionType[]

类型别名​

CameraPermissionState​

PermissionState | 'limited'

PermissionState​

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

CameraPermissionType​

'camera' | 'photos'

枚举​

CameraResultType​

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

CameraSource​

成员值描述
Prompt'PROMPT'提示用户选择相册或拍照。
Camera'CAMERA'使用相机拍摄新照片。
Photos'PHOTOS'从图库或相册中选择现有照片。

CameraDirection​

成员值
Rear'REAR'
Front'FRONT'

Contents

编辑此页