hyExt.action.showEntrance
- 显示客户端小程序入口
- 入口显示的状态需要“续租”，默认租期1个小时，再次调用这个接口可“续租”，否则到期后入口会自动隐藏；
- 默认状态下观众端小程序入口的状态受这个接口控制，如果需要一直显示入口请联系小程序平台进行评估；
- 经平台评估后设置成观众端入口一直显的话，调用这个接口会抛出异常；
- 引入版本 1.4.0
- 适用终端
- 虎牙直播助手-iOS：3.14.0
- 虎牙直播助手-安卓：3.14.0
- 虎牙直播PC客户端-观众侧：4.9.0.3
接口签名
declare namespace hyExt {
module action {
/**
* 显示客户端小程序入口
* @param params 输入参数
*/
function showEntrance(params: ShowEntranceReq): Promise<void>
}
/**
* 显示客户端小程序入口参数
*/
type ShowEntranceReq = {
/**
* 要显示入口的小程序类型枚举值，以逗号分隔；取值说明:
* web_video_com 虎牙主站面板;
* app_panel 虎牙直播APP面板;
*/
extTypes: string
/**
* 倒计时，单位秒（尚未提供）
*/
countDown?: number
/**
* 角标类型（尚未提供）；取值说明: fire 火; new 新; '' 无;
*/
cornerMarkId?: "fire" | "new" | ""
}
}
示例代码
hyExt.action
.showEntrance({
extTypes: "web_video_com",
countDown: 0,
cornerMarkId: "fire",
})
.then(() => {
console.log("调用hyExt.action.showEntrance成功")
})
.catch((err) => {
console.log("调用hyExt.action.showEntrance失败", err)
})
hyExt.action
.showEntrance({ extTypes: "web_video_com,app_panel" })
.then((res) => {
console.log("调用hyExt.action.showEntrance成功", res);
})
.catch((err) => {
console.log("调用hyExt.action.showEntrance失败", err);
});
相关链接
生命周期
直播间信息
环境信息
弹幕
礼物
文本秩序审核
小程序消息
终端事件监听
KV存储
主播端白板
网络库
文件处理
外部EXE能力
浮窗
小程序付费功能
订阅
直播间分享事件
守护事件
贵族事件
高级用户进场事件
小程序入口控制
本地小程序控制
语音识别事件
手势识别事件
视觉识别事件
人体轮廓点检测事件
肢体骨骼点检测事件
人脸特征点检测事件
播放视频
直播间视频
后台相关