Über ein Meet-Add-on zusammenarbeiten

Teilnehmer einer Videokonferenz können gemeinsam an einer Google Meet-Add-on-Aktivität arbeiten. Wenn eine gemeinsame Aktivität beginnt, 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: Der Teilnehmer wird darüber informiert, dass er mit seinem aktuellen Gerät nicht an der Aktivität teilnehmen kann.

Wenn ein Nutzer der Aktivität beitritt, werden seine eigenen iFrames mit den Inhalten Ihres Add-ons geladen. Sie können festlegen, ob neue Teilnehmer die gemeinsame Aktivität im Hauptbereich oder in der Seitenleiste ö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 Anfangszustand des Add-ons, der verwendet wird, wenn der Teilnehmer die Einladung zur Teilnahme an der Aktivität annimmt.

Das Add-on kann den ActivityStartingState jederzeit vor oder während der Aktivität festlegen oder aktualisieren, indem es die Methode setActivityStartingState() 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() für MeetSidePanelClient aufruft. Die Methode startActivity() verwendet ein ActivityStartingState-Objekt als Parameter. Daher kann startActivity() anstelle von setActivityStartingState() aufgerufen werden.

Sobald der Nutzer die Inhaltsauswahl abgeschlossen hat und bereit ist, eine Aktivität zu starten, rufen Sie die Methode startActivity() in Ihrem 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 URL für die Hauptbühne angegeben wurde, öffnet Meet die Hauptbühne mit der URL aus der ActivityStartingState.

Schritt 3: Startstatus der Aktivität abrufen

Wenn ein Nutzer der Aktivität beitritt, wird Ihr Add-on je nach ActivityStartingState im Hauptbereich oder in der Seitenleiste geladen.

Mit dem Attribut additionalData können Sie erste Daten (auch als Status bezeichnet) mit Nutzern teilen, die an der Aktivität teilnehmen. Nachdem Sie MainStageClient oder SidePanelClient initialisiert haben, können Sie 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

Du kannst auch den Status zwischen Nutzern teilen, während die Aktivität läuft, indem du ein eigenes Synchronisierungs-Backend erstellst.

Beispiel: Animations-Add-on auf GitHub

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

Einschränkungen

  • Die in der ActivityStartingState angegebenen URLs müssen zum selben Ursprung gehören wie die im Add-on-Manifest angegebenen Ursprünge. Weitere Informationen finden Sie unter Add-on-Sicherheit.
  • Die Zeichenlängen der Attribute sidePanelUrl, mainStageUrl und additionalData müssen den jeweiligen Größenbeschränkungen entsprechen, die in der SDK-Referenzdokumentation veröffentlicht sind.