Die Co-Watching API verwaltet die Meeting-Erfahrung mehrerer Teilnehmer, die sich Inhalte in Ihrer App ansehen oder anhören.
In diesem Leitfaden wird beschrieben, wie Sie die Co-Watching API implementieren.
Jetzt starten
Wenn Sie die Co-Watching API verwenden möchten, müssen Sie zuerst ein Meet-Add-on bereitstellen. Sobald Sie diese Schritte abgeschlossen haben, können Sie die Co-Watching API in Ihrem neuen Add-on verwenden.
Wenn Sie die API zum gemeinsamen Ansehen von Videos verwenden möchten, müssen Sie zuerst ein AddonSession-Objekt abrufen, das als Einstiegspunkt für gemeinsame Aktivitäten in Google Meet dient:
TypeScript
const session = await window.meet.addon.createAddonSession({ cloudProjectNumber: "CLOUD_PROJECT_NUMBER", }); Ersetzen Sie CLOUD_PROJECT_NUMBER durch die Projektnummer Ihres Google Cloud-Projekts.
Client für gemeinsames Ansehen erstellen
Erstellen Sie zuerst ein CoWatchingClient-Objekt aus Ihrem AddonSession.
Rufen Sie zum Erstellen eines CoWatchingCient die Methode createCoWatchingClient() auf und geben Sie ein CoWatchingDelegate-Objekt an.
Über die CoWatchingDelegate wird Ihre App von der Co-Watching API aktualisiert, sobald ein neuer Status verfügbar ist. Wenn die Methode onCoWatchingStateChanged() aufgerufen wird, sollte Ihre App den neuen Status sofort anwenden.
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 Anwendung Aktionen ausführen, wird erwartet, 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 Ihre App ein Video abspielt. Die von Ihnen erstellte CoWatchingDelegate sorgt dafür, dass in diesen Fällen aktualisierte Wiedergabepositionen abgerufen werden.
Mit diesen Methoden kannst du den Co-Watching-Status steuern:
notifyBuffering(): Wird aufgerufen, wenn die App eines Nutzers aufgrund von Pufferung durch einen vorherigen Media-Switch, Media-Seek oder Netzwerküberlastung mit dem Puffern beginnt.notifyPauseState(): Wird aufgerufen, wenn ein Nutzer die Wiedergabe von Media pausiert oder die Pausierung aufhebt.notifyPlayoutRate(): Wird aufgerufen, wenn ein Nutzer die Wiedergabegeschwindigkeit auf einen neuen Wert (z. B. 1,25-fach) ändert.notifyReady(): Wird aufgerufen, wenn das Puffern abgeschlossen ist und die Medien jetzt abgespielt werden können.notifySeekToTimestamp(): Wird aufgerufen, wenn ein Nutzer die Wiedergabeposition explizit ändert.notifySwitchToMedia(): Wird aufgerufen, wenn sich die aktuell wiedergegebenen Media ändern. Das kann beispielsweise passieren, wenn der Nutzer ein neues Video auswählt oder das nächste Video automatisch abgespielt wird.