虎牙开放平台文档

hyExt.context.onVipEnterBannerNotice

  • 监听高级用户进场
  • 引入版本 1.7.0
  • 适用终端
    • 虎牙直播主站
    • 虎牙直播APP-iOS:7.17.0
    • 虎牙直播APP-安卓:7.13.3
    • 虎牙直播助手-iOS:4.8.0
    • 虎牙直播助手-安卓:4.8.0
    • 虎牙直播PC客户端-主播侧:4.18.4.0
    • 虎牙直播PC客户端-观众侧:未验证

接口签名

declare namespace hyExt { module context { /** * 监听高级用户进场 * @param params 输入参数 */ function onVipEnterBannerNotice( params: VipEnterBannerNoticePeq ): Promise<void> } /** * 监听高级用户进场参数 */ type VipEnterBannerNoticePeq = { /** * 高级用户进场信息回调 */ callback: VipEnterBannerNoticeCallback } /** * 高级用户进场信息回调 * @param notice 高级用户进场消息 */ type VipEnterBannerNoticeCallback = (notice: VipEnterBannerNotice) => void /** * 高级用户进场消息 */ type VipEnterBannerNotice = { /** * 粉丝标签名 */ badgeName: string /** * 粉丝等级 */ fansLevel: number /** * 贵族等级 */ nobleLevel: number /** * 贵族等级类型 */ nobleAttrType: number /** * 贵族名 */ nobleName: string /** * 用户unionId */ unionId: string /** * 房间Id */ roomId: number /** * 用户头像 */ userAvatarUrl: string /** * 用户昵称 */ userNick: string } }

示例代码

hyExt.context .onVipEnterBannerNotice({ callback: (notice) => { const { badgeName, fansLevel, nobleLevel, nobleAttrType, nobleName, unionId, roomId, userAvatarUrl, userNick, } = notice console.log("回调触发", notice) }, }) .then(() => { console.log("调用hyExt.context.onVipEnterBannerNotice成功") }) .catch((err) => { console.log("调用hyExt.context.onVipEnterBannerNotice失败", err) })

相关链接