跳到主要内容
版本：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 来获取 Base64 编码）
  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

接口#### 照片​

属性类型说明引入版本
base64Stringstring图片的 base64 编码字符串表示形式，如果使用 CameraResultType.Base64 的话。1.0.0
dataUrlstring以 'data:image/jpeg;base64,' 开头的 URL 及图片的 base64 编码字符串表示形式，如果使用 CameraResultType.DataUrl 的话。注意：在 Web 端，文件格式可能会因浏览器的不同而改变。1.0.0
pathstring如果使用 CameraResultType.Uri，path 将包含一个完整的、平台特定的文件 URL，之后可以使用文件系统 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 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 Elements 体验还是文件输入。默认情况下，如果已安装则使用 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

相册照片​

属性类型说明始于版本
photosGalleryPhoto[]所有已选取照片的数组。1.2.0
属性类型描述引入版本
pathstring完整的平台特定文件 URL，可用于后续通过 Filesystem API 读取。1.2.0
webPathstring返回一个可用于设置图片 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 (无限制)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

编辑此页