开发
API

tt.getRoomInfo

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

获取直播间基础信息。

语法

tt.getRoomInfo(options);

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
successfunction--接口调用成功的回调函数2.24.0
failfunction--接口调用失败的回调函数2.24.0
completefunction--接口调用结束的回调函数(调用成功、失败都会执行)2.24.0

回调成功

参数为 object 类型,属性如下:

参数参数类型说明最低支持版本
errMsgstring"getRoomInfo:ok"2.24.0
roomInfoobject房间信息2.24.0

roomInfo 为 object 类型,属性如下:

参数参数类型说明最低支持版本
roomIDstring房间 ID2.24.0
liveDurationnumber开播时长,单位为秒2.24.0

回调失败

参数为 object 类型,属性如下:

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

errCode 的可枚举值:

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

代码示例

开发者工具中预览

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

Bug & Tip

  • Tips:目前该接口只支持抖音 App,版本需满足 17.6.0 版本及以上
点击纠错
评价此篇文档