本頁面說明如何取得外掛程式與 Google Meet 通訊所需的用戶端物件。
首先,外掛程式需要建立工作階段:
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
在這個工作階段中,您可建立兩個用戶端物件:
針對在主階段中執行的外掛程式,可使用的
MeetMainStageClient
,可使用await session.createMainStageClient()
擷取。針對在側邊面板中執行的外掛程式,可使用的
MeetSidePanelClient
,可使用await session.createSidePanelClient()
擷取。
請務必擷取主要階段或側邊面板的正確用戶端物件。如果擷取到錯誤的用戶端,Google Meet 外掛程式 SDK 會擲回例外狀況。如要查看執行外掛程式所在的 iframe (主要階段或側邊面板),請使用 MeetAddon.getFrameType
方法。
以下程式碼範例顯示如何將主要階段用戶端物件執行個體化:
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
const mainStageClient = await session.createMainStageClient();
共用功能
MeetMainStageClient
和 MeetSidePanelClient
皆提供部分功能,有些功能則專屬於特定用戶端。
舉例來說,這兩個用戶端都提供的部分功能包括:
MeetAddonClient.getCollaborationStartingState
方法會在參與者接受邀請進行協作時取得外掛程式的初始狀態相關資訊。MeetAddonClient.getMeetingInfo
方法可取得執行外掛程式的會議相關詳細資料。MeetAddonClient.getMeetPlatformInfo
方法可取得執行外掛程式的會議平台相關詳細資料。MeetAddonClient.setCollaborationStartingState
,用於在參與者接受協同合作時設定外掛程式的初始狀態。- 如需兩個用戶端功能的完整清單,請參閱
MeetAddonClient
物件。
用戶端專屬功能
只有在 MeetMainStageClient
才能使用的功能:
MeetMainStageClient.notifySidePanel
會將訊息傳送至側邊面板。您可以訂閱側邊面板中的 frameToFrameMessage 回呼來接收訊息。MeetMainStageClient.loadSidePanel
方法會開啟側邊面板 iframe。iframe 來源會設為資訊清單檔案的側邊面板網址。MeetMainStageClient.unloadSidePanel
方法會關閉側邊面板 iframe。呼叫此方法後,Meet 不會保留外掛程式狀態。外掛程式可在呼叫此方法前,保留所有外掛程式狀態。
只有在 MeetSidePanelClient
才能使用的功能:
MeetSidePanelClient.notifyMainStage
會將訊息傳送至主要階段。只要訂閱主要階段中的 frameToFrameMessage 回呼,即可接收這則訊息。