@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 访问原始文件，如果需要（或者传递 resultType: CameraResultType.Base64 给 getPhoto），
// 可以将其传递给 Filesystem API 以读取图像的原始数据。
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
接口#### 照片
| 属性 | 类型 | 说明 | 始于版本 |
|---|---|---|---|
base64String | string | 图像的 base64 编码字符串表示，如果使用 CameraResultType.Base64. | 1.0.0 |
dataUrl | string | 以 'data:image/jpeg;base64,' 开头并包含图像 base64 编码字符串的 URL，如果使用 CameraResultType.DataUrl. | 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 仅在通过文件输入（file input）方式使用时才被支持。 | 1.0.0 |
saved | boolean | 图像是否已保存到相册。在 Android 和 iOS 上，如果用户未授予必要的权限，保存到相册可能会失败。Web 上没有相册概念，因此始终返回 false。 | 1.1.0 |
| 属性 | 类型 | 说明 | 默认值 | 起始版本 |
|---|---|---|---|---|
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 元素体验或文件输入。默认是使用 PWA 元素（如果已安装），否则回退到文件输入。要始终使用文件输入，请将此设置为 true。了解更多关于 PWA 元素的信息：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 |
| 属性 | 类型 | 说明 | 始于 |
|---|---|---|---|
path | string | 完整的、平台特定的文件 URL，稍后可以使用文件系统 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[] |
类型别名
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' |