LiveManager.uploadGameProgress
收藏我的收藏
基础库 3.85.0 开始支持本方法,这是一个异步方法。
上传主播游玩场景配置。
前提条件 | 使用前,请先前往游戏开放后台,申请 开通直播即看即玩能力 |
业务背景 | 无 |
使用限制 | 仅在直播场景下可调用 |
注意事项 | 无 |
相关教程 |
语法
LiveManager.uploadGameProgress(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
data | string | 是 | 游玩进度配置信息,长度不超过512KB | 3.85.0 | |
success | function | 否 | 接口调用成功的回调函数 | 3.85.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 3.85.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 3.85.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "LiveManager.uploadGameProgress:ok" | 3.85.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "LiveManager.uploadGameProgress:fail" + 详细错误信息 | 3.85.0 |
errNo | number | 错误码,对应信息可参考错误码说明 | 3.85.0 |
错误码
errNo | errMsg | 说明 | 最低支持版本 |
---|---|---|---|
20001 | invalid param | 参数类型错误 | 3.85.0 |
21100 | can only call in video live | 仅在视频直播和伴侣挂载启动场景下可调用 | 3.85.0 |
21101 | can only call in anchor 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 | frequency limit | 频控限制 (10s/每次) | 3.85.0 |
21105 | data is too large | 数据过大(512KB) | 3.85.0 |
21106 | server error | 服务端错误 | 3.85.0 |
代码示例
const liveManager = tt.getLiveManager(); liveManager.uploadGameProgress({ data: '当前游戏关卡: 100', // 上传游戏进度信息 success: () => { console.log('上传成功'); }, fail: (res) => { console.log('上传失败', res); }, });