Conceptos básicos de la Video API

Descubre los conceptos básicos sobre qué es la Video API de Vonage y cómo funciona.

Este tema incluye las siguientes secciones:

¿Buscas código? Entender cómo funciona la plataforma Vonage Video API resulta de gran ayuda a la hora de desarrollar aplicaciones con Vonage Video API, pero si prefieres ponerte manos a la obra con el código y empezar a desarrollar antes de aprender los conceptos básicos, echa un vistazo a nuestro Tutoriales.

La plataforma Vonage Video API

La plataforma Vonage Video API facilita la integración de vídeo interactivo en tiempo real y de alta calidad, mensajería, uso compartido de pantalla y mucho más en aplicaciones web y móviles. La plataforma incluye bibliotecas de cliente para web, iOS, Android, Windows, macOS, Linux y React, así como SDK del lado del servidor y una API REST. La Video API de Vonage utiliza WebRTC para comunicaciones de audio y vídeo.

Todas las aplicaciones desarrolladas con la plataforma Vonage Video API requieren dos componentes principales:

  • El cliente — código del lado del cliente que se ejecuta en un navegador o en una aplicación móvil, configurado por el desarrollador mediante las bibliotecas del lado del cliente de la Video API de Vonage, que están disponibles para Web, iOS, Android, Windows, macOS, Linuxy React Native. El lado del cliente se encarga de la mayor parte de las funciones de la Video API de Vonage.
  • El servidor — código del lado del servidor ejecutado en un servidor web configurado por el desarrollador mediante los SDK de servidor de la Video API de Vonage, que están disponibles para Nodo, PHP, Java, .NET, Pythony Rubí.

Funciones del cliente y del servidor

Cliente:

Servidor de aplicaciones:

Sesión:

  • «Sala de chat» en la Video API de Vonage en la nube
  • Conecta a los clientes entre sí
  • Envía eventos a los clientes

Sesiones

Todas las conversaciones de vídeo de la Video API de Vonage tienen lugar dentro de un sesión. Puedes imaginarte una sesión como una «sala» en la que los clientes pueden interactuar entre sí en tiempo real. Las sesiones se alojan en el Video API de Vonage en la nube y gestionar usuarios conexiones, audio y vídeo arroyos, y el usuario eventos (como, por ejemplo, cuando se registra un nuevo usuario). Cada sesión está asociada a un ID de sesión. Para que varios clientes puedan chatear entre sí, basta con que se conecten a la misma sesión (utilizando el mismo ID de sesión).

El servidor de aplicaciones (que ejecuta el código del lado del servidor) se encarga de crear nuevas sesiones y generar una autenticación única fichas para cada nuevo cliente. A continuación, el cliente utiliza ese token para establecer una conexión con la sesión. Los clientes conectados a una sesión pueden publicar envía datos a la sesión y suscríbase a a las transmisiones de otros clientes. Para obtener más información sobre cómo se conectan los clientes a una sesión, consulta la siguiente sección.

Sesiones de depuración con Inspector

Si quieres consultar información sobre una sesión concreta, puedes utilizar Inspector. Esta herramienta ofrece un desglose completo de la sesión, incluyendo usuarios, calidad, eventos, errores y mucho más. Resulta útil para depurar y comprender mejor lo que ocurre en las sesiones de tu aplicación.

Conexión, publicación y suscripción

En esta sección se ofrece un desglose visual de los pasos que deben seguir dos usuarios para iniciar una sesión de videochat.

Paso 1: El servidor de aplicaciones crea la sesión

Su servidor de aplicaciones, utilizando código de un SDK del servidor de la Video API de Vonage, crea una sesión en la nube a través de la API REST de Vonage Video y recibe el identificador de sesión. Piensa en la sesión como una «sala» en la que tendrá lugar el chat de vídeo. En este momento, está desocupada.

Paso 2: Un cliente carga la aplicación y el servidor genera un token

Cuando un usuario carga tu aplicación del lado del cliente, desarrollada con un Client SDK de la Video API de Vonage, el cliente (una página web o una aplicación móvil) obtiene la información de la sesión del servidor. Esto incluye una autenticación única ficha (la «clave» del cliente) generada por el servidor de tu aplicación.

Paso 3: El cliente se conecta y comienza a transmitir a la sesión

El cliente utiliza el identificador de sesión y el token para establecer una conexión con la sesión. A continuación, el cliente puede publicar un sistema de audio y vídeo corriente a la sesión y presta atención a los aspectos importantes eventos (como, por ejemplo, la incorporación de un nuevo usuario a la sesión). En este momento, el cliente es el único participante en la sesión.

Paso 4: Un nuevo cliente se conecta a la sesión

Cuando un nuevo usuario carga la aplicación del lado del cliente en una página web independiente o en un dispositivo móvil (Cliente 2), el nuevo cliente recibe el ID de sesión y un token único del servidor de tu aplicación. El cliente utiliza esa información para establecer una conexión con la sesión.

Paso 5: Los clientes se suscriben a los flujos de los demás

