Les bases de Video API

Découvrez les principes de base de la Video API Vonage et son fonctionnement.

Cette rubrique comprend les sections suivantes :

Vous cherchez du code ? Comprendre le fonctionnement de la plateforme Vonage Video API est extrêmement utile pour développer des applications utilisant l'API Vonage Video, mais si vous préférez vous plonger directement dans le code et commencer à développer avant d'apprendre les concepts fondamentaux, consultez notre Tutoriels.

La plateforme Video API de Vonage

La plateforme Vonage Video API permet d'intégrer facilement dans les applications Web et mobiles des fonctionnalités telles que la vidéo interactive en temps réel de haute qualité, la messagerie, le partage d'écran et bien plus encore. La plateforme comprend des bibliothèques client pour le Web, iOS, Android, Windows, macOS, Linux et React, ainsi que des SDK côté serveur et une API REST. La Video API Vonage utilise WebRTC pour les communications audio-vidéo.

Toutes les applications développées à l'aide de la plateforme Video API de Vonage nécessitent deux composants principaux :

  • Le client — du code côté client qui s'exécute dans un navigateur ou une application mobile, mis en place par le développeur à l'aide des bibliothèques côté client de la Video API, disponibles pour Web, iOS, Android, Fenêtres, macOS, Linuxet React Native. C'est le côté client qui gère la majeure partie des fonctionnalités de la Video API Vonage.
  • Le serveur — code côté serveur exécuté sur un serveur web configuré par le développeur à l'aide des SDK serveur de la Video API Vonage, qui sont disponibles pour Nœud, PHP, Java, .NET, Pythonet Rubis.

Fonctions du client et du serveur

Client :

Serveur d'applications :

Session :

  • « Salle de discussion » dans la Video API Vonage dans le cloud
  • Met les clients en relation les uns avec les autres
  • Envoie des événements aux clients

Sessions

Chaque conversation vidéo via la Video API Vonage s'effectue au sein d'un session. On peut considérer une session comme une « salle » où les clients peuvent interagir entre eux en temps réel. Les sessions sont hébergées sur le Video API Vonage dans le cloud et gérer les utilisateurs connexions, audio-vidéo cours d'eau, et l'utilisateur événements (comme l'arrivée d'un nouvel utilisateur). Chaque session est associée à un identifiant unique ID de la session. Pour permettre à plusieurs clients de discuter entre eux, il suffit de les faire se connecter à la même session (en utilisant le même identifiant de session).

Les serveur d'application (qui exécute le code côté serveur) est chargé de créer de nouvelles sessions et de générer des identifiants d'authentification uniques jetons pour chaque nouveau client. Le client utilise ensuite ce jeton pour établir une connexion à la session. Les clients connectés à une session peuvent publier transmet à la session et souscrire aux flux d'autres clients. Pour plus d'informations sur la manière dont les clients se connectent à une session, consultez la section suivante.

Débogage de sessions avec Inspector

Si vous souhaitez consulter les informations relatives à une session spécifique, vous pouvez utiliser Inspecteur. Cet outil fournit une analyse détaillée de la session, notamment sur les utilisateurs, la qualité, les événements, les erreurs, etc. Il s'avère utile pour le débogage et pour mieux comprendre ce qui se passe lors des sessions de votre application.

Connexion, publication et abonnement

Cette section présente une illustration détaillée des étapes à suivre pour que deux clients puissent lancer une session de chat vidéo.

Étape 1 : La session est créée par votre serveur d'applications

Votre serveur d'application, en utilisant du code provenant d'un Kit de développement logiciel (SDK) pour serveur de la Video API Vonage, crée une session dans le cloud via le API Video REST de Vonage et reçoit l'identifiant de session. Considérez la session comme une « salle » dans laquelle se déroulera le chat vidéo. À ce stade, elle est inoccupée.

Étape 2 : un client lance l'application et le serveur génère un jeton

Lorsqu'un utilisateur charge votre application côté client, développée avec un Client SDK de la Video API Vonage, le client (une page Web ou une application mobile) reçoit les informations de session du serveur. Celles-ci comprennent un identifiant d'authentification unique jeton (la « clé » du client) générée par votre serveur d'applications.

Étape 3 : Le client se connecte et commence à diffuser en continu vers la session

Le client utilise l'identifiant de session et le jeton pour établir une connexion avec la session. Le client peut alors publier un système audiovisuel flux à la session et prêter attention aux informations importantes événements (par exemple, lorsqu'un nouvel utilisateur rejoint la session). À ce stade, le client est le seul participant à la session.

Étape 4 : Un nouveau client se connecte à la session

Lorsqu'un nouvel utilisateur charge l'application côté client dans une page Web distincte ou sur un appareil mobile (Client 2), ce nouveau client reçoit l'identifiant de session et un jeton unique de la part de votre serveur d'applications. Le client utilise ces informations pour établir une connexion à la session.

Étape 5 : Les clients s'abonnent aux flux les uns des autres

