帮你快速理解、总结文档立即下载

选择图片

最近更新时间:2024-12-06 16:36:02
我的收藏

接口描述

接口名:media.chooseImage
描述:从系统相册中选择图片,或使用相机拍摄图片,并对图片进行配置。
支持的客户端:Android、iOS。
支持的版本:3.12.0 版本以上。
是否需要鉴权:是。

输入参数

参数名称
必选
参数类型
参数描述
sourceType
否
SourceType 对象数组
用于指定图片来源是相册还是相机,默认二者都有。
sizeType
否
String []
可以指定是原图还是压缩图,默认二者都有。
original:原图
compressed:压缩图
isSaveToAlbum
否
Number
是否保存到相册,默认值是 1。
0:表示拍照时不保存到系统相册
1:表示自动保存
maxCount
否
Number
可选图片最大数量,取值范围[1,9],默认为1;使用 camera 作为来源时该字段失效。
title
否
String
标题。
subTitle
否
String
副标题。
customButtonList
否
CustomButtonList 对象数组
自定义文案。
crop
是
Crop 对象数组
裁剪配置。
cropRatio
是
String []
裁剪参数:[宽,高]。
successCallback
是
-
选图成功回调函数。
failedCallback
是
-
选图失败回调函数。

SourceType 对象

参数名称
必选
参数类型
参数描述
type
是
String
指定来源类型。
album:相册
camera:相机
text
是
String
标题,如:从相册选择、拍照。

CustomButtonList 对象

参数名称
必选
参数类型
参数描述
text
否
String
自定义按钮文案。
callback
否
String
自定义按钮点击回调。

Crop 对象

参数名称
必选
参数类型
参数描述
enable
是
Boolean
是否支持裁剪。
freeRatio
是
Boolean
是否支持自由拖拽。

输出参数

参数名称
参数类型
参数描述
code
Number
结果码。
message
String
结果信息。
images
-
选图成功回调返回的数据,调用失败回调时不返回。
localId:所选图片的在手机本地对应的 ID
ret
Number
选图失败回调返回数据,调用成功回调时不返回。
1:无权限
2:取消选图

代码示例

wemeet.media.chooseImage({
success: (resp) => {
const { images } = resp;
console.log('chooseImage success', images[0].localId);
},
fail: (err) => {
const { ret } = err;
if (ret === 1) {
console.log('chooseImage PERMISSION_ERROR', err);
} else if (ret === 2) {
console.log('chooseImage USER_CANCEL', err);
} else {
console.error('chooseImage failed', err);
}
}
})
.catch(err => {
console.error('chooseImage failed', err);
})