Co-Watching API implementieren

Mit der Co-Watching API lassen sich Videokonferenzen mehrerer Personen, die sich Inhalte Ihrer App ansehen oder anhören.

In diesem Leitfaden wird erläutert, wie die Co-Watching API implementiert wird.

Jetzt starten

Wenn Sie die Co-Watching API verwenden möchten, müssen Sie zuerst ein Meet-Add-on bereitstellen. Einmal Wenn du diese Schritte abgeschlossen hast, kannst du die Co-Watching API verwenden aus dem neuen Add-on aus.

Wenn du die Co-Watching API verwenden möchtest, musst du zuerst ein AddonSession-Objekt abrufen. Dieses Objekt dient als Ausgangspunkt für gemeinsame Aktivitäten in Google Meet:

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

Client für das gemeinsame Ansehen erstellen

Erstellen Sie zunächst ein CoWatchingClient von AddonSession entfernt.

Rufen Sie zum Erstellen eines CoWatchingCient die Methode createCoWatchingClient() und stellen eine CoWatchingDelegate -Objekt enthält.

Über die CoWatchingDelegate aktualisiert die Co-Watching API deine App, sobald ein neuer Status verfügbar ist. Wenn die Methode onCoWatchingStateChanged() aufgerufen wird, sollte der neue Status sofort in Ihrer App angewendet werden.

Das folgende Codebeispiel zeigt, wie die Co-Watching API verwendet wird:

 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
    },
  });

Aktuellen Status verwalten

Wenn Nutzer Aktionen in Ihrer Anwendung ausführen, wird davon ausgegangen, dass Ihre Anwendung die bereitgestellten API-Methoden sofort aufruft.

Sie sollten diese Methoden nur als Reaktion auf wichtige Ereignisse aufrufen. Für Sie müssen sie beispielsweise nicht jedes Mal aufrufen, wenn Ihre App Video. Die von dir erstellte CoWatchingDelegate sorgt in diesen Fällen dafür, dass aktualisierte Wiedergabepositionen abgerufen werden.

So kannst du den Status des gemeinsamen Ansehens steuern:

• notifyBuffering(): Wird aufgerufen, wenn die App eines Nutzers aufgrund von Puffern aus einem vorherigen Medienwechsel, einem Mediensuchvorgang oder einer Netzwerküberlastung zu puffern beginnt.

• notifyPauseState(): Wird aufgerufen, wenn ein Nutzer die Wiedergabe von Medien pausiert oder fortsetzt.

• notifyPlayoutRate(): Rufen Sie auf, wenn ein Nutzer die Wiedergabegeschwindigkeit auf einen neuen Wert ändert (z. B. 1,25x).

• notifyReady(): Wird aufgerufen, wenn die Pufferung abgeschlossen ist und die Medien jetzt wiedergegeben werden können.

• notifySeekToTimestamp(): Aufruf, wenn ein Nutzer die Wiedergabeposition explizit ändert.

• notifySwitchToMedia(): Wird aufgerufen, wenn sich die gerade abgespielten Medien ändern. Beispielsweise wählt der Nutzer ein neues Video aus oder die automatische Wiedergabe startet das nächste Video.