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

hyExt.stream.updateWB

  • 更新白板
  • 引入版本 1.10.0
  • 适用终端
    • 虎牙直播助手-iOS：4.9.0
    • 虎牙直播助手-安卓：4.9.0
    • 虎牙直播PC客户端-主播侧：4.16.1.0

课前准备

本文将会展示更新白板sdk的基本使用，为了能够更好地理解本文，阅读前请确保充分理解了主播端白板中的相关概念。

下图展示了更新白板时的传参相对于推流出去视频区位置的关系。你可以在理解此图示的基础上，再结合在项目中调整不同传参值来观察每次创建的白板大小位置变化，从而更好的理解每个参数的实际意义。

updateWB.png

其中：

  • wbId：白板id，必传值。每次创建白板时小程序会自动设置一个wbId，同时开发者也需要手动设置下述的wbName标识。一个wbId只能有一个相对应的wbName，而同一个wbName可作为多次创建的不同白板wbId的标识。

  • wbName：业务传入的白板标识，必传值；需要修改的白板标识必须要与创建白板时设置的业务标识保持一致。

接口签名

declare namespace hyExt { module stream { /** * 更新白板 * @param params 输入参数 */ function updateWB(params: UpdateWBReq): Promise<void> } /** * 更新白板参数 */ type UpdateWBReq = { /** * 白板id */ wbId: string /** * 业务传入的白板标识 */ wbName: string /** * 相对推流出去的界面左侧的偏移量(单位是像素) */ offsetX: number /** * 相对推流出去的界面顶部的偏移量(单位是像素) */ offsetY: number /** * 推流出去的界面里白板图层占的宽度(单位是像素) */ canvasWidth: number /** * 推流出去的界面里白板图层占的高度(单位是像素) */ canvasHeight: number } }

示例代码

hyExt.stream .updateWB({ wbId: "wbId", wbName: "wbName", offsetX: 1, offsetY: 1, canvasWidth: 1, canvasHeight: 1, }) .then(() => { console.log("调用hyExt.stream.updateWB成功") }) .catch((err) => { console.log("调用hyExt.stream.updateWB失败", err) })

相关链接

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