虎牙开放平台文档
虎牙 • 开放平台
小程序

hyExt.stream.onExtraWhiteBoardMessage

  • 监听小程序独立白板消息
  • 引入版本 1.8.0
  • 适用终端
    • 虎牙直播助手-iOS：3.14.0
    • 虎牙直播助手-安卓：3.14.0
    • 虎牙直播PC客户端-主播侧：4.13.4.0

课前准备

  • 此 SDK 仅能在独立白板环境下调用，通常结合hyExt.stream.sendToExtraWhiteBoard（发送消息到小程序独立白板） SDK 一起使用。因为独立白板数据和主播端数据是分开的，使用时需要根据hyExt.env.getInitialParam（获取初始参数）中的返回数据wb=1在白板中判断此时为独立白板环境。只有在独立白板环境下才能调用此 SDK 和发送消息到小程序独立白板，普通白板和 EXE 白板环境下无法正常调用。

接口签名

declare namespace hyExt { module stream { /** * 监听小程序独立白板消息 * @param params 输入参数 */ function onExtraWhiteBoardMessage(params: OnExtraWBMsgReq): Promise<void> } /** * 监听独立白板消息参数 */ type OnExtraWBMsgReq = { /** * 独立白板消息回调 */ callback: WhiteBoardMessageCallback } /** * 独立白板消息回调 * @param data 消息内容 */ type WhiteBoardMessageCallback = (data: string) => void }

示例代码

hyExt.stream .onExtraWhiteBoardMessage({ callback: (data) => { console.log("回调触发", data) }, }) .then(() => { console.log("调用hyExt.stream.onExtraWhiteBoardMessage成功") }) .catch((err) => { console.log("调用hyExt.stream.onExtraWhiteBoardMessage失败", err) })

相关链接

修改于 2026年04月24日 15:46