Noções básicas sobre a Video API

Conheça os conceitos básicos sobre o que é a Video API da Vonage e como ela funciona.

Este tópico inclui as seguintes seções:

Está procurando código? Entender como funciona a plataforma da Video API da Vonage é extremamente útil para desenvolver Applications com a Video API da Vonage, mas se você preferir mergulhar direto no código e começar a desenvolver antes de aprender os Concepts básicos, confira nosso Tutoriais.

A plataforma Vonage Video API

A plataforma Vonage Video API facilita a integração de vídeo interativo em tempo real e de alta qualidade, mensagens, compartilhamento de tela e muito mais em aplicativos web e móveis. A plataforma inclui bibliotecas de cliente para web, iOS, Android, Windows, macOS, Linux e React, além de SDKs do lado do servidor e uma API REST. A Video API da Vonage utiliza WebRTC para comunicações de áudio e vídeo.

Todos os aplicativos desenvolvidos com a plataforma Vonage Video API exigem dois componentes principais:

  • O Cliente — código do lado do cliente que é executado em um navegador ou aplicativo móvel, configurado pelo desenvolvedor por meio das bibliotecas do lado do cliente da Video API da Vonage, que estão disponíveis para Web, iOS, Android, Windows, macOS, Linux, e React Native. O lado do cliente é responsável pela maior parte das funcionalidades da Video API da Vonage.
  • O servidor — código do lado do servidor executado em um servidor web configurado pelo desenvolvedor por meio dos SDKs de servidor da Video API da Vonage, que estão disponíveis para Nó, PHP, Java, .NET, Python, e Ruby.

Funções do cliente e do servidor

Cliente:

Servidor de aplicativos:

Sessão:

  • "Sala de bate-papo" na nuvem da Video API da Vonage
  • Conecta os clientes entre si
  • Envia eventos aos clientes

Sessões

Todas as conversas por vídeo da Video API da Vonage ocorrem dentro de um sessão. Você pode pensar em uma sessão como uma “sala” onde os clientes podem interagir uns com os outros em tempo real. As sessões são hospedadas no Video API da Vonage na nuvem e gerenciar usuários conexões, áudio e vídeo correntes, e usuário eventos (como, por exemplo, a cadastro de um novo usuário). Cada sessão está associada a um ID da sessão. Para permitir que vários clientes conversem entre si, basta fazer com que eles se conectem à mesma sessão (usando o mesmo ID de sessão).

O servidor de aplicativos (que executa o código do lado do servidor) é responsável por criar novas sessões e gerar autenticação exclusiva fichas para cada novo cliente. O cliente, então, usa esse token para estabelecer uma conexão com a sessão. Os clientes conectados a uma sessão podem publicar transmite para a sessão e inscrever-se aos fluxos de outros clientes. Para obter mais informações sobre como os clientes se conectam a uma sessão, consulte a próxima seção.

Sessões de depuração com o Inspector

Se você quiser visualizar informações sobre uma sessão específica, pode usar Inspetor. Essa ferramenta oferece um detalhamento completo da sessão, incluindo usuários, qualidade, eventos, erros e muito mais. Isso é útil para depuração e para entender melhor o que está acontecendo nas sessões do seu aplicativo.

Conexão, publicação e assinatura

Esta seção apresenta uma descrição visual das etapas necessárias para que dois usuários iniciem uma sessão de bate-papo por vídeo.

Etapa 1: A sessão é criada pelo servidor de aplicativos

Seu servidor de aplicativos, utilizando código de um SDK do servidor da Video API da Vonage, cria uma sessão na nuvem por meio do API REST do Vonage Video API e recebe o ID da sessão. Pense na sessão como uma “sala” onde ocorrerá o bate-papo por vídeo. Neste momento, ela está desocupada.

Etapa 2: Um cliente abre o aplicativo e o servidor gera um token

Quando um usuário carrega seu aplicativo do lado do cliente, desenvolvido com um Client SDK da Video API da Vonage, o cliente (uma página da web ou um aplicativo móvel) recebe informações de sessão do servidor. Isso inclui uma autenticação exclusiva token (a “chave” do cliente) criada pelo servidor do seu aplicativo.

Etapa 3: O cliente se conecta e começa a transmitir para a sessão

O cliente utiliza o ID da sessão e o token para estabelecer uma conexão com a sessão. O cliente pode então publicar um sistema de áudio e vídeo fluxo participar da sessão e ficar atento às informações importantes eventos (como, por exemplo, um novo usuário que entra na sessão). Nesse momento, o cliente é o único participante da sessão.

Etapa 4: Um novo cliente se conecta à sessão

Quando um novo usuário carrega o aplicativo do lado do cliente em uma página da web separada ou em um dispositivo móvel (Cliente 2), o novo cliente recebe o ID da sessão e um token exclusivo do servidor do seu aplicativo. O cliente usa essas informações para estabelecer uma conexão com a sessão.

Etapa 5: Os clientes se inscrevem nos fluxos uns dos outros

