使用逐帧消息传递

本页介绍了如何在客户端上将消息从在侧边栏 iframe 中运行的插件发送到在主舞台 iframe 中运行的插件。帧到帧消息传递仅在客户端进行，因此消息传递几乎是即时的。

如需发送邮件，请按以下步骤操作：

• 从侧边栏切换到主舞台时，请使用 notifyMainStage() 方法。

    await sidePanelClient.notifyMainStage("YOUR_MESSAGE");

• 从主舞台切换到侧边栏，请使用 notifySidePanel() 方法。

    await mainStageClient.notifySidePanel("YOUR_MESSAGE");

payload 的长度必须符合其指定的大小限制。

如需接收消息，该插件必须订阅 frameToFrameMessage 回调。以下代码示例展示了如何订阅 frameToFrameMessage 回调：

sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
    // YOUR_CODE
});

GitHub 上的“Animation”示例插件包含一个帧到帧消息传递的完整示例。activity 启动后，侧边栏会在用户每次更改输入时通知主舞台。主舞台还订阅 frameToFrameMessage 回调，以接收更新后的状态。

备注

• 给定参与者发送的帧到帧消息仅对该参与者可见。如需向其他参与者发送消息或状态，请了解如何分享插件状态。

• 系统只会尝试一次递送消息。如需接收消息，接收面板必须处于打开状态，并且应用必须在消息发送之前订阅回调。

相关主题

• 实现 Co-Doing API