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

hyExt.stream.sendToExtraWhiteBoard

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

课前准备

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

接口签名

declare namespace hyExt { module stream { /** * 发送消息到小程序独立白板 * @param params 输入参数 */ function sendToExtraWhiteBoard(params: SendToWhiteBoardReq): Promise<void> } /** * 发送到白板的消息 */ type SendToWhiteBoardReq = { /** * 独立白板的Id */ wbId: string /** * 要发送的消息 */ data?: string } }

其中：

wbId：白板 id，必传值。每次创建白板时小程序会自动设置一个wbId，这个wbId将作为发送消息对象的唯一标识。

data：要发送的消息，可选值。注意，调用 SDK 向独立白板发送消息前，开发者需要对发送到消息进行文本秩序审核。一个是通过调用hyExt.order.reportText SDK 进行发起审核，另一个是调用hyExt.observer.emit SDK 给观众端小程序广播信息，从而触发小程序消息内部文本审核机制。只有通过文本秩序审核的消息才允许正常向观众端展示。

示例代码

hyExt.stream .sendToExtraWhiteBoard({ wbId: "wbId", data: "", }) .then(() => { console.log("调用hyExt.stream.sendToExtraWhiteBoard成功") }) .catch((err) => { console.log("调用hyExt.stream.sendToExtraWhiteBoard失败", err) })

相关链接

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