抖音开放平台Logo
控制台

aweme-data 直播间状态组件

更新时间 2024-07-24 02:58:49
收藏
我的收藏
​基础库 2.53.0 开始支持本组件，低版本需做兼容处理。​
直播间状态组件。​
使用该功能前开发者需要去开发者后台为对应的抖音号申请 直播呼吸灯组件 能力，详情见引导跳转到直播间能力​

​属性说明​

属性名​
类型​
默认值​
必填​
说明​
最低支持版本​
aweme-id​
string​
​
是​
用户的抖音号，可以进入抖音 App 用户个人主页查看。只支持小程序绑定的品牌号、合作号。​
2.53.0​
type​
"avatar" | "nickname"​
"avatar"​
否​
类型，可以选择头像或昵称​
2.53.0​
disable-default​
boolean​
false​
否​
是否禁用头像点击的默认行为。 ​
如果为false，点击头像时，如果用户处于直播状态下会跳转到直播间，非直播状态下跳转到个人主页。 ​
如果为 true，点击头像将不会有任何的跳转行为。​
2.53.0​
default-avatar​
string​
​
否​
获取信息失败时显示的默认头像 url​
2.53.0​
default-text​
string​
​
否​
获取信息失败时显示的默认昵称文本​
2.53.0​
binderror​
EventHandle​
​
否​
当错误发生时触发​
2.53.0​

​type 的合法值​

值​
说明​
最低支持版本​
avatar​
展示头像，当用户处于直播状态时，头像会带有呼吸灯效果​
2.53.0​
nickname​
展示昵称​
2.53.0​

​binderror 事件对象的 detail​

object 类型，属性如下：​
属性名​
类型​
说明​
最低支持版本​
errNo​
number​
错误码​
2.53.0​
errMsg​
string​
错误信息​
2.53.0​
错误说明​
errNo​
errMsg​
说明​
最低支持版本​
21504​
awemeId not support​
抖音号没有在开发者后台申请 直播呼吸灯组件 能力。​
2.92.0​
21505​
awemeId not exist​
抖音号不存在​
2.92.0​

​扫码体验​

​

​代码示例​

​开发者工具中预览​
HTML
复制
<!-- 默认行为，点击头像时会根据用户是否处于直播状态分别跳转到直播间和个人页 -->
<aweme-data aweme-id="xxx" type="avatar" />
<!-- 禁用默认行为，可以自行处理点击之后的逻辑 -->
<aweme-data
aweme-id="xxx"
disable-default="{{true}}"
bindtap="onAvatarClick"
type="avatar"
/>
JavaScript
复制
Page({
onAvatarClick() {
console.log("avatar has been clicked");
},
});

​Bug & Tip​

    •​Tip：使用该功能前开发者需要去开发者后台为对应的抖音号申请 直播呼吸灯组件 能力。​
​