虎牙开放平台文档

hyExt.context.getLiveInfo

获取当前直播间信息
引入版本 1.2.0
适用终端
虎牙直播主站
虎牙直播APP-iOS：7.11.2
虎牙直播APP-安卓：7.13.3
虎牙直播助手-iOS：3.14.0
虎牙直播助手-安卓：3.13.15
虎牙直播PC客户端-主播侧：4.9.0.3
虎牙直播PC客户端-观众侧：4.13.1.0

接口签名

declare namespace hyExt {
  module context {
    /**
     * 获取当前直播间信息
     */
    function getLiveInfo(): Promise<LiveInfoRsp>
  }

  /**
   * 直播间信息
   */
  type LiveInfoRsp = {
    /**
     * 品类，如果isOn为false，则为上次开播的品类
     */
    gameName: string
    /**
     * 人气，如果isOn为false，则为上次开播的人气
     */
    liveCount: number
    /**
     * 直播间介绍，如果isOn为false，则为上次开播的直播间介绍
     */
    roomTitle: string
    /**
     * 开播时间戳（秒)，如果isOn为false，则为上次开播的时间戳
     */
    startTime: number
    /**
     * 是否在播
     */
    isOn: boolean
    /**
     * 品类id，如果isOn为false，则为上次开播的品类id
     */
    gameId: number
    /**
     * 直播间中是否有视频，如果isOn为false，则返回false
     */
    hasVideo: boolean
    /**
     * 直播间模版；取值说明:
     * MobileLiveRoom     颜值;
     * FMLiveRoom         多人语音;
     * MatchLiveRoom      赛事;
     * TVLiveRoom         虎牙电视台;
     * GameRoom           游戏;
     * ImmerseRoom        沉浸式;
     * MultiLinkVideoRoom 派对;
     */
    template: string
    /**
     * 直播间来源
     */
    sourceType: number
    /**
     * 沉浸式直播间；取值说明: 1 为沉浸式直播间; 0 为非沉浸式直播间;
     */
    liveImmersion: number
    /**
     * 交友陪玩直播间；取值说明: 1 为交友陪玩直播间; 0 为非交友陪玩直播间;
     */
    liveCompany: number
    /**
     * 开播模式；取值说明:
     * kGame          【PC主播端】端游直播;
     * kEntertainment 【PC主播端】娱乐直播;
     * kMobile        【PC主播端】手游直播;
     * kMakeFriends   【PC主播端】交友直播;
     * kThirdParty    【PC主播端】第三方推流;
     * kScreenCAP     【助手APP】录屏直播;
     * kCamera        【助手APP】摄像头直播;
     * kVoice         【助手APP】语音直播;
     */
    liveMode: string
    /**
     * 开播子模式；取值说明:
     * process           【PC主播端】端游直播-捕捉游戏画面;
     * desktop           【PC主播端】端游直播-全屏捕捉;
     * area              【PC主播端】端游直播-截取屏幕;
     * window            【PC主播端】端游直播-窗口捕捉;
     * adr               【PC主播端】手游直播-安卓手机;
     * ios               【PC主播端】手游直播-苹果手机;
     * audio             【PC主播端】交友直播-语音开播;
     * video             【PC主播端】交友直播-视频开播;
     * multiPlayersVideo 【PC主播端】派对模式;
     */
    liveSubMode: string
    /**
     * 直播ID
     */
    liveId: string
  }
}

示例代码

hyExt.context
  .getLiveInfo()
  .then((res) => {
    const {
      gameName,
      liveCount,
      roomTitle,
      startTime,
      isOn,
      gameId,
      hasVideo,
      template,
      sourceType,
      liveImmersion,
      liveCompany,
      liveMode,
      liveSubMode,
      liveId,
    } = res
    console.log("调用hyExt.context.getLiveInfo成功", res)
  })
  .catch((err) => {
    console.log("调用hyExt.context.getLiveInfo失败", err)
  })

hyExt.context.getLiveInfo

接口签名

示例代码

相关链接