Ahora que está conectado a la sesión, el Cliente 2 puede suscribirse a la transmisión del Cliente 1. A continuación, el Cliente 2 publica su propia transmisión de vídeo en la sesión, y el Cliente 1 se suscribe a ella. Ahora ambos clientes están suscritos a la transmisión del otro en un chat de vídeo uno a uno, y ambos están «a la espera» de nuevos eventos (como que un nuevo usuario se conecte a la sesión).

La Video API de Vonage admite tanto la comunicación uno a uno como la comunicación en grupo. Varios clientes pueden conectarse a una sesión y cada uno de ellos puede suscribirse a cada transmisión de la sesión. Además de las funciones básicas mencionadas anteriormente, la plataforma de la Video API de Vonage ofrece una variedad de funciones adicionales, tales como compartir pantalla, archivo, chat de texto, radiodifusión, y mucho más. Para ver el conjunto completo de funciones que se ofrecen, consulta el guías para desarrolladores.

Creación de una aplicación con la Video API de Vonage

Tras revisar los materiales anteriores, deberías tener una idea básica de cómo funciona la Video API de Vonage. Si estás listo para empezar a desarrollar tu primera aplicación, echa un vistazo al tutorial básico para clientes web, iOS, Android, Windows o Linux:

Ver tutoriales básicos para clientes

A continuación también encontrarás una lista de términos clave y definiciones, junto con un listado de otros Recursos del Centro para desarrolladores.

Términos clave

Sesión

Puedes imaginarte una sesión como una «habitación» en la que clientes pueden interactuar entre sí en tiempo real, asociadas a un identificador de sesión único. Las nuevas sesiones las genera tu servidor de aplicaciones a través de la SDK para servidores. Los clientes pueden obtener el identificador de sesión y una autenticación única ficha desde el servidor hasta inicializar y conectarse a la sesión, tras lo cual podrán publicar arroyos y suscríbase a a los flujos de la sesión, así como escuchar eventos enviados por la sesión (como, por ejemplo, la conexión de un nuevo usuario).

Consulte nuestro guías para desarrolladores para aprender a crear una sesión con los SDK del servidor, unirse a una sesión con el SDK de cliente, y descubre más funciones relacionadas con las sesiones. Para obtener información sobre clases, métodos y eventos específicos asociados a las sesiones, consulta nuestra documentación de referencia de la API para Web, iOS, Android, Windowsy Linux.

Token

Un token es una «clave» de autenticación única que permite a un cliente para unirse a un sesión. Cuando un cliente intenta unirse a una sesión, tu servidor de aplicaciones genera un token único y lo envía al cliente junto con el ID de sesión. Los tokens tienen una fecha de caducidad (especificada por el servidor), mientras que las sesiones nunca caducan. A los tokens también se les pueden asignar roles — editor, suscriptor, o moderador, que determinan los permisos del cliente, como la publicación arroyos y suscribirse a los flujos de la sesión.

Consulte nuestro guías para desarrolladores para aprender a crear un token con el SDK para servidores y unirse a una sesión con el SDK de cliente. Al crear una demostración o una prueba de concepto, puedes generar tokens en tu Video API de Vonage Account creando un proyecto, accediendo a la «Descripción general del proyecto» y desplazándose hacia abajo hasta las herramientas del proyecto, pero es necesario configurar un componente de servidor antes de pasar a producción.

Cliente

Se entiende por «cliente» cualquier navegador o aplicación móvil que utilice código del lado del cliente de la Video API de Vonage. SDK de cliente. El cliente es uno de los dos componentes clave que conforman una aplicación de la Video API de Vonage (siendo el otro el servidor), y es responsable de la mayor parte de las funciones de la Video API de Vonage, como conectarse a una sesión, edición y suscribiéndose a a arroyos, a la espera de una sesión eventos, y el envío de eventos a la sesión.

Antes de poder interactuar con una sesión, el cliente debe recibir el identificador de sesión y ficha generados por tu servidor de aplicaciones. Echa un vistazo a nuestro Tutorial básico para clientes para aprender a implementar funcionalidades del lado del cliente, así como nuestro guías para desarrolladores para más información.

Servidor

El servidor de aplicaciones, configurado por el desarrollador de la aplicación mediante el SDK para servidores de la Video API de Vonage, genera nuevos sesiones y fichas, que a continuación envía a la cliente. Todas las aplicaciones de la Video API de Vonage requieren tanto un componente de cliente como uno de servidor. Echa un vistazo a nuestra guías para desarrolladores para aprender a crear una sesión y crear un token con los SDK del servidor, así como otras funcionalidades gestionadas por el servidor.

Conexión

A cliente interactúa con el sesión a través de una conexión de eventos (o de señalización) persistente, que utiliza WebSockets para estar constantemente a la espera de nuevos eventos enviada por la sesión. Esta conexión es diferente de las conexiones multimedia WebRTC que se establecen cuando los clientes publicar y suscríbase a a arroyos en la sesión.

