本页介绍了如何管理插件与 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()
检索。
请务必为主 Stage 检索正确的客户端对象
或侧边栏如果检索到的客户端有误,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()
方法,用于设置插件的初始状态 当参与者接受邀请加入活动时触发。 - 有关这两种客户端功能的完整列表,请参阅
MeetAddonClient
对象。
特定于客户端的功能
功能仅在
MeetMainStageClient
对象:
notifySidePanel()
方法会向侧边栏发送消息。此邮件可由 订阅frameToFrameMessage
回调。loadSidePanel()
方法会打开侧边栏 iframe。iframe 来源设置为 侧边栏网址。unloadSidePanel()
方法会关闭侧边栏 iframe。调用该方法时,Meet 中不会保留插件状态。由插件决定 插件的状态。
功能仅在
MeetSidePanelClient
对象:
notifyMainStage()
方法向 mainStage 发送一条消息。此邮件可由 订阅frameToFrameMessage
回调 属性。