抖音开放平台Logo
控制台

tt.preloadVideo
收藏
我的收藏

基础库 2.8.0 开始支持本方法，低版本需做兼容处理，这是一个异步方法。

创建视频预加载任务。预加载成功后的视频资源生效区间为整个小程序。

前提条件无
业务背景无
使用限制无
注意事项无
支持沙盒
否
相关教程无

语法

tt.preloadVideo(options)

参数说明

options 为 object 类型，属性如下：

属性名类型默认值必填说明最低支持版本
srcstring是
视频资源地址
2.8.0
sizenumber819200否

预加载大小，单位 Byte，取值范围 0 ～ 1M。默认值为800*1024

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

回调成功

object 类型，属性如下：

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

回调失败

object 类型，属性如下：

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

返回值

类型说明最低支持版本
object

PreloadVideoTask

2.8.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

<button type="primary" size="default" bindtap="preload">开始预加载</button>
<button type="primary" size="default" bindtap="abort">中断预加载</button>
<text>{{logs}}</text>
<video tt:if="{{show}}" autoplay="{{true}}" src="{{src}}"></video>
Page({
  data: {
    src: "https//sf1-cdn-tos.douyinstatic.com/obj/microapp/frontend/misc/test-upload.mp4",
    logs: "",
    show: false,
  },
  preload() {
    this.setData({
      logs: "开始预加载\n",
    });
    this.task = tt.preloadVideo({
      src: this.data.src,
      success: () => {
        this.setData({
          logs: this.data.logs + "预加载成功\n",
          show: true,
        });
      },
      fail: (error) => {
        console.log("预加载失败", error);
        this.setData({
          logs: this.data.logs + "预加载失败: " + error.errMsg,
        });
      },
    });
    this.abort();
  },
  abort() {
    if (this.task) {
      this.task.abort();
    }
  },
});