Ü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 an der Aktivität teilnimmt, werden seine eigenen iFrames mit Ihren Add-on-Inhalten geladen. Sie können festlegen, ob neue Teilnehmer die kollaborative Aktivität auf der Hauptbühne 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

Das ActivityStartingState enthält Informationen zum ursprünglichen Status des Add-ons, der verwendet wird, 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. Anrufe an setActivityStartingState() können ausgelassen 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 Auswahl der Inhalte 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 im ActivityStartingState eine URL für die Hauptbühne angegeben wurde, wird die Hauptbühne in Meet über die URL aus dem ActivityStartingState geöffnet.

Schritt 3: Startstatus der Aktivität abrufen

Wenn ein Nutzer an der Aktivität teilnimmt, wird Ihr Add‑on je nach ActivityStartingState in den Hauptbereich oder die Seitenleiste geladen.

Mit der Property additionalData können Sie Startdaten (auch als Status bezeichnet) für Nutzer freigeben, die an der Aktivität teilnehmen. Nachdem Sie ein 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

Sie können auch den Status zwischen Nutzern teilen, während die Aktivität läuft. Es gibt zwei Möglichkeiten, den Status freizugeben:

  • Sie können das Problem selbst beheben, indem Sie ein eigenes Synchronisierungs-Backend erstellen.
  • Verwenden Sie die Co-Doing API, mit der sich beliebige Daten bequem und schnell zwischen Nutzern teilen lassen.

Beispiel: Animations-Add-on auf GitHub

Das Beispiel-Add-on „Animation“ auf GitHub enthält eine Funktion für die Zusammenarbeit in einem Add-on. Schritt 1 aus dieser Anleitung ist nicht im Beispiel enthalten. Stattdessen wird die Methode startActivity() (Schritt 2) aufgerufen, wenn der Add-on-Initiator in der Seitenleiste auf die Schaltfläche Animation starten klickt. Dabei wird der Startstatus 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 ausgelassen, da der Status (die ausgewählte Farbe) in diesem Beispiel-Add‑on während der Aktivität nicht für die Teilnehmer freigegeben wird. Einzelne Nutzer können ihren eigenen Status jedoch ändern, indem sie eine Farbe auswählen. Diese wird dann über Frame-to-Frame-Messaging vom Seitenleisten-Frame an den Hauptbühnen-Frame gesendet.

Einschränkungen

  • Die in 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.