@capacitor/camera
Camera API 提供了调用设备摄像头拍照或从相册中选择现有照片的功能。
安装
npm install @capacitor/camera
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_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.2)$androidxMaterialVersion:com.google.android.material:material版本 (默认:1.3.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 | |
返回值:
Promise<Photo>自版本: 1.0.0
pickImages(...)
pickImages(options: GalleryImageOptions) => Promise<GalleryPhotos>
允许用户从相册选择多张图片。 在 iOS 13 及更早版本上，只能选择一张图片。
| 参数 | 类型 |
|---|---|
options | |
返回值:
Promise<GalleryPhotos>自版本: 1.2.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,' 开头的 base64 编码数据 URL | 1.0.0 |
path | string | 使用 CameraResultType.Uri 时，返回完整的平台特定文件 URL，可通过 Filesystem API 读取 | 1.0.0 |
webPath | string | 返回可用作图片 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 | |
preserveAspectRatio | boolean | 此设置无效。图片调整大小始终会保持宽高比。 | 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/v3/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 | 返回可用作图片 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' |