Co-Watching API implementieren

Early Access-Programm: Diese Funktion war nur in folgenden Ländern verfügbar: eingeschränkte Vorschau durch ein Early Access-Programm. Für dieses Programm können keine weiteren Anmeldungen mehr vorgenommen werden.

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.

Erste Schritte

Um die Co-Watching API zu verwenden, musst du zuerst eine Meet-Add-on. Einmal Wenn du diese Schritte abgeschlossen hast, kannst du die Co-Watching API verwenden aus dem neuen Add-on aus.

Um die Co-Watching API zu verwenden, musst du zuerst eine AddonSession, die dient als Einstiegspunkt für gemeinsame Aktivitäten:

TypeScript

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

CoWatchingClient erstellen

Erstellen Sie zunächst ein createCoWatchingClient von deinem AddonSession.

Rufen Sie zum Erstellen eines CoWatchingCient die Methode AddonSession.createCoWatchingClient und stellen eine CoWatchingDelegate

Mit dem CoWatchingDelegate aktualisiert die Co-Watching API dein wenn ein neuer Status verfügbar ist. Es ist zu erwarten, dass der CoWatchingDelegate.onCoWatchingStateChanged aufgerufen wird, wendet Ihre Anwendung sofort den neuen Status an.

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

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

Ersetzen Sie ACTIVITY_TITLE durch den Medientitel Ihrer Aktivität.

Aktuellen Status verwalten

Wenn Nutzer in Ihrer App Aktionen durchführen, wird erwartet, dass Ihre App ruft die bereitgestellten API-Methoden sofort auf.

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. Der CoWatchingDelegate, den du oben erstellt hast, wird aktualisiert Playout-Positionen unter diesen Umständen.

Mit den folgenden Methoden kannst du den Status der gemeinsamen Wiedergabe steuern:

• CoWatchingClient.notifySwitchToMedia: Rufen Sie immer dann auf, wenn sich die aktiv wiedergegebenen Medien ändern. Beispiel: Die Nutzenden ein neues Video auswählt oder bei der automatischen Wiedergabe das nächste Video gestartet wird.
• CoWatchingClient.notifyPauseState: Rufen Sie auf, wenn ein Nutzer die Wiedergabe der Medien pausiert oder die Pausierung wieder aufhebt.
• CoWatchingClient.notifySeekToTimestamp: Aufruf, wenn ein Nutzer die Wiedergabeposition explizit ändert.
• CoWatchingClient.notifyPlayoutRate: Rufen Sie auf, wenn ein Nutzer die Wiedergabegeschwindigkeit auf einen neuen Wert ändert (z. B. 1,25x).
• CoWatchingClient.notifyBuffering: Aufruf, wenn die App eines Nutzers aufgrund eines vorigen Mediums mit dem Zwischenspeichern beginnt Wechsel, Mediensuche oder Netzwerküberlastung.
• CoWatchingClient.notifyReady: Rufen Sie auf, wenn die Pufferung abgeschlossen ist und die Medien nun abgespielt werden können.