虎牙开放平台文档

hyExt.context.getVip

  • 获取直播间所有贵宾信息
  • 引入版本 1.2.0
  • 适用终端
    • 虎牙直播主站
    • 虎牙直播APP-iOS:7.9.3
    • 虎牙直播APP-安卓:7.13.3
    • 虎牙直播助手-iOS:4.5.0
    • 虎牙直播助手-安卓:4.5.2
    • 虎牙直播PC客户端-主播侧:4.16.1.0
    • 虎牙直播PC客户端-观众侧:4.12.2.0

接口签名

declare namespace hyExt { module context { /** * 获取直播间所有贵宾信息 */ function getVip(): Promise<VipItem[]> } /** * Vip信息 */ type VipItem = { /** * 用户昵称 */ userNick: string /** * 用户头像地址 */ userAvatarUrl: string /** * 贵族等级 */ nobleLevel: number /** * 贵族名称 */ nobleName: string } }

示例代码

hyExt.context .getVip() .then((res) => { res.map((vipitem) => { const { userNick, userAvatarUrl, nobleLevel, nobleName } = vipitem }) console.log("调用hyExt.context.getVip成功", res) }) .catch((err) => { console.log("调用hyExt.context.getVip失败", err) })