tt.chooseImage
收藏我的收藏
基础库 1.0.0 开始支持本方法,这是一个异步方法。
从系统相册中选择图片,或使用相机拍摄图片,选取成功后将存入本地临时文件,并在 success 回调中返回相应路径列表。
前提条件 | 该 API 需要用户授权方可调用,详细信息可参考用户授权。 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 |
|
相关教程 | 无 |
语法
tt.chooseImage(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
count | number | 9 | 否 | 最多可以选择的图片数量,拍照时此选项无效 | 1.0.0 |
sourceType | Array<string> | ["album", "camera"] | 否 | 指定图片来源,album 从相册选图,camera 使用相机,默认二者都有 | 1.0.0 |
success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.0.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
tempFiles | array | 图片对象数组,对象结构详见下表 | 1.0.0 |
tempFilePaths | array | 图片的本地文件路径列表 | 1.0.0 |
errMsg | string | "chooseImage:ok" | 1.0.0 |
tempFiles 类型说明
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
path | string | 本地文件路径 | 1.0.0 |
size | number | 本地文件大小(单位:B) | 1.0.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "chooseImage:fail" + 详细错误信息 回调失败执行时机有:手动取消、参数错误,没有授权、文件路径为空、文件路径不存在。 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.chooseImage({ sourceType: ["album"], count: 3, success(res) { this.setData({ images: res.tempFilePaths, }); }, fail(res) { console.log(`chooseImage调用失败`); }, });