Para establecer una conexión con una sesión, el cliente debe recibir un identificador de sesión y ficha de tu servidor de aplicaciones, que luego se utilizan para la autenticación. Por lo general, cada cliente abre una única conexión a una sesión determinada, y cada conexión de un cliente a la sesión se asocia a un identificador de conexión único. Echa un vistazo a nuestro guías para desarrolladores para aprender a conectarse a una sesión con el SDK de cliente.

Transmisión

Una transmisión es una señal única de audio y vídeo que incluye la señal de la cámara y el micrófono que publica un usuario. Durante una sesión, clientes publicar envía datos a la sesión y suscríbase a a las transmisiones de otros clientes. Cuando se crea una nueva transmisión, un evento es enviado tanto por el Objeto «Editor» y Objeto de sesión.

Publicar

Una vez que... cliente es conectado a un sesión, puede publicar un archivo de audio y vídeo corriente a la sesión utilizando la cámara web y el micrófono del dispositivo. El cliente ficha función (editor, suscriptor, moderador) determina si ese cliente puede publicar en la sesión. Esto permite que haya sesiones con solo uno o dos emisores, pero con muchos suscriptores (relación uno a muchos). Echa un vistazo a nuestro guías para desarrolladores para aprender a publicar una transmisión a una sesión con el SDK de cliente.

Suscríbase a

Una vez que... cliente es conectado a un sesión, puede suscribirse a cualquier contenido audiovisual arroyos publicado por otros clientes de la sesión. Echa un vistazo a nuestro guías para desarrolladores para aprender a suscribirse a las transmisiones en una sesión con el SDK de cliente.

Eventos

Una vez que... cliente establece un conexión a un sesión, es capaz de detectar los eventos enviados por la sesión. Los eventos se envían por diversos motivos, como la creación de un nuevo flujo o la conexión o desconexión de un nuevo cliente de la sesión. Si quieres que un cliente reaccione ante un evento concreto, debes configurar un detector de eventos. Para obtener información sobre los distintos eventos que pueden producirse durante una sesión y cómo gestionarlos, consulta la Client SDK documentación de referencia para web (JavaScript), iOS, Android, Windowsy Linux.

Client SDK

Los SDK de cliente son un conjunto de bibliotecas de código disponibles para web (JavaScript), iOS, Android, Windowsy Linux, que se utiliza para configurar el cliente. El código del lado del cliente gestiona la mayor parte de las funciones de la Video API de Vonage, entre las que se incluyen edición y suscribiéndose a a arroyos en la sesión y a la espera de la sesión eventos.

SDK del servidor

Los SDK del servidor son un conjunto de envoltorios para el API REST de Vonage Video disponible para Nodo, PHP, Java, .NET, Pythony Rubí. Este código está configurado en tu servidor de aplicaciones y se utiliza para generar nuevos sesiones y fichas para la cliente.

API REST de Vonage Video

La API REST de Vonage Video es una interfaz HTTP con el Video API en la nube de Vonage que se utiliza para crear sesiones y gestionar funciones avanzadas como archivo y emisión. La Video API de Vonage SDK para servidores implementar muchos de los métodos de la API REST. Echa un vistazo a la Documentación de referencia de la API REST para conocer los distintos métodos disponibles.

Video API en la nube de Vonage — gestiona sesiones, cliente conexiones, llamadas a la API, señalización, eventos, y prácticamente todo lo demás que no se gestiona mediante el SDK de cliente o SDK para servidores.

Recursos del Centro para desarrolladores

El artículo que estás leyendo, junto con el resto de la documentación de la Video API de Vonage, forma parte de la Centro para desarrolladores de la Video API de Vonage. El Centro para desarrolladores tiene como objetivo proporcionar todo lo que un desarrollador necesita para crear y mantener con éxito una aplicación basada en la Video API de Vonage.

Estos son algunos de los recursos disponibles en el Centro de desarrolladores:

Hola, mundo — una breve demostración de las funciones más básicas de la Video API de Vonage

Tutoriales — Guías paso a paso sobre cómo crear una aplicación con la Video API de Vonage e incorporar funciones avanzadas

Muestras de código — una lista de repositorios de GitHub con aplicaciones de ejemplo que te ayudarán a desarrollar más rápido

Vídeos de chat incrustados — la forma más rápida de integrar las funciones de la Video API de Vonage en tu página web con un código mínimo

Guías para desarrolladores — Documentación exhaustiva sobre todas las características y funcionalidades de la Video API de Vonage

Referencia del Client SDK para Web, iOS, Android, Windows, Linux — información sobre clases, métodos y eventos específicos que utilizan los SDK de cliente

Documentación de referencia de la API REST — una guía para utilizar la Video API de Vonage y los SDK de servidor

Herramientas para desarrolladores — herramientas útiles para sesiones de depuración, pruebas de llamadas a la API y mucho más

Programas beta — una página en la que se enumeran todas las versiones beta públicas de la Video API de Vonage y se explica cómo participar en ellas

Cómo obtener ayuda

Si tienes alguna pregunta o te surge algún problema y no encuentras la respuesta en el Centro de desarrolladores, puedes Visita nuestro centro de asistencia para ponerte en contacto con nuestro equipo de atención al cliente o consultar las preguntas más frecuentes.