SDK
虎牙小程序平台提供了跨平台的JS SDK供业务调用终端/平台的能力，如：
global.hyExt.context.getUserInfo().then(console.log).catch(console.warn)
按功能划分，SDK提供的能力大概分成以下几个部分：
生命周期
| 名称 | 功能说明 |
|---|---|
| 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 | 发送HTTP请求 |
文件处理
| 名称 | 功能说明 |
|---|---|
| hyExt.fs.uploadImg | 上传图片 |
| hyExt.fs.uploadFile | 通用上传文件 |
| hyExt.fs.downloadBatchRes | 批量下载资源 |
| hyExt.fs.removeRes | 删除资源 |
| hyExt.fs.isResExists | 判断资源是否存在 |
外部EXE能力
| 名称 | 功能说明 |
|---|---|
| hyExt.exe.initGameEnv | 初始化Game环境 |
| hyExt.exe.launchGame | 启动Game |
| hyExt.exe.shutdownGame | 停止Game |
| hyExt.exe.sendToGame | 发送消息至Game |
| 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 | 弹出商品购买的H5面板 |
订阅
| 名称 | 功能说明 |
|---|---|
| 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 | 通用上行接口 |
生命周期
直播间信息
环境信息
弹幕
礼物
文本秩序审核
小程序消息
终端事件监听
KV存储
主播端白板
网络库
文件处理
外部EXE能力
浮窗
小程序付费功能
订阅
直播间分享事件
守护事件
贵族事件
高级用户进场事件
小程序入口控制
本地小程序控制
语音识别事件
手势识别事件
视觉识别事件
人体轮廓点检测事件
肢体骨骼点检测事件
人脸特征点检测事件
播放视频
直播间视频
后台相关