抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • API 概览
  • C# API
  • 开放接口
  • 登录
  • 侧边栏能力
  • 设置
  • 授权
  • 添加到桌面
  • 游戏排行榜
  • 订阅消息
  • 开放数据域
  • 开放数据
  • 开放数据分组
  • 客服消息
  • 直播能力
  • tt.getLiveManager
  • LiveManager
  • LiveManager.getLiveStatus
  • LiveManager.checkRoomIsValid
  • LiveManager.navigateToLive
  • LiveManager.onXScreenSizeChange
  • LiveManager.offXScreenSizeChange
  • LiveManager.getLiveSetting
  • LiveManager.uploadGameProgress
  • LiveManager.syncGameProgress
  • LiveManager.onInstantPlayStatusChange
  • LiveManager.offInstantPlayStatusChange
  • 推荐流直出游戏能力
  • 公会群能力
  • 意见反馈
  • 游戏站
  • 收藏
  • 群聊
  • 广告
  • 关注
  • 数据分析
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 转发
  • 数据缓存
  • 广告
  • 界面
  • 支付
  • Worker
  • LiveManager.syncGameProgress
    收藏
    我的收藏

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

    观众侧同步主播游玩进度配置信息。

    前提条件
    使用前,请先前往游戏开放后台,申请开通直播即看即玩能力
    业务背景
    使用限制
    仅在直播场景下可调用
    注意事项
    在一次小游戏启动周期内,data 的值不会发生变化,只有重新进入游戏才会刷新
    相关教程

    语法

    LiveManager.syncGameProgress(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    successfunction
    接口调用成功的回调函数
    3.85.0
    failfunction
    接口调用失败的回调函数
    3.85.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    3.85.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    datastring
    主播游玩进度配置信息
    3.85.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "LiveManager.syncGameProgress:fail" + 详细错误信息
    1.0.0
    errNonumber
    错误码,对应信息可参考错误码说明
    1.0.0

    错误码

    errNoerrMsg说明最低支持版本
    21100can only call in video live
    仅在主播视频开播或伴侣挂载启动游戏开播场景下可调用
    3.85.0
    21101can only call in audience side
    仅在观众端可调用
    3.85.0
    21102the game's instant play is closed
    游戏未开通即玩能力
    3.85.0
    21103anchor's instant play is closed
    主播未打开即玩开关
    3.85.0
    21104serve error
    服务端错误
    3.85.0

    代码示例

    const liveManager = tt.getLiveManager(); liveManager.syncGameProgress({ success: (res) => { console.log('当前主播游玩进度信息:', res.data); }, fail: (res) => { console.log('获取失败', res); }, });