跳到主要内容
版本：v5

@capacitor/camera

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

安装​

npm install @capacitor/camera@latest-5
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)

阅读 iOS 指南 中的 配置 Info.plist 以获取有关在 Xcode 中设置 iOS 权限的更多信息。

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

接口​

Photo​

属性类型描述自从
base64Stringstring图片的 base64 编码字符串表示，如果使用 CameraResultType.Base64。1.0.0
dataUrlstring以 'data:image/jpeg;base64,' 开头的 URL 和图片的 base64 编码字符串表示，如果使用 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，但确切的可用性可能因浏览器而异。gif 仅在 webUseInput 设置为 true 或 source 设置为 Photos 时支持。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[]

类型别名​

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

编辑此页