LiveManager.getLiveStatus
收藏我的收藏
收藏基础库 3.60.0 开始支持本方法，这是一个异步方法。
获取关联玩法的主播/直播间信息
| 前提条件 | 在使用前需前往直播玩法后台，在能 力 - 进阶互动能力中申请【玩法扩展组件能力】。申请后，需选择对应小游戏关联。 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | 无 |
| 相关教程 | 无 |
语法
LiveManager.getLiveStatus(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| openIdList | Array<string> | 是 | 要查询的主播 openId 列表 | 3.60.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 3.60.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 3.60.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 3.60.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| liveStatus | object | 直播间信息。liveStatus为一个对象，key值是主播openId，value值为该主播直播间的查询信息 | 3.60.0 |
| errMsg | string | "LiveManager.getLiveStatus:ok" | 3.60.0 |
liveStatus 参数说明
liveStatus 的 key 值是主播 openId，value 值为该主播直播间的查询信息，其属性如下：
属性名 | 类型 | 说明 | 最低支持版本 |
open_id | string | 主播 openid | 3.60.0 |
is_on_live | boolean | 是否正在直播 | 3.60.0 |
nickname | string | 主播昵称 | 3.60.0 |
avatar_url | string | 头像 url | 3.60.0 |
room_id | string | 直播间ID | 3.60.0 |
app_id | string | 对应小玩法ID | 3.60.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "LiveManager.getLiveStatus:fail" + 详细错误信息 | 3.60.0 |
代码示例
const liveManager = tt.getLiveManager(); liveManager.getLiveStatus({ openIdList: ['xxxx'], // 查询主播的openid success: (res) => { console.log('查询成功，直播间信息如下', res.liveStatus) }, fail: (res) => { console.log('查询失败', res) }, })
