@capacitor/camera
Camera API 提供了通过摄像头拍摄照片或从相册选择现有照片的功能。
安装
npm install @capacitor/camera
npx cap sync
iOS
iOS 需要在应用的 Info.plist 中添加并填写以下使用说明：
NSCameraUsageDescription(隐私 - 相机使用说明)NSPhotoLibraryAddUsageDescription(隐私 - 相册添加使用说明)NSPhotoLibraryUsageDescription(隐私 - 相册使用说明)
阅读 iOS 指南 中的 配置 Info.plist 部分，了解如何在 Xcode 中设置 iOS 权限的更多信息。
Android
此 API 需要在 AndroidManifest.xml 中添加以下权限：
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
存储权限用于读取/保存照片文件。
阅读 Android 指南 中的 设置权限 部分，了解如何设置 Android 权限的更多信息。
另外，由于 Camera API 会启动一个单独的 Activity 来处理拍照，你应该在 App 插件中监听 appRestoredResult 事件，以处理操作系统在 Activity 运行时终止应用时可能发送的任何相机数据。
变量
该插件将使用以下项目变量（定义在应用的 variables.gradle 文件中）：
$androidxExifInterfaceVersion:androidx.exifinterface:exifinterface版本（默认：1.3.3）$androidxMaterialVersion:com.google.android.material:material版本（默认：1.6.1）
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 | |
返回值:
Promise<Photo>自: 1.0.0
pickImages(...)
pickImages(options: GalleryImageOptions) => Promise<GalleryPhotos>
允许用户从相册中选择多张图片。在 iOS 13 及更早版本上只能选择一张图片。
| 参数 | 类型 |
|---|---|
options | |
返回值:
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 | |
返回值:
Promise<PermissionStatus>自: 1.0.0
Interfaces
Photo
| 属性 | 类型 | 描述 | 自 |
|---|---|---|---|
base64String | string | 如果使用 CameraResultType.Base64，则为图片的 base64 编码字符串表示形式。 | 1.0.0 |
dataUrl | string | 如果使用 CameraResultType.DataUrl，则为以 'data:image/jpeg;base64,' 开头的 URL，后跟图片的 base64 编码字符串表示形式。 | 1.0.0 |
path | string | 如果使用 CameraResultType.Uri，则路径将包含一个完整的、平台特定的文件 URL，可以使用 Filesystem API 读取。 | 1.0.0 |
webPath | string | webPath 返回一个可用作图片 src 属性的路径，用于高效加载和渲染。 | 1.0.0 |
exif | any | 从图片中检索的 Exif 数据（如果有） | 1.0.0 |
format | string | 图片格式，例如 jpeg、png、gif。iOS 和 Android 仅支持 jpeg。Web 支持 jpeg 和 png。gif 仅在文件输入时支持。 | 1.0.0 |
saved | boolean | 图片是否已保存到相册。在 Android 和 iOS 上，如果用户未授予所需权限，保存到相册可能会失败。Web 上没有相册，因此始终返回 false。 | 1.1.0 |
ImageOptions
| 属性 | 类型 | 描述 | 默认值 | 自 |
|---|---|---|---|---|
quality | number | 返回 JPEG 图片的质量，范围 0-100 | 1.0.0 | |
allowEditing | boolean | 是否允许用户裁剪或进行小编辑（平台特定）。在 iOS 14+ 上仅支持 CameraSource.Camera，不支持 CameraSource.Photos。 | 1.0.0 | |
resultType | | 数据应如何返回。目前仅支持 'Base64'、'DataUrl' 或 'Uri' | 1.0.0 | |
saveToGallery | boolean | 是否将照片保存到相册。如果照片是从相册中选取的，则仅在编辑后保存。 | : false | 1.0.0 |
width | number | 保存图片所需的最大宽度。保持宽高比。 | 1.0.0 | |
height | number | 保存图片所需的最大高度。保持宽高比。 | 1.0.0 | |
correctOrientation | boolean | 是否自动将图片旋转为"向上"方向以纠正纵向模式下的方向 | : true | 1.0.0 |
source | | 获取照片的来源。默认提示用户选择相册或拍照。 | : CameraSource.Prompt | 1.0.0 |
direction | | 仅限 iOS 和 Web：摄像头方向。 | : CameraDirection.Rear | 1.0.0 |
presentationStyle | 'fullscreen' | 'popover' | 仅限 iOS：相机的呈现样式。 | : 'fullscreen' | 1.0.0 |
webUseInput | boolean | 仅限 Web：是否使用 PWA Element 体验或文件输入。默认使用 PWA Elements（如果已安装），否则回退到文件输入。要始终使用文件输入，请将其设置为 true。了解有关 PWA Elements 的更多信息：https://capacitorjs.com/docs/web/pwa-elements | 1.0.0 | |
promptLabelHeader | string | 显示提示时使用的文本值。 | : 'Photo' | 1.0.0 |
promptLabelCancel | string | 显示提示时使用的文本值。仅限 iOS："取消"按钮的标签。 | : 'Cancel' | 1.0.0 |
promptLabelPhoto | string | 显示提示时使用的文本值。选择保存图片的按钮标签。 | : 'From Photos' | 1.0.0 |
promptLabelPicture | string | 显示提示时使用的文本值。打开相机的按钮标签。 | : 'Take Picture' | 1.0.0 |
GalleryPhotos
| 属性 | 类型 | 描述 | 自 |
|---|---|---|---|
photos | GalleryPhoto[] | 所有已选图片的数组。 | 1.2.0 |
GalleryPhoto
| 属性 | 类型 | 描述 | 自 |
|---|---|---|---|
path | string | 完整的、平台特定的文件 URL，可以使用 Filesystem API 读取。 | 1.2.0 |
webPath | string | webPath 返回一个可用作图片 src 属性的路径，用于高效加载和渲染。 | 1.2.0 |
exif | any | 从图片中检索的 Exif 数据（如果有） | 1.2.0 |
format | string | 图片格式，例如 jpeg、png、gif。iOS 和 Android 仅支持 jpeg。Web 支持 jpeg、png 和 gif。 | 1.2.0 |
GalleryImageOptions
| 属性 | 类型 | 描述 | 默认值 | 自 |
|---|---|---|---|---|
quality | number | 返回 JPEG 图片的质量，范围 0-100 | 1.2.0 | |
width | number | 保存图片所需的最大宽度。 保持宽高比。 | 1.2.0 | |
height | number | 保存图片所需的最大高度。保持宽高比。 | 1.2.0 | |
correctOrientation | boolean | 是否自动将图片旋转为"向上"方向以纠正纵向模式 | : true | 1.2.0 |
presentationStyle | 'fullscreen' | 'popover' | 仅限 iOS：相机的呈现样式。 | : 'fullscreen' | 1.2.0 |
limit | number | 仅限 iOS：用户可以选择的最大图片数量。 | 0 (无限制) | 1.2.0 |
PermissionStatus
| 属性 | 类型 |
|---|---|
camera | |
photos | |
CameraPluginPermissions
| 属性 | 类型 |
|---|---|
permissions | CameraPermissionType[] |
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' | 使用相机拍摄新照片。 |
Photos | 'PHOTOS' | 从相册或照片库中选择现有照片。 |
CameraDirection
| 成员 | 值 |
|---|---|
Rear | 'REAR' |
Front | 'FRONT' |