抖音开放平台Logo
开发者文档
控制台

tt.getLiveRoomCardInfo

收藏
我的收藏

基础库 3.41.0 开始支持本方法,这是一个异步方法。

用于获取直播间互动插件卡片挂件开发信息。

前提条件
业务背景
使用限制
注意事项
支持沙盒
相关教程

语法

tt.getLiveRoomCardInfo(options)

参数说明

options 为 object 类型,属性如下:

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

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"getLiveRoomCardInfo:ok"
3.41.0
liveCardMaxWidthnumber
直播玩法卡片最大展示宽度
3.41.0
liveCardMaxHeightnumber
直播玩法卡片最大展示高度
3.41.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"getLiveRoomCardInfo:fail " + 错误信息
3.41.0

代码示例

tt.getLiveRoomCardInfo({ success(res) { console.log('调用成功:', res.liveCardMaxWidth, res.liveCardMaxHeight); }, fail(err) { console.log('调用失败:', err.errMsg); } });