Co-Watching API implementieren

Mit der Co-Watching API wird die Besprechungserfahrung mehrerer Teilnehmer verwaltet, die sich Inhalte in Ihrer App ansehen oder anhören.

In dieser Anleitung wird erläutert, wie Sie die Co-Watching API implementieren.

Jetzt starten

Damit Sie die Co-Watching API verwenden können, müssen Sie zuerst ein Meet-Add-on bereitstellen. Nachdem Sie diese Schritte ausgeführt haben, können Sie die Co-Watching API in Ihrem neuen Add-on verwenden.

Um die Co-Watching API zu verwenden, rufen Sie zuerst ein AddonSession Objekt ab, das als Einstiegspunkt für gemeinsame Aktivitäten in Google Meet dient:

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

Co-Watching-Client erstellen

Erstellen Sie zuerst ein CoWatchingClient Objekt aus Ihrer AddonSession.

Rufen Sie dazu die createCoWatchingClient() Methode auf und geben Sie ein CoWatchingDelegate Objekt an.CoWatchingCient

Über CoWatchingDelegate wird Ihre App von der Co-Watching API aktualisiert, wenn ein neuer Status verfügbar ist. Wenn die onCoWatchingStateChanged() Methode aufgerufen wird, sollte Ihre App den neuen Status sofort anwenden.

Das folgende Codebeispiel zeigt, wie Sie die Co-Watching API verwenden:

 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 in Ihrer Anwendung Aktionen ausführen, sollte Ihre Anwendung die bereitgestellten API-Methoden sofort aufrufen.

Sie sollten diese Methoden nur als Reaktion auf wichtige Ereignisse aufrufen. Sie müssen sie beispielsweise nicht jedes Mal aufrufen, wenn Ihre App ein Video abspielt. Der von Ihnen erstellte CoWatchingDelegate ruft in diesen Fällen aktualisierte Wiedergabepositionen ab.

Mit diesen Methoden können Sie den Co-Watching-Status steuern:

• notifyBuffering(): Rufen Sie diese Methode auf, wenn die App eines Nutzers aufgrund von Pufferung durch einen vorherigen Medienwechsel, eine Mediensuche oder eine Netzwerküberlastung mit dem Puffern beginnt.

• notifyPauseState(): Rufen Sie diese Methode auf, wenn ein Nutzer die Wiedergabe des aktuellen Mediums pausiert oder fortsetzt.

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

• notifyReady(): Rufen Sie diese Methode auf, wenn die Pufferung abgeschlossen ist und das Medium jetzt wiedergegeben werden kann.

• notifySeekToTimestamp(): Rufen Sie diese Methode auf, wenn ein Nutzer die Wiedergabeposition explizit ändert.

• notifySwitchToMedia(): Rufen Sie diese Methode auf, wenn sich das aktuell wiedergegebene Medium ändert. Beispielsweise wählt der Nutzer ein neues Video aus oder die automatische Wiedergabe startet das nächste Video.