LiveManager.syncGameProgress
收藏我的收藏
基础库 3.85.0 开始支持本方法,这是一个异步方法。
观众侧同步主播游玩进度配置信息。
前提条件 | 使用前,请先前往游戏开放 后台,申请开通直播即看即玩能力 |
业务背景 | 无 |
使用限制 | 仅在直播场景下可调用 |
注意事项 | 在一次小游戏启动周期内,data 的值不会发生变化,只有重新进入游戏才会刷新 |
相关教程 | 无 |
语法
LiveManager.syncGameProgress(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
success | function | 否 | 接口调用成功的回调函数 | 3.85.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 3.85.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 3.85.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
data | string | 主播游玩进度配置信息 | 3.85.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "LiveManager.syncGameProgress:fail" + 详细错误信息 | 1.0.0 |
errNo | number | 错误码,对应信息可参考错误码说明 | 1.0.0 |
错误码
errNo | errMsg | 说明 | 最低支持版本 |
---|---|---|---|
21100 | can only call in video live | 仅在主播视频开播或伴侣挂载启动游戏开播场景下可调用 | 3.85.0 |
21101 | can only call in audience side | 仅在观众端可调用 | 3.85.0 |
21102 | the game's instant play is closed | 游戏未开通即玩能力 | 3.85.0 |
21103 | anchor's instant play is closed | 主播未打开即玩开关 | 3.85.0 |
21104 | serve error | 服务端错误 | 3.85.0 |
代码示例
const liveManager = tt.getLiveManager(); liveManager.syncGameProgress({ success: (res) => { console.log('当前主播游玩进度信息:', res.data); }, fail: (res) => { console.log('获取失败', res); }, });