Client SDK para el cliente web

Importante
SDK web actualizado. Ahora se sirve desde https://video.standard.vonage.com/v2/js/opentok.min.js. Problemas solucionados en Safari 15.4 y 15.5. Las versiones 15.4 y 15.5 de Safari (que se incluyen con iOS 15.4 y 15.5 y macOS 12.3 y 12.4) corrigen los siguientes problemas, que podrían afectar a las aplicaciones que utilizan OpenTok.js (en Safari):
Problemas de audio al utilizar determinados modelos de auriculares Bluetooth. En algunos modelos de auriculares Bluetooth, el audio puede fallar. Este Error de WebKit se ha corregido en Safari 15.4.
Problemas de eco al cambiar de micrófono en macOS Safari. Al cambiar el micrófono utilizado por un editor, podía producirse un eco del audio del editor. El eco no aparecía en el lado del abonado. Este Error de WebKit se ha corregido en Safari 15.5.
Error crítico al publicar vídeo H.264 en sesiones enrutadas en iOS 15.1. En iOS 15.1, la publicación de vídeo H.264 en sesiones enrutadas fallaba. Esto Error de WebKit se ha corregido en Safari 15.4. El volumen de audio bajo es iOS Safari. Esto Error de WebKit se ha corregido en Safari 15.4.

Cifrado de extremo a extremo: En OpenTok.js 2.27.0, el cifrado de extremo a extremo no funcionará con clientes que utilicen versiones anteriores de OpenTok.js. Cuando actualices tu aplicación para utilizar OpenTok.js 2.27.0 o superior, asegúrate de que todos los clientes utilicen OpenTok.js 2.27.0 o superior si la aplicación utiliza cifrado de extremo a extremo.

Visión general

Todas las aplicaciones que utilizan la Video API de Vonage constan de dos partes:

  • El lado del cliente, que utiliza los SDK de cliente de Vonage Video y se ejecuta en el navegador o la aplicación móvil del usuario.
  • La parte del servidor, que utiliza el SDK de los servidores de vídeo de Vonage y se ejecuta en tu servidor para enviar la información de autenticación al cliente

El Client SDK para crear aplicaciones basadas en web que utilicen la Video API de Vonage es OpenTok.js. Esta biblioteca JavaScript proporciona la mayor parte de la funcionalidad básica para su aplicación, incluyendo:

  • Conectarse a una sesión
  • Publicación de flujos en una sesión
  • Suscripción a flujos en una sesión

Todos los SDK de cliente de Vonage Video podrán interactuar entre sí. Puedes obtener más información sobre los aspectos básicos de los clientes, servidores, sesiones y más de Vonage Video en nuestro Descripción general de la Video API página.

La documentación de referencia del SDK web de la Video API de Vonage se puede consultar en aquí.

La versión actual de la biblioteca OpenTok.js puede interoperar con aplicaciones de Vonage Video escritas con la versión 2.32+ de los SDK del cliente de Vonage Video:

  • OpenTok.js (Web)
  • SDK de Android
  • SDK para iOS
  • SDK de Windows
  • SDK de macOS
  • SDK para Linux
  • SDK de React Native

Cargando OpenTok.js

Para cargar OpenTok.js en tu página web, añade la siguiente etiqueta script:

<script src="https://video.standard.vonage.com/v2/js/opentok.min.js"></script>

También puede instalar OpenTok.js utilizando el archivo @vonage/client-sdk-video paquete npm.

Visita la Guía de referencia para ver todos los métodos disponibles del SDK de OpenTok.js.

Instalación mediante paquetes de GitHub

Además de instalarlos desde el registro de npm, los paquetes del Vonage Client SDK para la Video API también están disponibles a través de Registro NPM de los paquetes de GitHub. Esto ofrece un canal de distribución alternativo para entornos empresariales que requieren una gestión de paquetes basada en GitHub.

Paquetes disponibles

