Anpassen des Videolayouts für zusammengestellte Archive

Sie können die Vonage Video REST API verwenden, um das Layout der Videos in einem Archiv anzupassen.

Diese Funktion gilt für zusammengesetzte Archive, nicht für einzelne Archive. Allgemeine Informationen zu Archiven finden Sie in der Archivierung Leitfaden.

Übersicht

Standardmäßig ordnen Archive Videos aus der Sitzung in einem Kachel-Layout an. Im Folgenden wird beispielsweise das Layout für 1, 2, 4 oder 5 Streams in einer Sitzung dargestellt:

Vonage video API default layout 1 Vonage video API default layout 2 Vonage video API default layout 4 Vonage video API default layout 5

Dies ist bekannt als die "Beste Passform" Layout. Alternativ können Sie auch aus einer Reihe anderer vordefinierter Layouts wählen.

Für die anderen Layouts weisen Sie jedem Vonage Video-Stream einen Klassennamen zu, um festzulegen, wie er im Layout erscheinen soll. (Siehe Vordefinierte Layout-Typen.)

Sie können auch Ihre eigenen benutzerdefinierten Layouts mit CSS definieren. Siehe Definieren benutzerdefinierter Layouts.

Standardmäßig ist das zusammengesetzte Archiv 640x480 Pixel (SD-Querformat, Seitenverhältnis 4:3). Einzelne Vonage-Videos werden in Container-Rechtecken innerhalb des aufgezeichneten Videos angeordnet.

Wenn das Seitenverhältnis des Videos eines einzelnen Streams nicht mit dem des Containers übereinstimmt (z. B. wenn es sich um ein HD-Video oder ein Video zur Bildschirmfreigabe handelt), wird es im Letterbox-Verfahren an den Container angepasst. Die folgende Abbildung zeigt zum Beispiel ein Best-Fit-Layout mit zwei SD-Videos im Querformat (4:3) (1 und 4) und zwei HD-Videos im Querformat (16:9) (2 und 3):

Vonage Video API layout aspect ratios

Sie können ein zusammengesetztes Archiv auch so einstellen, dass es eine 480x640 (SD-Hochformat, Seitenverhältnis 3:4), 1280x720 (HD-Querformat, Seitenverhältnis 16:9), 720x1280 (HD-Hochformat, Seitenverhältnis 9:16), 1920x1080 (FHD-Querformat, Seitenverhältnis 16:9), oder 1080x1920 (FHD-Hochformat, Seitenverhältnis 9:16), wenn Sie die Funktion Archiv starten Methode der Vonage Video REST API. Sie können ein Hochformat verwenden, wenn Sie Archive aufzeichnen, die Videostreams von mobilen Geräten enthalten (die häufig das Hochformat verwenden).

Um diese Funktion zu nutzen:

Sie können auch Ihre eigenen benutzerdefinierte Layouts.

Festlegen des anfänglichen Layouttyps

Wenn Sie die Archivierung einer Sitzung über die Vonage Video REST API starten, können Sie optional den anfänglichen Archiv-Layout-Typ angeben.

Setzen Sie die Anforderungs-URL für die POST-Anforderung wie folgt:

/v2/project/{appId}/archive

Setzen Sie die Content-Type zu application/json und setzen Sie die layout type als eine Eigenschaft der in der POST-Anforderung gesendeten JSON-Daten:

{
  "sessionId": "2_MX44NTQ1MTF--bm1kTGQ0RjVHeGNQZE51VG5scGNzdVl0flB-",
  "layout": {
    "type": "pip"
  },
  "name" : "archive_name",
  "outputMode" : "composed"
}

Wenn Sie ein benutzerdefiniertes Layout verwenden - siehe Definieren benutzerdefinierter Layouts - setzen die type Eigenschaft zu custom und geben Sie das Stylesheet als zusätzliche Eigenschaft an - stylesheet:

{
  "sessionId": "2_MX44NTQ1MTF--bm1kTGQ0RjVHeGNQZE51VG5scGNzdVl0flB-",
  "layout": {
    "type": "custom",
    "stylesheet": "stream.instructor {position: absolute; width: 100%;  height:50%;}"
  },
  "name" : "archive_name",
  "outputMode" : "composed"
}

Sie können auch einen Layouttyp angeben, der verwendet werden soll, wenn ein Screen-Sharing-Stream in der Sitzung vorhanden ist, indem Sie die Option screenshareType Eigenschaft der layout Eigentum - siehe Layouts für die Bildschirmfreigabe:

{
  "sessionId": "2_MX44NTQ1MTF--bm1kTGQ0RjVHeGNQZE51VG5scGNzdVl0flB-",
  "layout": {
    "type": "bestFit",
    "screenshareType": "pip"
  },
  "name" : "archive_name",
  "outputMode" : "composed"
}

Authentifizierung des REST-Aufrufs mit einem JWT-Token. siehe Vonage Video REST API-Authentifizierung:

Authorization: Basic base64(APP_ID:API_SECRET)

Wenn Sie einen ungültigen Typ angeben, gibt die Anfrage einen 400-Fehler-Antwortcode zurück.

Sie können auch den anfänglichen Layouttyp beim Starten einer Aufzeichnung mit der Funktion Server-SDKs:

Wenn Sie keinen anfänglichen Layout-Typ angeben, verwendet das zusammengestellte Archiv den Layout-Typ Best Fit.

Wenn Sie einen anderen Layouttyp angeben, müssen Sie die entsprechenden Layoutklassen für Streams in der Vonage Video-Sitzung anwenden.

Siehe Zuweisung von Layout-Klassen zu Vonage Video-Streams und Vordefinierte Layout-Typen.

Dynamische Änderung des Layouttyps bei der Archivierung

Sie können den Layouttyp dynamisch ändern, indem Sie die Funktion /archive/layout REST-API.

Stellen Sie eine PUT-Anfrage an die folgende URL:

/v2/project/{appId}/archive/{archiveId}/layout

Setzen Sie die Content-Type zu application/json und beinhalten das Layout type als eine Eigenschaft der JSON-Daten in der PUT-Anfrage:

{
  "type": "pip"
}

Wenn Sie eine benutzerdefiniertes Layout setzen die type Eigenschaft zu custom und geben Sie das Stylesheet als zusätzliche Eigenschaft an - stylesheet:

{
  "type": "custom",
  "stylesheet": "stream.instructor {position: absolute;  width: 100%;  height:50%;}"
}