會議參與者可以透過 Google Meet 外掛程式活動。協作活動開始時 所有會議參與者都會收到活動通知 。
這則通知會根據外掛程式的可用性和安裝狀態進行調整:
如果參與者已安裝外掛程式:他們可以加入活動。
如果參與者沒有外掛程式 已安裝:系統會引導使用者前往 外掛程式。
如果外掛程式不適用於參與者的平台:系統會通知參與者無法使用目前的裝置加入活動。
使用者加入活動時,即可載入自己的 iframe 附加內容您可以自訂是否要允許新彙整者 應在主舞台或側邊面板中開啟協作活動。
開始活動
透過呼叫
startActivity()
方法,該方法會使用
ActivityStartingState
存取 API
步驟 1 (選用):外掛程式設定活動的起始狀態
ActivityStartingState
包含初始狀態的
參與者接受參與者接受的
邀請加入活動。
這個外掛程式可以設定或更新
ActivityStartingState
,方法是呼叫 setActivityStartingState()
方法。如果 ActivityStartingState
僅在呼叫 startActivity()
時設定,則可以省略對 setActivityStartingState()
的呼叫。
步驟 2:外掛程式啟動活動
當外掛程式在 MeetSidePanelClient
上呼叫 startActivity()
方法時,活動就會開始。startActivity()
方法會將 ActivityStartingState
物件做為
參數,因此可以呼叫 startActivity()
,而不呼叫
setActivityStartingState()
。
使用者完成內容選取作業並準備開始活動後,請在外掛程式中呼叫 startActivity()
方法,如下所示:
sidePanelClient.startActivity({
mainStageUrl: "https://app.example.com/mainstage",
additionalData: JSON.stringify({
// State to send to participants.
})
});
叫用 startActivity()
方法時,Meet 會執行
其他參與者:Meet 會顯示符合下列條件的通知: 活動進行中。
啟動者:如果在
ActivityStartingState
中指定了主畫面網址,Meet 會使用ActivityStartingState
中的網址開啟主畫面。
步驟 3:取得活動的啟動狀態
使用者加入活動時,會載入您的外掛程式
根據 ActivityStartingState
插入主要階段或側邊面板。
您可以使用 additionalData
屬性,與加入活動的使用者分享初始資料 (也稱為狀態)。初始化
MainStageClient
或SidePanelClient
,你
呼叫
getActivityStartingState()
擷取 additionalData
屬性的方法。
const startingState = client.getActivityStartingState();
const additionalData = JSON.parse(startingState.additionalData);
步驟 4 (選用):在活動中分享外掛程式狀態
您也可以在活動進行期間,在使用者之間共用狀態。您可以透過兩種方式分享狀態:
- 請自行授權同步處理後端來進行處理。
- 使用 Co-Doing API,這是在使用者之間分享任意資料的快速便捷方式。
範例:GitHub 上的動畫外掛程式
GitHub 上的 「Animation」範例外掛程式包含外掛程式中的協作功能。步驟 1
並未包含該指南所載內容。相反地
外掛程式發起者按一下
「開始動畫」按鈕
在側邊面板中,系統會呼叫 startActivity()
方法 (步驟 2)
做法是以使用者所選的顏色填入開始狀態活動啟動後,主階段會呼叫 getActivityStartingState()
方法,藉此擷取啟動狀態 (步驟 3)。省略步驟 4,因為
所選顏色) 在這個活動期間的參與者之間不會共用
此附加元件範例不過,個別使用者可以變更
這時只要選取一種顏色,就可以從側邊面板頁框傳送至
透過影格對影格訊息傳送主階段頁框。
限制
- 「
ActivityStartingState
」中指定的網址必須相同 origin 指定為 外掛程式資訊清單。若需更多資訊,請參閲 附加安全防護機制。 sidePanelUrl
屬性、mainStageUrl
屬性和additionalData
屬性的字元長度,必須符合 SDK 參考文件中公布的大小限制。