Démarrer avec l'API Video de Vonage

Utilisez ce guide pour lancer rapidement votre première session vidéo Vonage - configurez votre Account et votre application, puis suivez le quickstart pour vous connecter et diffuser.

Conditions préalables

Créer un Account Vonage

S'inscrire pour un Account Vonage.

Après l'inscription, vous serez dirigé vers la page d'accueil du site web de la Commission européenne. Tableau de bord Vonage afin de créer une nouvelle application.

Créer une application

Après s'être connecté à votre Tableau de bord Vonage, créez une application pour votre projet vidéo Vonage.

  1. Dans le menu de gauche, cliquez sur Applications.
  2. A partir de la Applications page, cliquez sur Créer une nouvelle application pour créer une nouvelle application.
  3. Donnez un nom à votre projet.
  4. Cliquez sur Générer une clé publique et une clé privée. Vous générerez un fichier contenant votre clé privée. Téléchargez-le et gardez-le en sécurité, vous en aurez besoin plus tard.
  5. Faites défiler vers le bas, jusqu'à la rubrique Capacités liste. Faire basculer la Vidéo capacité sur.
  6. Cliquez sur Générer une nouvelle application bouton.

Authentification

Une fois votre application générée, vous devriez être en mesure d'afficher plusieurs informations d'identification. Pour l'instant, vous n'avez besoin que de deux d'entre elles :

  • Applications : Il s'agit d'un identifiant alphanumérique unique pour votre application vidéo.
  • Clé privée : Cette clé est utilisée pour Authentification basée sur JWT. Veillez à ce qu'il soit conservé en lieu sûr.

Vous en aurez besoin pour authentifier votre demande.

Configurer une application Vonage

Si vous créez une application vidéo à partir de zéro dans le tableau de bord, utilisez ce flux de configuration :

  1. Dans le menu de gauche, cliquez sur Applications.
  2. A partir de la Applications page, cliquez sur Créer une nouvelle application.
  3. Donnez un nom à votre projet.
  4. Cliquez sur Générer une clé publique et une clé privée et téléchargez le fichier généré private.key fichier.
  5. Dans le cadre de la Capacités section, bascule Vidéo sur.
  6. Cliquez sur Générer une nouvelle application.

Créez votre première session vidéo

Une fois les informations d'identification du tableau de bord prêtes, utilisez les SDK client et serveur pour créer une session, émettre des jetons et connecter votre application de bout en bout. Suivez cette section pour comprendre quelles informations d'identification se trouvent sur le serveur et comment le client les utilise pour publier et s'abonner.

Pour connecter votre client à sa session, vous devez :

  • ID de l'application et clé privée - généré lors de la création de l'application ; utilisé pour l'authentification basée sur JWT.
  • ID de la session - identifie la session ("salle"). Voir les guide des sessions.
  • Jeton - titre de créance de courte durée qui accorde l'accès et définit le rôle du client.

Tout d'abord, vous devez installer le SDK vidéo de votre choix dans la liste ci-dessous. Ensuite, suivez les instructions de la section Démarrage rapide pour générer l'identifiant de session et le jeton à l'aide de la fonction SDK de serveurles renvoie au client, puis initialise le client et se connecte. Voir sessions d'adhésion pour le contexte.

Installer le SDK

Choisissez le SDK qui correspond à votre plateforme client et suivez son guide d'installation :

Démarrage rapide

Suivez les étapes suivantes pour passer des informations d'identification du backend à un client qui publie et s'abonne dans une session en direct :

  1. Créer une session - créer une salle unique sur votre serveur pour que les clients puissent s'y inscrire.
  2. Générer un jeton - délivrer un titre éphémère (rôle/TTL) à chaque participant.
  3. Initialiser une session et relier - configurez le SDK avec votre ID d'application + l'ID de session, puis connectez-vous en utilisant le jeton.
  4. Publier un flux - capturer l'appareil photo/microphone et envoyer les médias à la session.
  5. S'abonner aux flux - Attachez des médias distants à votre interface utilisateur et écoutez les événements de flux.

Pas encore de backend ? Essayez le Terrain de jeu de Video API pour expérimenter des sessions.

Prochaines étapes

  • Enregistrement de vidéos: Apprenez à capturer, stocker et récupérer des sessions à l'aide de l'archivage automatique ou à la demande.
  • Verify webhooks: Sécurisez vos rappels à l'aide de signatures secrètes afin de pouvoir vous fier à chaque événement reçu par votre application.
  • Modération vidéo: Renforcez les rôles, forcez la déconnexion et mettez les participants en sourdine pour garder les sessions sous contrôle.
  • Paramètres de l'éditeur: Réglez les propriétés de la caméra, de l'audio et de la fréquence d'images pour une qualité optimale par appareil.
  • Paramètres de l'abonné: Gérez les abonnés, réagissez aux événements de flux et personnalisez l'expérience du spectateur.