實作 Co-Watching API

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

建立 CoWatchingClient

首先，請透過您在開始使用期間建立的 AddonSession 建立 createCoWatchingClient。

如要建立 CoWatchingCient，請呼叫 AddonSession.createCoWatchingClient 方法並提供 CoWatchingDelegate。

CoWatchingDelegate 是 Co-Watching API 如何在新狀態可用時更新應用程式。正常情況下，呼叫 CoWatchingDelegate.onCoWatchingStateChanged 方法時，應用程式會立即套用新狀態。

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

 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 會控制更新播放位置。

您可以使用下列方法控制共同觀看狀態：

• CoWatchingClient.notifySwitchToMedia：每當目前播放的媒體變更時呼叫。例如，使用者選取新影片，或自動播放下一部影片。
• CoWatchingClient.notifyPauseState：使用者暫停或取消暫停播放的媒體時呼叫。
• CoWatchingClient.notifySeekToTimestamp：使用者明確變更播放位置時呼叫。
• CoWatchingClient.notifyPlayoutRate：在使用者將播放速度更新為新的值時呼叫 (例如 1.25x)。
• CoWatchingClient.notifyBuffering：當使用者的應用程式因先前的媒體切換、媒體跳轉或網路壅塞而開始緩衝處理時，就會呼叫此事件。
• CoWatchingClient.notifyReady：在緩衝處理完成且媒體已準備好播放時呼叫。