Agora que está conectado à sessão, o Cliente 2 pode se inscrever no fluxo do Cliente 1. O Cliente 2, então, publica seu próprio fluxo de vídeo na sessão, e o Cliente 1 se inscreve nele. Ambos os clientes estão agora inscritos nos fluxos um do outro em um bate-papo por vídeo um a um, e ambos estão “à espera” de novos eventos (como um novo usuário se conectando à sessão).

A Video API da Vonage oferece suporte à comunicação individual e em grupo. Vários clientes podem se conectar a uma sessão, e cada um deles pode se inscrever em cada transmissão da sessão. Além das funcionalidades básicas mencionadas acima, a plataforma da Video API da Vonage oferece uma variedade de recursos adicionais, tais como compartilhamento de tela, arquivamento, bate-papo por mensagens de texto, transmissão, entre outros. Para conhecer o conjunto completo de recursos oferecidos, consulte o guias para desenvolvedores.

Criação de um aplicativo com a Video API da Vonage

Depois de analisar os materiais acima, você deve ter uma compreensão básica de como funciona a Video API da Vonage. Se estiver pronto para começar a desenvolver seu primeiro aplicativo, confira o Tutorial Básico do Cliente para web, iOS, Android, Windows ou Linux:

Ver tutoriais básicos do cliente

Você também pode encontrar abaixo uma lista de termos-chave e definições, juntamente com uma lista de outros Recursos do Centro de Desenvolvedores.

Termos-chave

Sessão

Você pode pensar em uma sessão como uma “sala” onde clientes podem interagir entre si em tempo real — associadas a um ID de sessão exclusivo. Novas sessões são geradas pelo seu servidor de aplicativos por meio do SDKs de servidor. Os clientes podem obter o ID da sessão e uma autenticação exclusiva token do servidor para inicializar e conectar-se à sessão, após o que eles poderão publicar correntes e inscrever-se para os fluxos na sessão, bem como ouvir eventos enviado pela sessão (como, por exemplo, quando um novo usuário se conecta).

Confira nosso guias para desenvolvedores para aprender a criar uma sessão com os SDKs do servidor, participar de uma sessão com o SDKs de cliente, e explore mais funcionalidades relacionadas às sessões. Para obter informações sobre classes, métodos e eventos específicos associados às sessões, consulte nossa documentação de referência da API para Web, iOS, Android, Windows, e Linux.

Token

Um token é uma “chave” de autenticação exclusiva que permite que um cliente para participar de um sessão. Quando um cliente tenta participar de uma sessão, o seu servidor de aplicativos gera um token exclusivo e o envia ao cliente juntamente com o ID da sessão. Os tokens têm datas de validade (especificadas pelo servidor), enquanto as sessões nunca expiram. Também é possível atribuir funções aos tokens — editora, assinante, ou moderador, que determinam as permissões do usuário, como a publicação correntes e se inscrever em canais durante a sessão.

Confira nosso guias para desenvolvedores para aprender a criar um token com o SDKs de servidor e participar de uma sessão com o SDKs de cliente. Ao criar uma demonstração ou uma prova de conceito, você pode gerar tokens na Video API do Vonage Account criando um projeto, acessando a Visão Geral do Projeto e rolando a tela até as ferramentas do projeto, mas é necessário configurar um componente de servidor antes de entrar em produção.

Cliente

Um cliente é qualquer navegador ou aplicativo móvel que utilize código do lado do cliente da Video API da Vonage SDKs de cliente. O cliente é um dos dois componentes principais que compõem um aplicativo da Video API da Vonage (sendo o outro o servidor), e é responsável pela maior parte das funcionalidades da Video API da Vonage, tais como conectando-se a uma sessão, publicação e assinando para correntes, em escuta para a sessão eventos, e o envio de eventos para a sessão.

Antes de poder interagir com uma sessão, o cliente deve receber o ID da sessão e token gerados pelo seu servidor de aplicativos. Confira nosso Tutorial básico do cliente para aprender como implementar funcionalidades no lado do cliente, bem como nosso guias para desenvolvedores para mais informações.

Servidor

O servidor de aplicativos, configurado pelo desenvolvedor do aplicativo usando o SDKs do servidor da Video API da Vonage, gera novos sessões e fichas, que em seguida envia para o cliente. Todas as Applications da Video API da Vonage exigem um componente cliente e um componente servidor. Confira nosso guias para desenvolvedores para aprender a criar uma sessão e criar um token com os SDKs do servidor, bem como outras funcionalidades gerenciadas pelo servidor.

Conexão

A cliente interage com o sessão por meio de uma conexão de eventos (ou sinalização) persistente, que utiliza WebSockets para ficar constantemente à espera de novos eventos enviada pela sessão. Essa conexão é diferente das conexões de mídia WebRTC estabelecidas quando os clientes publicar e inscrever-se para correntes na sessão.

