LiveManager.navigateToLive
收藏我的收藏
基础库 3.60.0 开始支持本方法,这是一个异步方法。
跳转到指定直播间。
前提条件 | 在使用前需前往直播玩法后台,在能力 - 进阶互 动能力中申请【玩法扩展组件能力】。申请后,需选择对应小游戏关联。 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 | 无 |
相关教程 | 无 |
语法
LiveManager.navigateToLive(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
roomID | string | 是 | 直播间 ID。可以从 LiveManager.getLiveStatus 中获取主播直播间 id。 | 3.60.0 | |
success | function | 否 | 接口调用成功的回调函数 | 3.60.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 3.60.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 3.60.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "LiveManager.navigateToLive:ok" | 3.60.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "LiveManager.navigateToLive:fail" + 详细错误信息 | 3.60.0 |
错误码
errNo | errMsg | 说明 | 最低支持版本 |
---|---|---|---|
20001 | invalid param | 参数校验错误 | 3.60.0 |
21001 | live room is closed | 直播间已关闭 | 3.60.0 |
21003 | live room does not exist | 直播间不存在 | 3.60.0 |
21004 | interact game in the live room is unmount | 直播间未挂载绑定小玩法 | 3.60.0 |
10401 | system error, please retry | 网络 / 系统错误 | 3.60.0 |
10101 | platform auth deny | 不在白名单列表中,请先申请能力 | 3.60.0 |
代码示例
const liveManager = tt.getLiveManager(); liveManager.navigateToLive({ roomID: 'xxxx', // 直播间ID success: (res) => { console.log('跳转直播间成功', res) }, fail: (res) => { console.log('跳转直播间失败', res) } })