使用 Meet 插件开展协作

会议参与者可以协同处理 Google Meet 插件活动。协作活动开始后，会议中的所有参与者都会收到活动正在进行的通知。

此通知会根据插件是否可用以及安装状态进行调整：

  • 如果参与者已安装该插件： 他们可以加入活动。

  • 如果参与者未安装该插件：系统会引导他们安装该插件。

  • 如果插件不适用于参与者的平台：系统会告知他们无法使用当前设备加入活动。

当用户加入 activity 时，他们会加载自己的 iframe 并添加您的插件内容。您可以自定义新加入者应在主舞台还是侧边栏中打开协作活动。

启动 activity

通过调用 startActivity() 方法启动 activity，该方法使用 ActivityStartingState 接口。

第 1 步（可选）：插件设置 activity 启动状态

ActivityStartingState 包含有关插件初始状态的信息，该信息在参与者接受加入活动的邀请时使用。

该插件可以在 activity 之前或期间的任何时间调用 setActivityStartingState() 方法来设置或更新 ActivityStartingState。如果 ActivityStartingState 仅在对 startActivity() 的调用中设置，则可以省略对 setActivityStartingState() 的调用。

第 2 步：插件启动 activity

当插件调用 MeetSidePanelClient 上的 startActivity() 方法时，该 activity 会开始。startActivity() 方法接受 ActivityStartingState 对象作为参数，因此可以调用 startActivity()，而无需调用 setActivityStartingState()。

当用户完成内容选择并准备启动 activity 后，请在您的插件中调用 startActivity() 方法，如下所示：

    sidePanelClient.startActivity({
        mainStageUrl: "https://app.example.com/mainstage",
        additionalData: JSON.stringify({
            // State to send to participants.
        })
    });

调用 startActivity() 方法时，Meet 会执行以下操作：

  • 对于其他参与者：Meet 会显示活动正在进行的通知。

  • 对于发起者：如果在 ActivityStartingState 中指定了主舞台网址，Meet 会使用 ActivityStartingState 中的网址打开主舞台。

第 3 步：获取 activity 的启动状态

当用户加入 activity 时，他们会将您的插件加载到主舞台或侧边栏中，具体取决于 ActivityStartingState。

借助 additionalData 属性，您可以与加入 activity 的用户共享初始数据（也称为状态）。初始化 MainStageClient 或 SidePanelClient 后，您可以调用 getActivityStartingState() 方法来检索 additionalData 属性。

const startingState = client.getActivityStartingState();
const additionalData = JSON.parse(startingState.additionalData);

第 4 步（可选）：在 activity 中共享插件状态

您还可以在 activity 运行期间在用户之间共享状态。您可以通过以下两种方式共享状态：

  • 自行编写同步后端来处理。
  • 使用 Co-Doing API，以便在用户之间快速便捷地共享任意数据。

示例：GitHub 上的动画插件

GitHub 上的“Animation”示例插件包含插件协作功能。此示例不包含本指南中的第 1 步。而是，当插件启动器点击侧边栏中的“开始动画”按钮时，系统会通过使用用户选择的颜色填充起始状态来调用 startActivity() 方法（第 2 步）。activity 启动后，主舞台会通过调用 getActivityStartingState() 方法检索开始状态（第 3 步）。此示例插件中的 activity 期间，参与者之间不会共享状态（所选颜色），因此省略了第 4 步。不过，个别用户可以通过选择颜色来更改自己的状态，系统会使用帧到帧消息传递将颜色从侧边栏帧发送到主舞台帧。

限制条件