Maintenant qu'il est connecté à la session, le client 2 peut s'abonner au flux du client 1. Le client 2 publie ensuite son propre flux vidéo vers la session, et le client 1 s'y abonne. Les deux clients sont désormais abonnés au flux de l'autre dans le cadre d'un chat vidéo en tête-à-tête, et tous deux « guettent » les nouveaux événements (tels qu'un nouvel utilisateur se connectant à la session).

La Video API Vonage prend en charge les communications en tête-à-tête et les communications de groupe. Plusieurs clients peuvent se connecter à une session et chaque client connecté peut s'abonner à chaque flux de la session. Outre les fonctionnalités de base mentionnées ci-dessus, la plateforme Video API Vonage offre toute une gamme de fonctionnalités supplémentaires telles que partage d'écran, archivage, chat textuel, diffusion, et bien d'autres encore. Pour découvrir l'ensemble complet des fonctionnalités proposées, consultez la guides destinés aux développeurs.

Création d'une application utilisant la Video API Vonage

Après avoir pris connaissance des documents ci-dessus, vous devriez avoir acquis une compréhension de base du fonctionnement de la Video API. Si vous êtes prêt à commencer à développer votre première application, consultez le tutoriel « Basic Client » pour le Web, iOS, Android, Windows ou Linux :

Consulter les tutoriels de base sur le client

Vous trouverez également ci-dessous une liste des termes clés et de leurs définitions, ainsi qu'une liste d'autres Ressources du Centre des développeurs.

Termes clés

Session

On peut considérer une session comme une « pièce » où clients peuvent interagir entre elles en temps réel — chacune étant associée à un identifiant de session unique. Les nouvelles sessions sont générées par votre serveur d'application via le SDK serveur. Les clients peuvent obtenir l'identifiant de session et un identifiant d'authentification unique jeton du serveur vers initialiser la session et s'y connecter, après quoi ils pourront publier cours d'eau et souscrire aux flux de la session, ainsi que pour détecter événements généré par la session (par exemple, la connexion d'un nouvel utilisateur).

Consultez notre guides destinés aux développeurs pour apprendre à créer une session avec les SDK du serveur, rejoindre une session avec le SDK clients, et découvrez d'autres fonctionnalités liées aux sessions. Pour plus d'informations sur les classes, méthodes et événements spécifiques associés aux sessions, consultez notre documentation de référence sur l'API pour Web, iOS, Android, Fenêtreset Linux.

Jeton

Un jeton est une « clé » d'authentification unique qui permet à un client pour rejoindre un session. Lorsqu'un client tente de se connecter à une session, votre serveur d'application génère un jeton unique et l'envoie au client avec l'identifiant de session. Les jetons ont une date d'expiration (définie par le serveur), tandis que les sessions n'expirent jamais. Il est également possible d'attribuer des rôles aux jetons — éditeur, abonné, ou modérateur, qui déterminent les autorisations du client, telles que la publication cours d'eau et s'abonner aux flux au cours de la session.

Consultez notre guides destinés aux développeurs pour apprendre à Créer un jeton avec le SDK serveur et rejoindre une session avec le SDK clients. Lorsque vous créez une démo ou une preuve de concept, vous pouvez générer des jetons via votre Video API Vonage Account en créant un projet, en accédant à la vue d'ensemble du projet, puis en faisant défiler la page jusqu'aux outils du projet ; toutefois, un composant serveur doit être configuré avant la mise en production.

Client

Un client désigne tout navigateur ou toute application mobile utilisant le code côté client de la Video API de Vonage. SDK clients. Le client est l'un des deux composants clés qui constituent une application utilisant la Video API Vonage (l'autre étant le serveur), et prend en charge la plupart des fonctionnalités de la Video API Vonage, telles que se connecter à une session, l'édition et souscrire à cours d'eau, à l'écoute de la session événements, et la transmission d'événements à la session.

Avant de pouvoir interagir avec une session, le client doit recevoir l'identifiant de session et jeton générées par votre serveur d'applications. Consultez notre Tutoriel de base sur le client pour découvrir comment mettre en œuvre des fonctionnalités côté client, ainsi que notre guides destinés aux développeurs pour plus d'informations.

Serveur

Le serveur d'applications, configuré par le développeur d'applications à l'aide du SDK pour serveurs de la Video API Vonage, génère de nouveaux sessions et jetons, qu'il transmet ensuite à la client. Toutes les applications utilisant la Video API Vonage nécessitent à la fois un composant client et un composant serveur. Consultez notre guides destinés aux développeurs pour apprendre à créer une session et Créer un jeton avec les SDK du serveur, ainsi que d'autres fonctionnalités gérées par le serveur.

Connexion

A client interagit avec le session via une connexion d'événements (ou de signalisation) persistante, qui utilise les WebSockets pour rester constamment à l'écoute de nouveaux événements envoyée par la session. Cette connexion est différente de la ou des connexions multimédia WebRTC établies lorsque les clients publier et souscrire à cours d'eau au cours de la séance.

