管理客户端对象

本页介绍了如何管理插件与 Google Meet 通信所需的客户端对象。

首先，该插件需要建立会话：

  const session = await window.meet.addon.createAddonSession({
      cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
    });

将 CLOUD_PROJECT_NUMBER 替换为您的 Google Cloud 项目的项目编号。

在该会话中，可以创建两个客户端对象：

请务必为主舞台或侧边栏检索正确的客户端对象。如果检索到的客户端有误，Google Meet 插件 SDK 会抛出异常。如需检查插件是在哪个 iframe（主舞台或侧边栏）中运行，请使用 getFrameType() 方法。

以下代码示例展示了如何实例化主舞台客户端对象：

  const session = await window.meet.addon.createAddonSession({
      cloudProjectNumber: "CLOUD_PROJECT_NUMBER"
    });
  const mainStageClient = await session.createMainStageClient();

将 CLOUD_PROJECT_NUMBER 替换为您的 Cloud 项目编号。

共享的功能

有些功能同时适用于 MeetMainStageClient 和 MeetSidePanelClient 对象，而其他功能则仅适用于特定客户端。

例如，这两款客户端都提供以下一些功能：

  • getActivityStartingState() 方法，用于在参与者接受加入活动的邀请时获取有关插件初始状态的信息。
  • getMeetingInfo() 方法，用于获取正在运行该插件集的会议的详细信息。
  • setActivityStartingState() 方法，用于在参与者接受加入 activity 的邀请时设置插件的初始状态。
  • 如需查看这两款客户端的功能的完整列表，请参阅 MeetAddonClient 对象。

客户专用功能

仅在 MeetMainStageClient 对象中提供的功能：

  • notifySidePanel() 方法会向侧边栏发送消息。您可以通过订阅侧边栏中的 frameToFrameMessage 回调来接收该消息。

  • loadSidePanel() 方法会打开侧边栏 iframe。iframe 来源设置为清单文件中的侧边栏网址。

  • unloadSidePanel() 方法会关闭侧边栏 iframe。调用该方法时，Meet 中不会保留插件状态。在调用此方法之前，插件可以自行保留任何插件状态。

仅在 MeetSidePanelClient 对象中提供的功能：