nativecamera
提供设备相机的API
npm i --save nativecamera

NativeScript Camera 构建状态

欢迎使用 NativeScript 框架的 nativecamera 插件

(可选) 先决条件 / 需求

使用相机插件

概述

几乎每个移动应用程序都需要捕捉、保存和分享图片的功能。NativeScript 相机插件旨在处理这项任务的前两部分(拍照和可选地保存到设备存储)。

安装

导航到项目文件夹并运行 NativeScript-CLI 命令

tns plugin add nativescript-camera

插件可以作为标准的 npm 依赖项添加,运行命令

npm install nativescript-camera --save 

注意:使用 --save 标志将在您的 package.json 文件中将插件添加为依赖项

API

方法

方法 描述
takePicture(options?: CameraOptions) 使用相机拍照,可选参数用于设置不同的相机选项。
requestPermissions() 请求用户权限以访问其保存的照片以及其相机。返回一个 Promise。
requestCameraPermissions() 请求用户权限以访问其相机。返回一个 Promise。
requestPhotosPermissions() 请求用户权限以访问其保存的照片。返回一个 Promise。
isAvailable() 设备相机是否可用于使用。

CameraOptions

属性 默认值 平台 描述
width 0 两者 定义所需图像的宽度(以设备独立像素为单位)。应与高度属性一起使用。如果使用 keepAspectRatio,实际图像宽度可能不同,以保持原始相机图像的纵横比。如果设备的显示密度高于(1)(全高清+分辨率),实际图像宽度将大于请求的宽度。
height 0 两者 定义所需图像的高度(以设备独立像素为单位)。应与宽度属性一起使用。如果使用 keepAspectRatio,实际图像高度可能不同,以保持原始相机图像的纵横比。如果设备的显示密度高于(1)(全高清+分辨率),实际图像高度将大于请求的高度。
keepAspectRatio true 两者 定义在调整图片大小时是否应保持相机图片的纵横比。此属性可能影响宽度和高度返回值。
saveToGallery true 两者 定义相机图片是否应复制到照片库(Android)或照片(iOS)
allowsEditing false iOS 定义相机“重新拍照”或“使用照片”屏幕是否强制用户裁剪相机图片成正方形,并可选择让他们放大。
cameraFacing rear 两者 初始相机方向。使用 'front' 进行自拍。

注意:在Android设备上,saveToGallery选项可能会有意想不到的行为!一些厂商的相机应用(例如LG)会无论saveToGallery的值如何,都将所有捕获的图片保存到相册中。这种行为无法通过相机插件控制,如果您必须将捕获的图片排除在照片库之外,您需要获取本地存储的读写权限,并编写自定义代码以找到相册位置并从那里删除新图片。

用法

请求权限

Android和iOS都需要显式权限才能允许应用程序访问相机并将照片保存到设备上。一旦用户授予权限,就可以使用相机模块。

camera.requestPermissions().then(
function success() {
// permission request accepted or already granted
// ... call camera.takePicture here ...
},
function failure() {
// permission request rejected
// ... tell the user ...
}
);

Android注意事项:对于不使用请求权限弹窗的旧版Android,不会受到requestPermissions方法使用的影响。

iOS注意事项:如果用户拒绝iOS弹窗中的权限,应用程序将不允许再次请求。您可以指导用户前往应用程序设置,并手动从那里启用相机权限。此外,App Store指南5.1.1要求应用程序阐明相机和照片库的使用情况。为此,请编辑您的app/App_Resources/iOS/Info.plist并添加以下说明

<key>NSCameraUsageDescription</key>
<string>enter your camera permission request text here</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>enter your photo library permission request text here</string>

使用相机模块拍照

使用相机模块相对简单。然而,有一些要点需要更多的解释。

为了使用相机模块,只需要求它,如示例1所示

示例1:在应用程序中要求相机模块

var camera = require("nativescript-camera");
import * as camera from "nativescript-camera";

然后您就可以开始使用了

示例2:如何拍照并接收图像资产

