虎牙开放平台文档

hyExt.action.localControlPanelVisible

  • 本地控制小程序面板可见
  • 仅适用于面板类型的小程序
  • 引入版本 1.13.0
  • 适用终端
    • 虎牙直播主站
    • 虎牙直播APP-iOS:8.1.0
    • 虎牙直播APP-安卓:8.1.0
    • 虎牙直播助手-iOS:4.11.0
    • 虎牙直播助手-安卓:4.9.0
    • 虎牙直播PC客户端-主播侧:未实现
    • 虎牙直播PC客户端-观众侧:未实现

接口签名

declare namespace hyExt { module action { /** * 本地控制小程序面板可见 * @param params 输入参数 */ function localControlPanelVisible(params: PanelVisibleReq): Promise<any> } /** * 本地控制小程序面板可见参数 */ type PanelVisibleReq = { /** * 小程序类型 */ extType: ExtPanelTypes /** * 是否可见 */ visible: boolean /** * 自定义参数 */ param?: Object } /** * 小程序面板类型;取值说明: * web_video_com 虎牙主站面板; * app_panel 虎牙直播APP面板; * zs_anchor_panel 虎牙助手面板; * pc_anchor_panel PC主播端面板; * pc_panel PC观众端面板; */ type ExtPanelTypes = | "web_video_com" | "app_panel" | "zs_anchor_panel" | "pc_anchor_panel" | "pc_panel" }

示例代码

hyExt.action .localControlPanelVisible({ extType: "web_video_com", visible: true, param: {}, }) .then((res) => { console.log("调用hyExt.action.localControlPanelVisible成功", res) }) .catch((err) => { console.log("调用hyExt.action.localControlPanelVisible失败", err) })

注意事项

  • 在安卓端调用时,需要保证主播处于开端状态(是否开播可通过获取当前直播间信息SDK 获取的isOn属性进行判断)。

相关链接