Personnalisation de la présentation vidéo pour les archives composées

Vous pouvez utiliser l'API Video REST de Vonage pour personnaliser la présentation des vidéos dans une archive.

Cette fonctionnalité s'applique aux archives composées et non aux archives individuelles. Pour des informations générales sur les archives, voir la page Archivage guide.

Vue d'ensemble

Par défaut, les archives présentent les vidéos de la session sous forme de mosaïque. Par exemple, le schéma suivant illustre la disposition lorsqu'il y a 1, 2, 4 ou 5 flux dans une session :

C'est ce que l'on appelle le "la meilleure solution" la mise en page. Vous pouvez également choisir parmi un certain nombre d'autres modèles prédéfinis.

Pour les autres dispositions, vous attribuez un nom de classe à chaque flux vidéo Vonage afin de déterminer comment il apparaîtra dans la disposition. (Voir Types de mise en page prédéfinis.)

Vous pouvez également définir vos propres mises en page personnalisées à l'aide de CSS. Voir Définir des mises en page personnalisées.

Par défaut, l'archive composée est 640x480 pixels (paysage SD, format 4:3). Les vidéos individuelles de Vonage sont disposées dans des rectangles de conteneurs à l'intérieur de la vidéo enregistrée.

Si le format de la vidéo d'un flux individuel ne correspond pas à celui du conteneur (par exemple, s'il s'agit d'une vidéo HD ou d'une vidéo de partage d'écran), elle est mise en boîte aux lettres pour s'adapter au conteneur. Par exemple, l'illustration suivante montre une disposition optimale avec deux vidéos SD paysage (4:3) (1 et 4) et deux vidéos HD paysage (16:9) (2 et 3) :

Vous pouvez également faire en sorte qu'une archive composée utilise un 480x640 (portrait SD, format 3:4), 1280x720 (paysage HD, format 16:9), 720x1280 (portrait HD, format 9:16), 1920x1080 (paysage FHD, format 16:9), ou 1080x1920 (portrait FHD, rapport d'aspect 9:16) lorsque vous appelez la fonction démarrer l'archive de l'API Video REST de Vonage. Il se peut que vous souhaitiez utiliser un format portrait lors de l'enregistrement d'archives comprenant des flux vidéo provenant d'appareils mobiles (qui utilisent souvent le format portrait).

Pour utiliser cette fonction :

Spécifiez le type de mise en page pour l'archive composée - voir Spécification du type de mise en page initiale et Changement dynamique du type de mise en page pendant l'enregistrement de la session.
Attribuer des classes de mise en page aux flux vidéo de Vonage.

Vous pouvez également définir vos propres mises en page personnalisées.

Spécification du type de mise en page initiale

Lorsque vous démarrez l'archivage d'une session, à l'aide de l'API Video REST de Vonage, vous pouvez, en option, spécifier le type de mise en page initiale de l'archive.

Définissez l'URL de la requête POST comme suit :

/v2/project/{appId}/archive

Régler le Content-Type à application/json et définir le layout type en tant que propriété des données JSON envoyées dans la requête POST :

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

Si vous utilisez une mise en page personnalisée - voir Définir des mises en page personnalisées - fixer le type à la propriété custom et transmettre la feuille de style en tant que propriété supplémentaire - stylesheet:

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

Vous pouvez également spécifier un type de mise en page à utiliser lorsqu'il y a un flux de partage d'écran dans la session en définissant le paramètre screenshareType de la propriété layout propriété - voir les schémas de partage d'écran:

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

Authentifier l'appel REST à l'aide d'un jeton JWT. voir Authentification de l'API Video REST de Vonage:

Authorization: Basic base64(APP_ID:API_SECRET)

La demande renvoie un code d'erreur 400 si vous spécifiez un type non valide.

Vous pouvez également spécifier le type de mise en page initiale lors du démarrage d'un enregistrement à l'aide de la fonction SDK serveur:

Si vous ne spécifiez pas de type de mise en page initiale, l'archive composée utilise le type de mise en page Best Fit.

Si vous spécifiez un autre type de mise en page, veillez à appliquer les classes de mise en page appropriées pour les flux de la session Vonage Video.

Voir Attribution de classes de mise en page aux flux vidéo de Vonage et Types de mise en page prédéfinis.

Changement dynamique du type de mise en page pendant l'archivage

Vous pouvez modifier dynamiquement le type de présentation en appelant la fonction /archive/layout API REST.

Envoyez une requête PUT à l'URL suivante :

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

Régler le Content-Type à application/json et inclure la mise en page type en tant que propriété des données JSON dans la requête PUT :

{
  "type": "pip"
}

Si vous utilisez un mise en page personnalisée fixer le type à la propriété custom et transmettre la feuille de style en tant que propriété supplémentaire - stylesheet:

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