Client SDK
Le Client SDK pour la création d'applications basées sur le Web qui utilisent l'API Video de Vonage est le suivant OpenTok.js. Cette bibliothèque JavaScript fournit la plupart des fonctionnalités de base de votre application, y compris :
- Connexion à une session
- Publication de flux dans une session
- S'abonner à des flux dans une session
La référence du SDK Web de l'API Video de Vonage se trouve à l'adresse suivante ici.
Toutes les Applications qui utilisent l'API Video de Vonage sont composées de deux parties :
- Le côté client, qui utilise les SDK du client Vonage Video et s'exécute dans le navigateur ou l'application mobile de l'utilisateur
- Le côté serveur, qui utilise la fonction SDKs du serveur vidéo de Vonage et s'exécute sur votre serveur pour transmettre les informations d'authentification au client
Tous les SDK des clients Vonage Video peuvent interagir entre eux. Pour en savoir plus sur les principes de base des clients, des serveurs et des sessions Vonage Video, ainsi que sur d'autres sujets, consultez notre Aperçu de l'API Video page.
Remarques importantes
-
Mise à jour du SDK Web. Il est désormais servi à partir de
https://video.standard.vonage.com/v2/js/opentok.min.js. -
Chrome/Edge 157 – Le filtre vidéo bloque la vidéo de l'éditeur. À compter de la version stable 157 de Chrome/Edge (3 novembre 2026), les éditeurs qui utilisent un
backgroundBluroubackgroundReplacementLe filtre vidéo peut parfois cesser de générer des images vidéo, principalement sous Windows 10/11. La session, la connexion et le flux audio restent actifs, mais la partie distante voit une vidéo figée ou un écran noir. Ce problème affecte toutes les versions prises en charge d’OpenTok.js. Pour contourner ce problème, utilisez le moteur de segmentation allégé avec la prise en charge du GPU désactivée en incluant les propriétés suivantes dans le fichiervideoFilterobjet transmis àOT.initPublisher()ou versPublisher.applyVideoFilter():CopiesegmentationOptions: { lightWeightEngine: true, gpuSupport: false }, modelAssetUriPath: 'https://static.opentok.com/ml-transformers/v4.0.0/selfie_segmentation_landscape.tflite', mediapipeBaseAssetsUri: 'https://static.opentok.com/ml-transformers/v4.0.0/'Une solution est en cours d'étude.
-
Chrome M136 sous Windows – problème de détection du périphérique audio. Nous avons identifié un problème avec Chrome M136 sous Windows : le navigateur peut parfois répondre lentement ou ne pas fonctionner correctement lors de la récupération des informations relatives aux périphériques audio. Ce problème a été résolu dans la version Chrome 137.0.7150.0, et le correctif a également été intégré à un prochain correctif de Chrome 136. En attendant, si vous rencontrez ce problème, nous vous recommandons soit de revenir à la version Chrome 135 et de la fixer, soit d'utiliser un autre navigateur. Veuillez contacter le service d'assistance si vous avez besoin d'aide pour mettre en œuvre une solution de contournement.
-
Problèmes corrigés dans Safari 15.4 et 15.5. Les versions 15.4 et 15.5 de Safari (livrées avec iOS 15.4 et 15.5 et macOS 12.3 et 12.4) corrigent les problèmes suivants, qui pourraient affecter les applications utilisant OpenTok.js (dans Safari) :
- Problèmes audio lors de l'utilisation de certains modèles de casques Bluetooth. Sur certains modèles d'oreillettes Bluetooth, le son peut s'interrompre. Il s'agit d'une Bogue de WebKit est corrigé dans Safari 15.4.
- Problèmes d'écho lors du changement de microphone dans macOS Safari. Le changement du microphone utilisé par un éditeur pouvait entraîner un écho de l'audio de l'éditeur. L'écho n'apparaissait pas du côté de l'abonné. Cette situation est due au fait que l'abonné n'a pas d'écho. Bogue de WebKit est corrigé dans Safari 15.5.
- Bug critique publiant de la vidéo H.264 dans les sessions routées dans iOS 15.1. Dans iOS 15.1, la publication de vidéos H.264 dans les sessions routées échouait. Ce problème a été résolu par la mise en place d'un système de gestion de la vidéo. Bogue de WebKit Ce problème a été corrigé dans Safari 15.4.
- Volume sonore faible dans Safari sous iOS. Le présent Bogue de WebKit est corrigé dans Safari 15.4.
-
Cryptage de bout en bout — Dans OpenTok.js 2.27.0, le chiffrement de bout en bout ne fonctionnera pas avec les clients utilisant une version antérieure d'OpenTok.js. Lorsque vous mettez à jour votre application pour utiliser OpenTok.js 2.27.0 ou une version ultérieure, assurez-vous que tous les clients utilisent OpenTok.js 2.27.0 ou une version ultérieure si l'application utilise le chiffrement de bout en bout.
Interopérabilité
La version actuelle de la bibliothèque OpenTok.js (2.36.0) est compatible avec les applications Vonage Video développées à l'aide des SDK client Vonage Video version 2.34 ou ultérieure :
- OpenTok.js (Web)
- SDK Android
- SDK iOS
- SDK Windows
- SDK macOS
- SDK Linux
- SDK React Native
Installation
Pour charger OpenTok.js dans votre page web, ajoutez la balise script suivante :
<script src="https://video.standard.vonage.com/v2/js/opentok.min.js"></script>
Vous pouvez également installer OpenTok.js à l'aide de la commande @vonage/client SDK-vidéo paquet npm.
Visitez le site Guide de référence pour voir toutes les méthodes disponibles pour le SDK OpenTok.js.
Installation via les paquets GitHub
En plus de l'installation à partir du registre npm, les paquets du Client Video API SDK de Vonage sont également disponibles par le biais de Registre NPM des paquets GitHub. Il s'agit d'un canal de distribution alternatif pour les environnements d'entreprise qui nécessitent une gestion des paquets basée sur GitHub.
Packages disponibles
Le paquet suivant est publié sur GitHub Packages :
@vonage/client-sdk-video- Disponible à l'adresse suivante Paquets GitHub (Vonage org)
Instructions d'installation
Pour installer des paquets à partir du registre NPM de GitHub Packages, vous devez configurer npm pour qu'il s'authentifie auprès de GitHub :
1. Créer un jeton d'accès personnel GitHub (PAT)
Générer un jeton d'accès personnel avec read:packages dans les paramètres de votre compte GitHub.
2. Configurez votre .npmrc fichier
Ajoutez la configuration suivante au fichier .npmrc ou votre fichier ~/.npmrc fichier :
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
@vonage:registry= https://npm.pkg.github.com
Remplacer YOUR_GITHUB_TOKEN avec votre jeton d'accès personnel GitHub.
3. Installer le paquet
Une fois configuré, vous pouvez installer le paquet à l'aide de la commande standard npm install :
Note sur la disponibilité des paquets
Le registre traditionnel de npm et le registre des paquets de GitHub sont synchronisés. Vous pouvez choisir l'une ou l'autre méthode de distribution en fonction des préférences de votre organisation en matière de gestion des paquets. La méthode d'installation traditionnelle de npm (via npm install @vonage/client-sdk-video à partir du registre par défaut) reste entièrement pris en charge et ne nécessite aucune configuration supplémentaire.
Pour plus d'informations sur l'utilisation du registre NPM de GitHub Packages, voir la section Documentation sur les paquets GitHub.
Configuration requise
Pour une diffusion vidéo fiable dans les navigateurs modernes, assurez-vous que votre appareil répond aux spécifications recommandées :
- PROCESSEUR : Un processeur récent à deux cœurs ; un processeur à quatre cœurs (par exemple, Intel Core i5 / Ryzen 5) ou mieux pour le 1080p ou le multitâche lourd.
- GPU : Graphiques intégrés modernes (Intel UHD/Iris Xe ou AMD Radeon ou Nvidia Graphics) pour 1080p ; la prise en charge du décodage matériel pour le codage vidéo est fortement recommandée.
- MÉMOIRE VIVE : Au moins 8 Go pour le streaming quotidien ; 16 Go recommandés si vous gardez de nombreux onglets ou applications ouverts.
- Stockage : SSD de préférence pour un chargement rapide et une bonne réactivité du système.
- Réseau : Connectivité internet fiable ; fonctionne sur Wi-Fi, Ethernet ou cellulaire.
- Autre : L'accélération matérielle doit être activée dans le navigateur pour des performances optimales.
Ces recommandations garantissent une lecture stable, une utilisation réduite de l'unité centrale et des performances fluides lors de la diffusion de vidéos.
Apprendre à construire
La meilleure façon d'apprendre à utiliser OpenTok.js est de suivre notre Tutoriel de base sur le chat vidéo.
Une fois que vous maîtriserez les bases du développement avec OpenTok.js, vous pourrez obtenir des informations plus détaillées et découvrir comment personnaliser votre application grâce à notre Guides du développeur. Pour en savoir plus sur certaines classes et méthodes de l'API, vous pouvez consulter la Référence OpenTok.js.
Support des navigateurs
La bibliothèque OpenTok.js est actuellement prise en charge dans :
- Google Chrome (dernière version)
- Google Chrome pour Android (dernière version)
- Google Chrome pour iOS (dernière version)
- Firefox (dernière version)
- Firefox pour Android (dernière version)
- Prise en charge de la version bêta de Firefox pour iOS (dernière version)
- Microsoft Edge versions 79+ pour Windows et macOS (versions de Edge basées sur Chromium)
- Safari 11+ sur macOS et iOS. Pour plus d'informations sur l'interopérabilité vidéo et d'autres questions, consultez le site web de la Commission européenne. Prise en charge du navigateur Safari page.
- Opera (dernière version de la version de bureau uniquement)
- Electron (dernière version)
- Samsung Internet (dernière version)
- WebView Android API niveau 36+
- WebView sur iOS 18.6+
Assistance Safari
Apple a ajouté la prise en charge de WebRTC dans Safari 11 pour macOS et Safari sur iOS 11, et vous pouvez désormais utiliser les apps OpenTok.js sur Safari.
En outre, Safari 12.1 prend en charge le codec vidéo VP8, en plus du codec H.264. La prise en charge du VP8 dans Safari 12.1 est livrée avec macOS 10.14.4, et elle est également disponible pour macOS 10.13.6 et 10.12.6. Elle est également disponible dans la dernière version d'iOS 12.2.
Vous devez utiliser la version 2.16.0 ou ultérieure d'OpenTok.js pour utiliser le codec vidéo VP8 dans Safari.
Pour plus d'informations sur la prise en charge des codecs vidéo, voir le document suivant guide du développeur.
Limites
Les limitations suivantes concernent OpenTok.js sur Safari :
- La publication de vidéos en partage d'écran n'est pas prise en charge dans Safari sur iOS et dans Safari 12 et les versions antérieures sur macOS. Elle est prise en charge dans Safari 13+ sur macOS.
- Safari ne prend pas en charge l'accès aux caméras (ou la publication de flux) dans les pages chargées à l'aide des schémas URI http : (non sécurisé) ou file : (système de fichiers). Vous devez servir la page via https : (sécurisé). Toutefois, vous pouvez activer un drapeau pour prendre en charge HTTP (à des fins de test).
- Safari ne prend pas en charge l'accès à la caméra sur localhost. Vous devez utiliser 0.0.0.0:xx (où xx est le numéro de port, par exemple 80).
- Le chiffrement de bout en bout ne fonctionne pas sur Safari lorsque les outils de développement sont ouverts. Ce problème a été corrigé dans la version 2.35.1.
Anciennes versions
Les anciennes versions de Safari utilisent exclusivement le codec vidéo H.264 et ne prennent donc pas en charge le codec vidéo VP8.
En sessions acheminées (sessions utilisant le Media Router), vous devez utiliser un projet dont le codec préféré est défini sur H.264 afin que les anciennes versions de Safari puissent publier et s'abonner à des vidéos. Définissez le codec vidéo préféré pour un projet sur la page « Projet » de votre compte Video API.
Dans un session acheminée (une session qui utilise OpenTok Media Router) dans un projet dont le codec vidéo préféré est VP8 (et non H.264), les clients utilisant des versions plus anciennes de Safari peuvent utiliser la plateforme vidéo de Vonage, mais sans support vidéo.
Prise en charge d'Async/Await et des Promise
À partir de la version 2.35.1, le SDK JS prend en charge les technologies modernes async/await et des modèles basés sur les promesses, parallèlement à l'API existante basée sur les callbacks. Cette modification est entièrement rétrocompatible : tout le code existant basé sur les callbacks continue de fonctionner sans modification.
Remarque : Dans le cadre de ces travaux, le SDK a permis d'affiner la gestion des erreurs dans ses flux internes et affiche désormais les informations relatives aux erreurs avec plus de précision. À partir de la version 2.35.1, certaines fonctions signalent des erreurs qui passaient auparavant inaperçues. Il ne s'agit pas de nouvelles défaillances, mais d'erreurs préexistantes qui sont désormais correctement propagées ; vous pourrez donc constater l'apparition d'erreurs dans des cas qui passaient auparavant inaperçus.
Deux modèles sont disponibles selon la méthode choisie :
Les méthodes qui renvoyaient auparavant void (par exemple session.signal(), OT.getDevices() et d'autres) acceptent désormais un callback facultatif et renvoient également un Promise. Consultez la liste complète sous les extraits de code :
// Callback style (still works)
session.signal({ data: 'hello' }, function(error) {
if (error) { console.error(error); }
else { console.log('Signal sent'); }
});
// Promise / async-await style (new in 2.35.1)
try {
await session.signal({ data: 'hello' });
console.log('Signal sent');
} catch (error) {
console.error(error);
}
Méthodes qui renvoyaient auparavant un objet (par exemple OT.initPublisher(), session.publish()et session.subscribe()) dévoilent un nouveau .promise() fonction de la méthode elle-même. Consultez la liste complète sous les extraits de code :
// Callback style (still works)
const publisher = OT.initPublisher(targetElement, properties, function(error) {
if (error) { console.error(error); }
});
// Promise / async-await style (new in 2.35.1)
try {
const publisher = await OT.initPublisher.promise(targetElement, properties);
} catch (error) {
console.error(error);
}
Méthodes mises à jour
Les méthodes suivantes ont été mises à jour pour prendre en charge les « promises » :
Les fonctions qui renvoyaient auparavant void — le paramètre de rappel est désormais facultatif et la fonction renvoie également un Promise:
| Méthode | Retours |
|---|---|
OT.checkScreenSharingCapability |
Promise<void> |
OT.getDevices |
Promise<Device[]> |
OT.reportIssue |
Promise<void> |
publisher.getStats |
Promise<void> |
publisher.publishCaptions |
Promise<void> |
session.disconnect |
Promise<void> |
session.forceDisconnect |
Promise<void> |
session.forceUnpublish |
Promise<void> |
session.signal |
Promise<void> |
subscriber.getStats |
Promise<void> |
subscriber.setPreferredFrameRate |
Promise<void> |
subscriber.setPreferredResolution |
Promise<void> |
Fonctions qui renvoyaient auparavant un objet — un nouveau .promise() La fonction est exposée au niveau de la méthode elle-même :
| Méthode | Retours |
|---|---|
OT.initPublisher |
.promise() retours Promise<Publisher> |
publisher.destroy |
.promise() retours Promise<void> |
publisher.publishAudio |
.promise() retours Promise<void> |
publisher.publishVideo |
.promise() retours Promise<void> |
session.connect |
.promise() retours Promise<Session> |
session.publish |
.promise() retours Promise<Publisher> |
session.subscribe |
.promise() retours Promise<Subscriber> |
subscriber.setAudioVolume |
.promise() retours Promise<void> |
subscriber.restrictFrameRate |
.promise() retours Promise<void> |
subscriber.subscribeToAudio |
.promise() retours Promise<void> |
subscriber.subscribeToVideo |
.promise() retours Promise<void> |
Les définitions TypeScript ont été mises à jour afin de refléter toutes les nouvelles signatures.
Remarque : Pour un guide complet sur la migration de votre code existant basé sur les callbacks vers les promesses, consultez le Guide de transition des callbacks du SDK JS vers les Promises.
Numéros de version
Vous pouvez inclure la bibliothèque OpenTok.js dans votre page web à l'aide d'une balise <script> étiquette :
<script src="https://video.standard.vonage.com/v2/js/opentok.min.js"></script>
Le numéro de version d'OpenTok.js se compose de trois parties :
- Le numéro de version majeure - Ce numéro (le premier) est incrémenté lorsqu'une nouvelle version inclut une modification de l'API qui n'est pas rétrocompatible.
- Le numéro de version mineure - Ce numéro (le deuxième) est incrémenté lorsqu'une nouvelle version ajoute de nouvelles fonctionnalités.
- Le numéro de patch - Ce numéro (le troisième) est incrémenté lorsqu'il existe une nouvelle version qui corrige des bogues ou améliore les performances sans ajouter de nouvelles fonctionnalités.
Par exemple, v2.4.0 est la version majeure 2, la version mineure 4 (de la version majeure 2) et la révision 0 (de v2.4). Au fur et à mesure que les versions de révision sont publiées, les modifications sont incluses dans la révision mineure racine. Par exemple, lorsque la version 2.2.3 est publiée, ses modifications sont incluses dans la version 2.2.
Pour faire référence à une révision spécifique, vous pouvez inclure le numéro de version complet (tel que "v2.4.0") dans le champ src . Cependant, nous vous recommandons de ne spécifier que le numéro de version majeure. Vonage soutient officiellement la version actuelle de la bibliothèque. Si vous chargez une version plus ancienne, nous vous demandons de la mettre à jour afin de bénéficier des dernières corrections de bogues et fonctionnalités de la plateforme vidéo de Vonage.
Important : Utilisez toujours les bibliothèques que nous fournissons sans les modifier. Vous êtes ainsi assuré d'utiliser le code le plus récent et le plus testé. L'API Video de Vonage ne prend pas en charge l'utilisation de bibliothèques modifiées.
Échantillons de code
Pour obtenir un exemple de code, visitez notre site dépôt « video-api-web-samples » sur GitHub.
Documentation et informations complémentaires
Voir le Référence de l'API Vonage Video Web SDK.
Pour une liste des nouvelles fonctionnalités et des problèmes connus, voir la page notes de mise à jour.