var imageModule = require("tns-core-modules/ui/image");
camera.takePicture()
.then(function (imageAsset) {
console.log("Result is an image asset instance");
var image = new imageModule.Image();
image.src = imageAsset;
}).catch(function (err) {
console.log("Error -> " + err.message);
});
import { Image } from "tns-core-modules/ui/image";
camera.takePicture().
then((imageAsset) => {
console.log("Result is an image asset instance");
var image = new Image();
image.src = imageAsset;
}).catch((err) => {
console.log("Error -> " + err.message);
});

示例2中的代码将启动本地平台相机应用程序。拍照并点击按钮保存(Android)或使用图像(iOS)后,承诺将解析then部分,并将图像资产设置为ui/image控制的src

使用选项拍摄内存高效的图片

示例2展示了如何使用NativeScript相机模块拍照。然而,它拍摄了一个巨大的图片(即使是中端设备也有500万像素的相机,生成的图片为2580x2048,在位图中的意思是大约15MB)。在许多情况下,您不需要如此大的图片来显示100x100大小的图片,因此拍摄大图片只是浪费内存。camera takePicture()方法接受一个可选参数,可以帮助解决这个问题。使用该可选参数,您可以设置一些属性,如下

  • width:图片的期望宽度(以设备独立像素为单位)。
  • height:图片的期望高度(以设备独立像素为单位)。
  • keepAspectRatio:一个布尔参数,表示是否应保持纵横比。
  • saveToGallery:一个布尔参数,表示是否将原始拍摄的图片保存到Android的“照片”和iOS的“相机胶卷”中。
  • allowsEditing:(仅限iOS)一个布尔参数,表示相机“重拍”或“使用照片”屏幕是否强制用户裁剪相机图片为正方形,并且可选地允许他们放大。
  • cameraFacing:从设备的“前”或“后”(默认)相机开始。当前实现并不适用于所有Android设备,在这种情况下将回退到默认行为。

什么是设备无关像素?NativeScript布局机制在测量UI控件时使用设备无关像素。这允许您声明一个布局,这个布局在所有设备上看起来都相似(不管设备的显示分辨率如何)。为了获得高分辨率设备(如iPhone视网膜和Android全高清)的正确图像质量,相机将返回一个具有更大维度的图像。例如,如果我们请求一个100x100的图像,在iPhone 6上实际的图像将是200x200(因为它的显示密度因子是2 -> 1002x1002)。设置keepAspectRatio属性可能导致请求的宽度和高度不同。相机将返回具有正确宽高比的图像,但通常只有宽度和高度中的一个将与请求相同;另一个值将计算出来,以保持原始图像的宽高比。

示例3展示了如何使用选项参数

示例3:如何为相机模块设置widthheightkeepAspectRatiosaveToGallery属性

var imageModule = require("tns-core-modules/ui/image");

var options = { width: 300, height: 300, keepAspectRatio: false, saveToGallery: true };
camera.takePicture(options)
.then(function (imageAsset) {
console.log("Size: " + imageAsset.options.width + "x" + imageAsset.options.height);
console.log("keepAspectRatio: " + imageAsset.options.keepAspectRatio);
console.log("Photo saved in Photos/Gallery for Android or in Camera Roll for iOS");
}).catch(function (err) {
console.log("Error -> " + err.message);
});
import { Image } from "tns-core-modules/ui/image";

var options = { width: 300, height: 300, keepAspectRatio: false, saveToGallery: true };
camera.takePicture(options).
then((imageAsset) => {
console.log("Size: " + imageAsset.options.width + "x" + imageAsset.options.height);
console.log("keepAspectRatio: " + imageAsset.options.keepAspectRatio);
console.log("Photo saved in Photos/Gallery for Android or in Camera Roll for iOS");
}).catch((err) => {
console.log("Error -> " + err.message);
});

检查设备是否有可用的相机

开发人员应该检查的第一件事是设备是否有可用的相机。如果相机硬件准备就绪可使用,则方法isAvailable将返回true,否则返回false。

var isAvailable = camera.isAvailable(); 

注意:此方法在iOS模拟器中使用时将返回false(因为模拟器没有相机硬件)

贡献

我们喜欢Pull Requests!请查看贡献指南。如果您想贡献,但不确定从哪里开始 - 查找标记为help wanted问题

获取帮助

请,仅使用GitHub问题报告错误请求新功能。对于一般问题和支持,请查看Stack Overflow或在我们的NativeScript社区Slack频道中向我们的专家提问。