虎牙开放平台文档

虎牙开放平台文档

hyExt.context.leadGift

引导当前观众送礼
一般需要和监听当前用户送礼的消息配合使用
引入版本 1.1.0
适用终端
虎牙直播主站
虎牙直播APP-iOS：7.9.3
虎牙直播APP-安卓：7.9.4
虎牙直播PC客户端-观众侧：4.12.2.0

接口签名

declare namespace hyExt {
  module context {
    /**
     * 引导当前观众送礼
     */
    function leadGift(): Promise<void>
  }
}

示例代码

hyExt.context
  .leadGift()
  .then(() => {
    console.log("调用hyExt.context.leadGift成功")
  })
  .catch((err) => {
    console.log("调用hyExt.context.leadGift失败", err)
  })

相关链接

礼物

生命周期
- hyExt.onEnterForeground
- hyExt.onLeaveForeground
- hyExt.onAppear
- hyExt.onDisappear
直播间信息
- hyExt.context.getStreamerInfo
- hyExt.context.getLiveInfo
- hyExt.context.getUserInfo
环境信息
- hyExt.env.getInitialParam
- hyExt.env.getExtInfo
- hyExt.env.getHostInfo
- hyExt.env.getPerformaceData
弹幕
- hyExt.context.leadBarrage
- hyExt.context.onBarrageChange
- hyExt.context.offBarrageChange
礼物
- hyExt.context.getGiftConf
- hyExt.context.sendGift
- hyExt.context.leadGift
- hyExt.context.onGiftChange
- hyExt.context.offGiftChange
文本秩序审核
- hyExt.order.reportText
小程序消息
- hyExt.observer.on
- hyExt.observer.off
- hyExt.observer.emit
终端事件监听
- hyExt.context.on
- hyExt.context.off
KV存储
- hyExt.storage.getItem
- hyExt.storage.setItem
- hyExt.storage.removeItem
- hyExt.storage.getKeys
主播端白板
- hyExt.stream.sendToExtraWhiteBoard
- hyExt.stream.getStreamResolution
- hyExt.stream.onExtraWhiteBoardMessage
- hyExt.stream.createWB
- hyExt.stream.deleteWB
- hyExt.stream.onWBLayoutChange
- hyExt.stream.updateWB
网络库
- hyExt.request
文件处理
- hyExt.fs.uploadImg
- hyExt.fs.uploadFile
- hyExt.fs.downloadBatchRes
- hyExt.fs.removeRes
- hyExt.fs.isResExists
外部EXE能力
- hyExt.exe.initGameEnv
- hyExt.exe.launchGame
- hyExt.exe.shutdownGame
- hyExt.exe.sendToGame
- hyExt.exe.onGameMessage
- hyExt.exe.offGameMessage
浮窗
- hyExt.context.onLayoutChange
- hyExt.panel.setLayout
小程序付费功能
- hyExt.revenue.checkStreamerCanUseGoods
- hyExt.revenue.endModuleGiftRevenueStat
- hyExt.revenue.startModuleGiftRevenueStat
- hyExt.revenue.checkStreamerGoodsExpire
- hyExt.revenue.popupGoodsBuyPanel
订阅
- hyExt.context.leadSubscribe
- hyExt.context.getSubscribeInfo
- hyExt.context.getSubscriberSummary
- hyExt.context.onSubscriberChange
- hyExt.context.offSubscriberChange
直播间分享事件
- hyExt.context.onShareLiveNotice
- hyExt.context.offShareLiveNotice
守护事件
- hyExt.context.onOpenGuardianNotice
- hyExt.context.offOpenGuardianNotice
贵族事件
- hyExt.context.onOpenNobleNotice
- hyExt.context.offOpenNobleNotice
高级用户进场事件
- hyExt.context.onVipEnterBannerNotice
- hyExt.context.offVipEnterBannerNotice
小程序入口控制
- hyExt.action.showEntrance
- hyExt.action.hideEntrance
本地小程序控制
- hyExt.action.localControlEntrance
- hyExt.action.localControlPanelLoad
- hyExt.action.localControlPanelVisible
语音识别事件
- hyExt.reg.onSpeechRecognition
- hyExt.reg.offSpeechRecognition
手势识别事件
- hyExt.reg.onGestureRecognition
- hyExt.reg.offGestureRecognition
视觉识别事件
- hyExt.reg.onCVRecognition
- hyExt.reg.offCVRecognition
人体轮廓点检测事件
- hyExt.reg.onHumanContourDetection
- hyExt.reg.offHumanContourDetection
肢体骨骼点检测事件
- hyExt.reg.onHumanSkeletonDetection
- hyExt.reg.offHumanSkeletonDetection
人脸特征点检测事件
- hyExt.reg.onFacialLandmarkDetection
- hyExt.reg.offFacialLandmarkDetection
播放视频
- hyExt.player.getVideoInfo
- hyExt.player.playVideo
- hyExt.player.pauseVideo
- hyExt.player.resumeVideo
- hyExt.player.resumeLive
直播间视频
- hyExt.player.getFrameData
- hyExt.player.switchLine
- hyExt.player.getLinesInfo
- hyExt.player.getCurrentLine
- hyExt.player.getVideoPosition
- hyExt.player.getVideoState
- hyExt.player.getLayoutInfo
- hyExt.player.mutePlay
- hyExt.player.unmutePlay
后台相关
- hyExt.backend.commonQuery
- hyExt.backend.commonOperate