开发
API
自2022年9月6日起,本文档站不再更新内容,相关文档已迁移至全新“抖音开放平台”前往

tt.navigateToVideoView

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

跳转到被分享视频的播放页面。

语法

tt.navigateToVideoView(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
videoIdstring被分享视频的 id。开发者通过指定Page.onShareAppMessage 中返回值的 extra.withVideoId 字段为 true,就可在用户分享成功的回调参数中获取到视频的 id。详情请参考 onShareAppMessage - “拓展参数 extra 说明”部分及下方代码示例1.48.1
encryptedIdstring加密后的抖音开放平台的视频 id2.18.0
successfunction接口调用成功回调函数1.48.1
failfunction接口调用失败回调函数1.48.1
completefunction接口调用结束的回调函数(调用成功、失败都会执行)1.48.1

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring跳转成功信息,恒为'navigateToVideoView:ok'1.48.1

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring跳转失败信息,以'navigateToVideoView:fail'开头1.48.1
errCodenumber错误代码1.48.1

errCode 的可枚举值:

描述
1001videoId 类型不正确
1002视频已经被删除
1003videoId 不正确
1004获取视频信息错误
1005其他错误
1006网络错误
1007客户端其他错误
1008客户端参数错误

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

Page({
  onShareAppMessage: function () {
    return {
      channel: "video",
      title: "分享标题",
      desc: "分享描述",
      extra: {
        videoTopics: ["hello", "hi"],
        withVideoId: true,
      },
      success(res) {
        // 分享成功后,通过 videoId 跳转到被分享视频的播放页面
        tt.navigateToVideoView({
          videoId: res.videoId,
          success() {
            console.log("跳转被分享视频播放页成功");
          },
          fail(err) {
            console.log("跳转被分享视频播放页失败", err.errMsg, err.errCode);
          },
          complete() {
            console.log("navigateToVideoView 调用完成");
          },
        });
      },
    };
  },
});

Bug & Tip

  • Tip:encryptedId 和 videoId 两者只需要传一个,当两个都传时,会按照 encryptedId 处理;
  • Tip:如果跳转后不能播放,请检查视频是否缺少公开访问权限,或账号是否被设为了抖音私密账号。
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助