Co-Watching API implementieren

Die Co-Watching API verwaltet die Videokonferenz, wenn mehrere Teilnehmer Inhalte Ihrer App ansehen oder anhören.

In diesem Leitfaden wird beschrieben, wie du die Co-Watching API implementierst.

Jetzt starten

Wenn Sie die Co-Watching API verwenden möchten, müssen Sie zuerst ein Meet-Add-on bereitstellen. Nachdem du diese Schritte ausgeführt hast, kannst du die Co-Watching API in deinem neuen Add-on verwenden.

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

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

Co-Watching-Client erstellen

Erstellen Sie zuerst ein CoWatchingClient-Objekt aus Ihrem AddonSession.

Rufen Sie die Methode createCoWatchingClient() auf und geben Sie ein CoWatchingDelegate-Objekt an, um ein CoWatchingCient zu erstellen.

Ü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. Sie müssen sie beispielsweise nicht jedes Mal aufrufen, wenn in Ihrer App ein Video wiedergegeben wird. 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(): Wird aufgerufen, wenn ein Nutzer die Wiedergabegeschwindigkeit auf einen neuen Wert aktualisiert, z. B. 1,25-fach.

• 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 wiedergegebenen Medien ändern. Beispielsweise wählt der Nutzer ein neues Video aus oder die automatische Wiedergabe startet das nächste Video.