Über ein Meet-Add-on zusammenarbeiten

Teilnehmer einer Videokonferenz können gemeinsam an einer Google Meet-Add-on-Aktivität arbeiten. Wenn eine Gruppenaktivität gestartet wird, erhalten alle Teilnehmer der Videokonferenz eine Benachrichtigung, dass die Aktivität läuft.

Diese Benachrichtigung wird an die Verfügbarkeit und den Installationsstatus des Add-ons angepasst:

  • Wenn der Teilnehmer das Add-on installiert hat: Er kann an der Aktivität teilnehmen.

  • Wenn der Teilnehmer das Add-on nicht installiert hat: Er wird aufgefordert, das Add-on zu installieren.

  • Wenn das Add-on für die Plattform des Teilnehmers nicht verfügbar ist: Er wird darüber informiert, dass er mit seinem aktuellen Gerät nicht an der Aktivität teilnehmen kann.

Wenn ein Nutzer an der Aktivität teilnimmt, lädt er seine eigenen Iframes mit Ihren Add-on-Inhalten. Sie können festlegen, ob neue Teilnehmer die kollaborative Aktivität im Hauptbereich oder im Seitenbereich öffnen sollen.

Aktivität starten

Eine Aktivität wird durch Aufrufen der Methode startActivity() gestartet, die die Schnittstelle ActivityStartingState verwendet.

Schritt 1 (optional): Das Add-on legt den Startstatus der Aktivität fest

ActivityStartingState enthält Informationen zum ursprünglichen Status des Add-ons, die verwendet werden, wenn der Teilnehmer die Einladung zur Teilnahme an der Aktivität annimmt.

Das Add-on kann die ActivityStartingState festlegen oder aktualisieren, indem es die Methode setActivityStartingState() jederzeit vor oder während der Aktivität aufruft. Aufrufe von setActivityStartingState() können weggelassen werden, wenn ActivityStartingState ausschließlich im Aufruf von startActivity() festgelegt ist.

Schritt 2: Das Add-on startet die Aktivität

Die Aktivität beginnt, wenn das Add-on die Methode startActivity() auf dem MeetSidePanelClient aufruft. Die Methode startActivity() nimmt ein ActivityStartingState-Objekt als Parameter entgegen. Daher kann startActivity() anstelle von setActivityStartingState() aufgerufen werden.

Sobald der Nutzer die Inhaltsauswahl abgeschlossen hat und eine Aktivität starten möchte, rufe die Methode startActivity() in deinem Add-on so auf:

    sidePanelClient.startActivity({
        mainStageUrl: "https://app.example.com/mainstage",
        additionalData: JSON.stringify({
            // State to send to participants.
        })
    });

Wenn die Methode startActivity() aufgerufen wird, führt Meet die folgenden Aktionen aus:

  • Für andere Teilnehmer: In Meet wird eine Benachrichtigung angezeigt, dass die Aktivität läuft.

  • Für den Initiator: Wenn in der ActivityStartingState eine Hauptbühne-URL angegeben wurde, wird die Hauptbühne in Meet mit der URL aus der ActivityStartingState geöffnet.

Schritt 3: Startstatus der Aktivität abrufen

Wenn ein Nutzer an der Aktivität teilnimmt, lädt er Ihr Add-on je nach ActivityStartingState in den Hauptbereich oder in den Seitenbereich.

Mit der Property additionalData können Sie Startdaten (auch als Status bezeichnet) für Nutzer freigeben, die an der Aktivität teilnehmen. Nachdem du MainStageClient oder SidePanelClient initialisiert hast, kannst du die Methode getActivityStartingState() aufrufen, um das Attribut additionalData abzurufen.

const startingState = client.getActivityStartingState();
const additionalData = JSON.parse(startingState.additionalData);

Schritt 4 (optional): Add-on-Status in einer Aktivität teilen

Sie können den Status auch für andere Nutzer freigeben, während die Aktivität läuft. Sie haben zwei Möglichkeiten, den Status zu teilen:

  • Sie können die Synchronisierung selbst übernehmen, indem Sie ein eigenes Synchronisierungs-Backend erstellen.
  • Verwenden Sie die Co-Doing API, um beliebige Daten schnell und einfach zwischen Nutzern zu teilen.

Beispiel: Animations-Add-on auf GitHub

Das Beispiel-Add-on „Animation“ auf GitHub enthält die Funktion „Mit anderen zusammenarbeiten“ in einem Add-on. Schritt 1 aus dieser Anleitung ist in der Beispieldatei nicht enthalten. Stattdessen wird die Methode startActivity() aufgerufen (Schritt 2), wenn der Initiator des Add-ons im Seitenpanel auf die Schaltfläche Animation starten klickt. Dabei wird der Startstatus mit der vom Nutzer ausgewählten Farbe ausgefüllt. Nach dem Start der Aktivität ruft die Hauptphase den Startstatus ab, indem sie die Methode getActivityStartingState() aufruft (Schritt 3). Schritt 4 wird übersprungen, da der Status (die ausgewählte Farbe) in diesem Beispiel-Add-on während der Aktivität nicht zwischen den Teilnehmern geteilt wird. Einzelne Nutzer können ihren eigenen Status jedoch ändern, indem sie eine Farbe auswählen, die über Frame-to-Frame-Messaging vom Seitenleisten-Frame an den Frame der Hauptbühne gesendet wird.

Einschränkungen