tt.getRoomInfo
收藏
我的收藏

基础库 2.24.0 开始支持本方法，该 API 为异步 API。
调用：主播端/观众端
使用该功能前，开发者需要申请并通过「直播能力」准入，并开通「获取直播间基础信息」能力，具体可参考接入流程。

警告
此接口将逐步废弃，后续不再维护，请及时修改下线，避免影响小程序使用​

获取直播间基础信息。

语法

js复制
tt.getRoomInfo(options);

参数说明

options 为 object 类型，属性如下：

属性名	类型	默认值	必填	说明	最低支持版本
success	function	--	否	接口调用成功的回调函数	2.24.0
fail	function	--	否	接口调用失败的回调函数	2.24.0
complete	function	--	否	接口调用结束的回调函数（调用成功、失败都会执行）	2.24.0

回调成功

参数为 object 类型，属性如下：

参数	参数类型	说明	最低支持版本
errMsg	string	"getRoomInfo:ok"	2.24.0
roomInfo	object	房间信息	2.24.0

roomInfo 为 object 类型，属性如下：

参数	参数类型	说明	最低支持版本
roomID	string	房间 ID	2.24.0
liveDuration	number	开播时长，单位为秒	2.24.0

回调失败

参数为 object 类型，属性如下：

属性名	类型	说明	最低支持版本
errCode	number	错误代码	2.24.0
errMsg	string	"getRoomInfo:fail " + 详细错误信息	2.24.0

errCode 的可枚举值：

值	说明
40001	参数错误
40002	没有调用权限
40007	接口调用频率过高

代码示例

开发者工具中预览

js复制
tt.getRoomInfo({ 
  success(res) {
    console.log(
      `房间ID:${res.roomInfo.roomID}, 开播时长:${res.roomInfo.liveDuration}`
    );
  },
  fail(res) {
    console.log(`获取直播间基础信息失败，错误码:${res.errCode}`);
  },
});