本页介绍了如何管理插件需要与 Google Meet 通信的客户端对象。
首先,插件需要建立会话:
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
将 CLOUD_PROJECT_NUMBER 替换为您的 Google Cloud 项目的项目编号。
从会话中,可以创建两个客户端对象:
在主阶段中运行的插件的
MeetMainStageClient
,可使用await session.createMainStageClient()
进行检索。在侧边栏中运行的插件的
MeetSidePanelClient
,可使用await session.createSidePanelClient()
进行检索。
务必检索主舞台或侧边栏的正确客户端对象。如果检索到错误的客户端,Google Meet Add-ons 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()
方法,当参与者接受加入活动的邀请时调用。 - 如需查看这两个客户端中的功能列表,请参阅
MeetAddonClient
对象。
特定于客户的功能
仅在 MeetMainStageClient
对象中提供的功能:
notifySidePanel()
方法用于向侧边栏发送消息。通过订阅侧边栏中的frameToFrameMessage
回调,可以接收该消息。loadSidePanel()
方法会打开侧边栏 iframe。iframe 来源设置为清单文件中的边栏网址。unloadSidePanel()
方法会关闭侧边栏 iframe。调用该方法时,插件状态不会保留在 Meet 中。插件需要在调用此方法之前保留任何插件状态。
仅在 MeetSidePanelClient
对象中提供的功能:
notifyMainStage()
方法向 mainStage 发送消息。通过订阅主舞台中的frameToFrameMessage
回调属性,可以接收该消息。