Para estabelecer uma conexão com uma sessão, o cliente deve receber um ID de sessão e token do seu servidor de aplicativos, que são então utilizados para autenticação. Cada cliente geralmente abre uma única conexão com uma determinada sessão, e cada conexão do cliente com a sessão está associada a um ID de conexão exclusivo. Confira nosso guias para desenvolvedores para aprender a conectar-se a uma sessão com o SDKs de cliente.

Transmissão

Um stream é um único sinal de áudio e vídeo, que inclui a transmissão da câmera e do microfone publicada por um usuário. Durante um sessão, clientes publicar transmite para a sessão e inscrever-se para os fluxos de outros clientes. Quando um novo fluxo é criado, um evento é enviado tanto pelo Objeto Publisher e Objeto de sessão.

Publicar

Certa vez, um cliente é conectado para um sessão, pode publicar um áudio-vídeo fluxo à sessão usando a webcam e o microfone do dispositivo. O cliente token função (editor, assinante, moderador) determina se esse cliente pode publicar na sessão. Isso permite sessões com apenas um ou dois publicadores, mas muitos assinantes (um para muitos). Confira nosso guias para desenvolvedores para aprender a publicar um stream para uma sessão com o SDKs de cliente.

Inscreva-se

Certa vez, um cliente é conectado para um sessão, ele pode se inscrever em qualquer canal de áudio e vídeo correntes publicado por outros clientes na sessão. Confira nosso guias para desenvolvedores para aprender a inscrever-se em canais em uma sessão com o SDKs de cliente.

Eventos

Certa vez, um cliente estabelece um conexão para um sessão, ele é capaz de monitorar os eventos disparados pela sessão. Os eventos são disparados por diversos motivos, como a criação de um novo fluxo ou a conexão ou desconexão de um novo cliente da sessão. Se você quiser que um cliente reaja a um determinado evento, é necessário configurar um ouvinte de eventos. Para obter informações sobre os diversos eventos que podem ocorrer durante uma sessão e como lidar com eles, consulte o Client SDK documentos de referência para web (JavaScript), iOS, Android, Windows, e Linux.

Client SDK

Os SDKs para clientes são um conjunto de bibliotecas de código disponíveis para web (JavaScript), iOS, Android, Windows, e Linux, usado para configurar o cliente. O código do lado do cliente lida com a maior parte das funcionalidades da Video API da Vonage, incluindo publicação e assinando para correntes na sessão e aguardando a sessão eventos.

SDK do servidor

Os SDKs do servidor são um conjunto de wrappers para o API REST do Vonage Video API disponível para Nó, PHP, Java, .NET, Python, e Ruby. Esse código está configurado no seu servidor de aplicativos e é usado para gerar novos sessões e fichas para o cliente.

API REST do Vonage Video API

A Video API da Vonage é uma interface HTTP com o Video API da Vonage na Nuvem usado para criar sessões e lidar com recursos avançados, como arquivamento e transmissão. A Video API da Vonage SDKs de servidor implementar muitos dos métodos da API REST. Confira o Documentação de referência da API REST para conhecer os diversos métodos disponíveis.

Video API da Vonage na Nuvem — gerencia sessões, cliente conexões, chamadas de API, sinalização, eventos, e praticamente tudo o mais que não é tratado pelo SDKs de cliente ou SDKs de servidor.

Recursos do Centro de Desenvolvedores

O artigo que você está lendo, juntamente com toda a restante documentação da Video API da Vonage, faz parte da Centro de Desenvolvedores da Video API da Vonage. O Centro de Desenvolvedores tem como objetivo fornecer tudo o que um desenvolvedor precisa para criar e manter com sucesso um aplicativo da Video API da Vonage.

Aqui estão alguns dos recursos disponíveis no Centro de Desenvolvedores:

Olá, mundo — uma rápida demonstração das funcionalidades mais básicas da Video API da Vonage

Tutoriais — guias passo a passo sobre como criar um aplicativo com a Video API da Vonage e adicionar recursos avançados

Exemplos de código — uma lista de repositórios do GitHub com aplicativos de exemplo para ajudá-lo a desenvolver com mais rapidez

Incorporações de bate-papo por vídeo — a maneira mais rápida de integrar as funcionalidades da Video API da Vonage ao seu site com o mínimo de código

Guias para desenvolvedores — documentação completa sobre todos os recursos e funcionalidades da Video API da Vonage

Referência do Client SDK para Web, iOS, Android, Windows, Linux — informações sobre classes, métodos e eventos específicos utilizados pelos SDKs do cliente

Documentação de referência da API REST — um guia para o uso da Video API do Vonage e dos SDKs de servidor

Ferramentas para desenvolvedores — ferramentas úteis para depurar sessões, testar chamadas de API e muito mais

Programas Beta — uma página que lista todas as versões beta públicas da Video API da Vonage e explica como participar delas

Como obter ajuda

Se você tiver alguma dúvida ou enfrentar algum problema e não conseguir encontrar a resposta no Centro de Desenvolvedores, você pode visite nossa central de suporte para entrar em contato com nossa equipe de suporte ou consultar as perguntas mais frequentes.