El siguiente paquete está publicado en GitHub Packages:

Instrucciones de instalación

Para instalar paquetes desde el registro NPM de GitHub Packages, debes configurar npm para que se autentique con GitHub:

1. Crear un token de acceso personal (PAT) de GitHub

Genera un token de acceso personal con read:packages scope desde la configuración de tu cuenta de GitHub.

2. Configura tu .npmrc archivo

Añada la siguiente configuración a la carpeta .npmrc o su archivo ~/.npmrc archivo:

//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
@vonage:registry= https://npm.pkg.github.com

Sustituir YOUR_GITHUB_TOKEN con tu token de acceso personal de GitHub.

3. Instalar el paquete

Una vez configurado, puedes instalar el paquete utilizando el comando estándar «npm install»:

npm install @vonage/client-sdk-video

Nota sobre la disponibilidad de los paquetes

Tanto el registro npm tradicional como el registro de paquetes de GitHub se mantienen sincronizados. Puedes elegir cualquiera de los dos métodos de distribución en función de las preferencias de gestión de paquetes de tu organización. El método tradicional de instalación de npm (a través de npm install @vonage/client-sdk-video (desde el registro predeterminado) sigue siendo totalmente compatible y no requiere ninguna configuración adicional.

Para obtener más información sobre cómo trabajar con el registro NPM de los paquetes de GitHub, consulta la sección Documentación de los paquetes de GitHub.

Compatibilidad con navegadores

La biblioteca OpenTok.js es compatible actualmente con:

  • Google Chrome (última versión disponible)
  • Google Chrome para Android (última versión)
  • Google Chrome para iOS (última versión)
  • Firefox (última versión)
  • Firefox para Android (última versión disponible)
  • Compatibilidad con la versión beta de Firefox para iOS (última versión publicada)
  • Microsoft Edge, versiones 79 y posteriores, para Windows y macOS (versiones de Edge basadas en Chromium)
  • Safari 11+ en macOS e iOS. Para obtener información sobre la interoperabilidad de vídeo y otras cuestiones, consulte el Compatibilidad con el navegador Safari página.
  • Opera (sólo la última versión de escritorio)
  • Electron (última versión)
  • Samsung Internet (última versión)
  • WebView Android API nivel 36+
  • WebView en iOS 18.6 y versiones posteriores

Compatible con Safari

Apple ha incorporado la compatibilidad con WebRTC en Safari 11 para macOS y en Safari para iOS 11, por lo que ahora puedes utilizar aplicaciones de OpenTok.js en Safari.

Además, Safari 12.1 es compatible con el códec de vídeo VP8, además de con H.264. La compatibilidad con VP8 en Safari 12.1 viene incluida en macOS 10.14.4, y también está disponible para macOS 10.13.6 y 10.12.6. Y está disponible en la última versión de iOS 12.2.

Debes utilizar la versión 2.16.0 o posterior de OpenTok.js para utilizar el códec de vídeo VP8 en Safari.

Para obtener más información sobre la compatibilidad con códecs de vídeo, consulte este enlace Guía para desarrolladores.

Limitaciones

A continuación se indican las limitaciones de OpenTok.js en Safari:

  • La publicación de vídeos para compartir pantalla no es compatible con Safari en iOS ni con Safari 12 y versiones anteriores en macOS. Es compatible con Safari 13+ en macOS.
  • Safari no admite el acceso a la cámara (ni la publicación de transmisiones en directo) en páginas cargadas mediante los esquemas URI «http:» (no seguro) o «file:» (sistema de archivos). Debes servir la página a través de «https:» (seguro). No obstante, puedes activar una opción para habilitar HTTP (con fines de prueba).
  • Safari no admite el acceso a la cámara en localhost. Debe utilizar 0.0.0.0:xx (donde xx es el número de puerto, por ejemplo 80).
  • El cifrado de extremo a extremo no funciona en Safari cuando las herramientas de desarrollo están abiertas.

Versiones anteriores

Las versiones más antiguas de Safari utilizan exclusivamente el códec de vídeo H.264, por lo que no son compatibles con el códec de vídeo VP8.

En sesiones enrutadas (sesiones que utilizan el Media Router), debes utilizar un proyecto en el que el códec preferido esté configurado como H.264, para que las versiones anteriores de Safari puedan publicar y suscribirse a vídeos. Configura el códec de vídeo preferido para un proyecto en la página «Proyecto» de tu Account de la Video API.

En un sesión enrutada (una sesión que utiliza el enrutador de medios OpenTok) en un proyecto que tiene el códec de video preferido configurado en VP8 (no H.264), los clientes que utilizan versiones anteriores de Safari pueden utilizar la plataforma de video de Vonage pero sin soporte de video.

Requisitos del sistema

Para disfrutar de una transmisión de vídeo fluida en los navegadores actuales, asegúrate de que tu dispositivo cumpla con estas especificaciones recomendadas:

  • CPU: Un procesador de doble núcleo reciente; uno de cuatro núcleos (por ejemplo, Intel Core i5 o Ryzen 5) o superior para resolución 1080p o multitarea intensiva.
  • GPU: Gráficos integrados modernos (Intel UHD/Iris Xe o AMD Radeon o Nvidia Graphics) para 1080p; se recomienda encarecidamente la compatibilidad con decodificación de hardware para codificación de vídeo.
  • RAM: Al menos 8 GB para el streaming diario; se recomiendan 16 GB si tienes muchas pestañas o aplicaciones abiertas.
  • Almacenamiento: SSD preferido para carga rápida y capacidad de respuesta del sistema.
  • Red: Conectividad a Internet fiable; funciona a través de Wi-Fi, Ethernet o móvil.
  • Otros: La aceleración de hardware debe estar activada en el navegador para un rendimiento óptimo.

Estas recomendaciones garantizan una reproducción estable, un menor consumo de CPU y un rendimiento fluido al reproducir vídeo en streaming.

Numbers de versión

Puedes incluir la librería OpenTok.js en tu página web utilizando una etiqueta <script> etiqueta:

<script src="https://video.standard.vonage.com/v2/js/opentok.min.js"></script>

El número de versión de OpenTok.js consta de tres partes:

  • El número de versión principal: este número (el primero) se incrementa cuando se lanza una nueva versión que incluye un cambio en la API que no es compatible con versiones anteriores.
  • El número de versión menor: este número (el segundo) se incrementa cuando se lanza una nueva versión que incorpora nuevas funcionalidades.
  • El número de parche - Este número (el tercero) se incrementa cuando hay una nueva versión que corrige errores o mejora el rendimiento sin añadir nuevas funcionalidades.

Por ejemplo, v2.4.0 es la versión mayor 2, la versión menor 4 (de la versión mayor 2) y la revisión 0 (de v2.4). A medida que se publican versiones de revisión, los cambios se incluyen en la revisión menor raíz. Por ejemplo, cuando se publica la v2.2.3, sus cambios se incluyen en la v2.2.

Para hacer referencia a una revisión concreta, puede incluir el número de versión completo (como "v2.4.0") en el campo src atributo. No obstante, te recomendamos que especifiques únicamente el número de versión principal. Vonage ofrece soporte oficial para la versión actual de la biblioteca. Si estás utilizando una versión anterior, te rogamos que la actualices para poder beneficiarte de las últimas correcciones de errores y funciones de la plataforma de vídeo de Vonage.

Importante: Utiliza siempre las bibliotecas que te proporcionamos sin modificarlas. De este modo, te aseguras de utilizar el código más reciente, actualizado y probado. La Video API de Vonage no admite el uso de bibliotecas modificadas.

Para saber cuándo estarán disponibles las nuevas versiones de OpenTok.js, suscríbete a la API de Video de Vonage Anuncios foro.