抖音开放平台Logo
控制台

tt.previewImage
收藏
我的收藏

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

预览一组图片。

前提条件无
业务背景无
使用限制无
注意事项
  • 抖音不支持预览图片保存功能。
  • 当 urls 中存在多个相同的图片地址，预览时会选择 current 地址对应的第一张图片进行展示，可通过给图片地址增加 query 或 hash 值避免地址重复。
相关教程无

语法

tt.previewImage(options)

参数说明

options 为 object 类型，属性如下：

属性名类型默认值必填说明最低支持版本
currentstringurls[0] 的内容否

当前显示图片的链接，不填则默认为 urls 中的第一张

1.0.0
urlsarray是

需要预览的图片地址列表

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

回调成功

object 类型，属性如下：

属性名类型说明最低支持版本
errMsgstring
"previewImage:ok"
1.0.0

回调失败

object 类型，属性如下：

属性名类型说明最低支持版本
errMsgstring
"previewImage:fail" + 详细错误信息
1.0.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.previewImage({
  urls: ["image1", "image2", "image3"],
  current: "image3",
  success(res) {
    console.log(`previewImage调用成功`);
  },
  fail(res) {
    console.log(`previewImage调用失败`);
  },
});