Pour établir une connexion à une session, le client doit recevoir un identifiant de session et jeton de votre serveur d'application, qui sont ensuite utilisés pour l'authentification. Chaque client établit généralement une seule connexion à une session donnée, et chaque connexion d'un client à cette session est associée à un identifiant de connexion unique. Consultez notre guides destinés aux développeurs pour apprendre à se connecter à une session avec le SDK clients.

Flux

Un flux est un signal audio-vidéo unique qui comprend les flux de la caméra et du microphone publiés par un utilisateur. Pendant une session, clients publier transmet à la session et souscrire vers les flux d'autres clients. Lorsqu'un nouveau flux est créé, un événement est diffusé à la fois par le Objet « Éditeur » et Objet de session.

Publier

Autrefois, un client est connecté à un session, il peut diffuser un contenu audio-vidéo flux à la session à l'aide de la webcam et du microphone de l'appareil. Le client jeton fonction (éditeur, abonné, modérateur) détermine si ce client est autorisé à publier dans la session. Cela permet d'avoir des sessions comptant seulement un ou deux éditeurs, mais de nombreux abonnés (relation « un à plusieurs »). Consultez notre guides destinés aux développeurs pour apprendre à diffuser un flux à une séance avec le SDK clients.

S'abonner

Autrefois, un client est connecté à un session, il peut s'abonner à n'importe quel contenu audio-vidéo cours d'eau publié par d'autres clients participant à la séance. Découvrez notre guides destinés aux développeurs pour apprendre à s'abonner aux flux lors d'une séance avec le SDK clients.

Evénements

Autrefois, un client établit un connexion à un session, il est capable de détecter les événements déclenchés par la session. Ces événements sont déclenchés pour diverses raisons, par exemple lors de la création d’un nouveau flux ou lorsqu’un nouveau client se connecte ou se déconnecte de la session. Si vous souhaitez qu’un client réagisse à un événement particulier, vous devez configurer un écouteur d’événements. Pour plus d’informations sur les différents événements pouvant survenir au cours d’une session et sur la manière de les gérer, consultez la Client SDK documentation de référence pour web (JavaScript), iOS, Android, Fenêtreset Linux.

Client SDK

Les SDK client constituent un ensemble de bibliothèques de code disponibles pour web (JavaScript), iOS, Android, Fenêtreset Linux, utilisé pour configurer le client. Le code côté client gère la plupart des fonctionnalités de la Video API Vonage, notamment l'édition et souscrire à cours d'eau dans la session et à l'écoute de la session événements.

SDK serveur

Les SDK serveur constituent un ensemble d'enveloppes pour le API Video REST de Vonage disponible pour Nœud, PHP, Java, .NET, Pythonet Rubis. Ce code est configuré sur votre serveur d'application et sert à générer de nouveaux sessions et jetons pour les client.

API Video REST de Vonage

L'API REST Vonage Video est une interface HTTP permettant d'accéder à la Video API Vonage Cloud utilisé pour créer sessions et prendre en charge des fonctionnalités avancées telles que archivage et diffusion. La Video API de Vonage SDK serveur mettre en œuvre bon nombre des méthodes de l'API REST. Consultez la Documentation de référence de l'API REST pour découvrir les différentes méthodes existantes.

Video API Vonage Cloud — gère sessions, client connexions, appels API, signalisation, événements, et à peu près tout ce qui n'est pas pris en charge par le SDK clients ou SDK serveur.

Ressources du Centre des développeurs

L'article que vous êtes en train de lire, ainsi que l'ensemble de la documentation relative à la Video API de Vonage, fait partie de la Centre de développement de la Video API Vonage. Le Centre des développeurs a pour objectif de fournir tout ce dont un développeur a besoin pour créer et gérer avec succès une application utilisant la Video API de Vonage.

Voici quelques-unes des ressources disponibles dans le Centre des développeurs :

Bonjour tout le monde — une brève démonstration des fonctionnalités les plus élémentaires de la Video API Vonage

Tutoriels — des guides détaillés, étape par étape, sur la création d'une application utilisant la Video API Vonage et l'ajout de fonctionnalités avancées

Échantillons de code — une liste de dépôts GitHub contenant des exemples d'applications pour vous aider à développer plus rapidement

Intégration de chats vidéo — le moyen le plus rapide d'intégrer les fonctionnalités de la Video API Vonage à votre site web avec un minimum de code

Guides du développeur — une documentation complète sur toutes les fonctionnalités de la Video API Vonage

Référence du Client SDK pour Web, iOS, Android, Fenêtres, Linux — des informations sur les classes, méthodes et événements spécifiques utilisés par les SDK clients

Documentation de référence de l'API REST — un guide d'utilisation de l'API REST Vonage Video et des SDK serveur

Outils du développeur — des outils utiles pour le débogage des sessions, le test des appels d'API, et bien plus encore

Programmes bêta — une page répertoriant toutes les versions bêta publiques de la Video API de Vonage et expliquant comment y participer

Obtenir de l'aide

Si vous avez une question ou rencontrez des difficultés et que vous ne trouvez pas la réponse dans le Centre des développeurs, vous pouvez Consultez notre centre d'assistance pour contacter notre service d'assistance ou consulter la foire aux questions.