虎牙开放平台文档

hyExt.exe.onGameMessage

  • 监听消息信息
  • 引入版本 3.11.2
  • 适用终端
    • 虎牙直播助手-iOS:未实现
    • 虎牙直播助手-安卓:未实现
    • 虎牙直播PC客户端-主播侧:5.12.23.0

接口签名

declare namespace hyExt { module exe { /** * 监听消息信息 * @param params 参数 */ function onGameMessage(params: ExeOnGameMessageReq): Promise<void> } /** * 监听消息信息参数 */ type ExeOnGameMessageReq = { /** * 监听相关消息回调 */ callback: ExeOnGameMessageCallback } /** * 监听相关消息回调 * @param params 回调消息 */ type ExeOnGameMessageCallback = ( params: ExeOnGameMessageCallbackParams ) => void /** * 回调消息 */ type ExeOnGameMessageCallbackParams = { /** * 消息名称 */ name: string /** * 消息内容 */ message: string } }

示例代码

hyExt.exe .onGameMessage({ callback: (params) => { const { name, message } = params console.log("回调触发", params) }, }) .then(() => { console.log("调用hyExt.exe.onGameMessage成功") }) .catch((err) => { console.log("调用hyExt.exe.onGameMessage失败", err) })