實作 Co-Watching API

Co-Watching API 可用來管理 經常觀看或聆聽您應用程式內容的使用者

本指南說明如何實作 Co-Watching API。

開始使用

如要使用 Co-Watching API，您必須先建構 Meet 外掛程式。一次 完成這些步驟後，即可開始使用 Co-Watching API 開啟新的外掛程式

如要使用 Co-Watching API，請先取得 AddonSession 物件， 這會做為 Google Meet 共同活動的進入點：

TypeScript

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

將 CLOUD_PROJECT_NUMBER 替換為 Google Cloud 專案的專案編號。

建立共視用戶端

首先，請建立 CoWatchingClient敬上 物件，AddonSession。

如要建立 CoWatchingCient，請呼叫 createCoWatchingClient() 方法，並提供 CoWatchingDelegate 物件。

CoWatchingDelegate 是 Co-Watching API 更新應用程式的方式 新的狀態預期在呼叫 onCoWatchingStateChanged() 方法時，應用程式會立即套用新狀態。

以下程式碼範例說明如何使用 Co-Watching API：

TypeScript

 const coWatchingClient = await addonSession.createCoWatchingClient({
    activityTitle: "ACTIVITY_TITLE",
    onCoWatchingStateQuery() {
      // This function should return the current state of your CoWatching activity
      return getMyApplicationCoWatchingState();
    },
    onCoWatchingStateChanged(coWatchingState: CoWatchingState) {
      // This function should apply newState to your ongoing CoWatching activity
    },
  });

將 ACTIVITY_TITLE 替換成您活動的媒體標題。

管理目前狀態

當使用者在您的應用程式中採取行動時，應用程式應該也會 會立即呼叫所提供的 API 方法。

您只能在回應重大事件時呼叫這些方法。適用對象 因此，您不需要在每次應用程式進入 影片。您建立的 CoWatchingDelegate 帳號代碼將更新播放進度 在這些情況下，您都能讓 Google 顯示相關協助

你可以使用下列方法控制共視狀態：

  • notifyBuffering(): 當使用者的應用程式因先前媒體進行緩衝處理而開始緩衝處理時呼叫 切換、媒體尋找或網路壅塞。

  • notifyPauseState(): 使用者暫停或取消暫停播放的媒體時呼叫。

  • notifyPlayoutRate(): 在使用者將播放速度更新為新的值時呼叫 (例如， 1.25 倍)。

  • notifyReady()：當緩衝完成且媒體已準備好播放時呼叫。

  • notifySeekToTimestamp(): 使用者明確變更播放位置時呼叫。

  • notifySwitchToMedia(): 每當目前播放的媒體變更時呼叫。舉例來說，使用者 選取新影片，或自動播放下一部影片