抖音开放平台Logo
控制台

tt.chooseImage
收藏
我的收藏

基础库 1.0.0 开始支持本方法,这是一个异步方法。

从系统相册中选择图片,或使用相机拍摄图片,选取成功后将存入本地临时文件,并在 success 回调中返回相应路径列表。

前提条件

该 API 需要用户授权方可调用,详细信息可参考用户授权

业务背景
使用限制
注意事项
  • Android 上所选图片总大小不能超过 180M
  • 暂不支持sizeType参数。
  • 手动取消也会触发失败回调,回调参数为 chooseImage:fail cancel,可以通过判断详细错误信息区分取消和其他错误。
相关教程

语法

tt.chooseImage(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
countnumber9

最多可以选择的图片数量,拍照时此选项无效

1.0.0
sourceTypearray["album", "camera"]

指定图片来源,album 从相册选图,camera 使用相机,默认二者都有

1.0.0
successfunction
接口调用成功的回调函数
1.0.0
failfunction
接口调用失败的回调函数
1.0.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
1.0.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
tempFilesarray

图片对象数组,对象结构详见下表

1.0.0
tempFilePathsarray

图片的本地文件路径列表

1.0.0
errMsgstring
"chooseImage:ok"
1.0.0

tempFiles 类型说明

object 类型,属性如下:

属性名类型说明最低支持版本
pathstring

本地文件路径

1.0.0
sizenumber

本地文件大小(单位:B)

1.0.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring

"chooseImage:fail" + 详细错误信息

回调失败执行时机有:手动取消、参数错误,没有授权、文件路径为空、文件路径不存在。

1.0.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.chooseImage({
  sourceType: ["album"],
  count: 3,
  success(res) {
    this.setData({
      images: res.tempFilePaths,
    });
  },
  fail(res) {
    console.log(`chooseImage调用失败`);
  },
});