getPicture
通过调用系统默认相机或者图库应用,获取图片以及视频媒体文件。
getPicture({params}, callback(ret, err))
params
sourceType:
- 类型:字符串
- 默认值:library
- 描述:(可选项)图片源类型,从相册、图片库或相机获取图片
- 取值范围
library //图片库
camera //相机
album //相册
encodingType:
- 类型:字符串
- 默认值:png
- 描述:(可选项)返回图片类型,jpg或png
- 取值范围
jpg //指定图片格式为jpg
png //指定图片格式为png
mediaValue:
- 类型:字符串
- 默认值:pic
- 描述:(可选项)媒体类型,图片或视频
- 取值范围
pic //图片
video //视频
all //图片和视频,Android不支持
destinationType:
- 类型:字符串
- 默认值:url
- 描述:(可选项)返回数据类型,指定返回图片地址或图片经过base64编码后的字符串
- 取值范围
base64 //指定返回数据为base64编码后内容
url //指定返回数据为选取的图片地址
direction:
- 类型:字符串
- 默认值:rear
- 描述:(可选项)选择前置或后置摄像头,取值范围(front、rear),只支持iOS
allowEdit:
- 类型:布尔
- 默认值:false
- 描述:(可选项)是否可以选择图片后进行编辑,支持iOS及部分安卓手机
preview:
- 类型:布尔
- 默认值:false
- 描述:(可选项)是否选择图片后进行预览,只支持iOS。
quality:
- 类型:数字
- 默认值:50
- 描述:(可选项)图片质量,只针对jpg格式图片(0-100整数)
videoQuality:
- 类型:字符串
- 默认值:medium
- 描述:(可选项)视频质量,调用相机录制视频时该参数生效。取值范围(low、medium、high),质量越高,录制的视频文件占用存储空间越大。
targetWidth:
- 类型:数字
- 默认值:原图宽度
- 描述:(可选项)压缩后的图片宽度,图片会按比例适配此宽度
targetHeight:
- 类型:数字
- 默认值:原图高度
- 描述:(可选项)压缩后的图片高度,图片会按比例适配此高度
saveToPhotoAlbum:
- 类型:布尔
- 默认值:false
- 描述:(可选项)拍照或录制视频后是否保存到系统相册目录。注意此处仅是文件系统层面的操作,使用诸如“图库”App仍然有可能查看到。
groupName:
- 类型:字符串
- 默认值:无
- 描述:(可选项)保存图片到自定义分组相册目录,相册不存在则会进行创建。
- 可用性:可提供的1.2.74及更高版本
callback(ret, err)
ret:
- 类型:JSON 对象
- 内部字段:
{
data:"", //图片路径
base64Data:"", //base64数据,destinationType为base64时返回
duration:0 //视频时长(数字类型)
}
err:
- 类型:JSON 对象
- 内部字段:
{
msg:"" //错误描述
}
示例代码
api.getPicture({
sourceType: 'camera',
encodingType: 'jpg',
mediaValue: 'pic',
destinationType: 'url',
allowEdit: true,
quality: 50,
targetWidth: 100,
targetHeight: 100,
saveToPhotoAlbum: false
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
补充说明
获取图片
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本