OpenTok

java.lang.Object

com.opentok.OpenTok

classe pública OpenTok estende Objeto

Contém métodos para criar sessões do OpenTok, gerar tokens e trabalhar com arquivos.

Para criar um novo objeto OpenTok, chame o construtor do OpenTok com sua chave de API do OpenTok e o segredo da API do seu Account da Video API da Vonage. Não compartilhe publicamente seu segredo da API. Você o utilizará com o construtor do OpenTok (apenas no seu servidor web ) para criar sessões do OpenTok.

Certifique-se de incluir todo o SDK do servidor OpenTok no seu servidor web.

Resumo das classes aninhadas

Classes aninhadas

Modificador e Tipo

Classe

Descrição

static class

OpenTok.Builder

Usado para criar um objeto OpenTok com configurações avançadas.

Resumo do Construtor

Construtores

Construtor

Descrição

OpenTok(int apiKey, String apiSecret)

Cria um objeto OpenTok.

OpenTok(String applicationId, Path privateKeyPath)

Cria um objeto OpenTok para uso com o Video API da Vonage.

Resumo do método

Todos os métodosMétodos de instânciaMétodos concretos

Modificador e Tipo

Método

Descrição

void

addArchiveStream(String archiveId, String streamId, boolean hasAudio, boolean hasVideo)

Adiciona uma transmissão a um arquivo do OpenTok.

void

addBroadcastStream(String broadcastId, String streamId, boolean hasAudio, boolean hasVideo)

Adiciona uma transmissão a uma transmissão em massa do Opentok.

void

close()

Chame este método quando terminar de usar o objeto OpenTok, para evitar que descritores de arquivo fiquem pendentes.

AudioConnector

connectAudioStream(String sessionId, String token, AudioConnectorProperties properties)

Enviar áudio de uma sessão da Video API da Vonage para um WebSocket.

Session

createSession()

Cria uma sessão do OpenTok com as configurações padrão:

Session

createSession(SessionProperties properties)

Cria uma nova sessão do OpenTok.

void

deleteArchive(String archiveId)

Exclui um arquivo do OpenTok.

Sip

dial(String sessionId, String token, SipProperties properties)

Liga para um gateway SIP para conectá-lo a uma sessão do OpenTok.

void

disableForceMute(String sessionId)

Desativa o estado de mudo ativo da sessão.

void

forceDisconnect(String sessionId, String connectionId)

Desconectar um cliente de uma sessão do OpenTok

void

forceMuteAll(String sessionId, MuteAllProperties properties)

Obliga todas as transmissões (exceto um array opcional de transmissões) em uma sessão a silenciar o áudio publicado.

void

forceMuteStream(String sessionId, String streamId)

Forçar o emissor de uma transmissão específica a silenciar o áudio.

String

generateToken(String sessionId)

Cria um token para se conectar a uma sessão do OpenTok, utilizando as configurações padrão.

String

generateToken(String sessionId, TokenOptions tokenOptions)

Cria um token para se conectar a uma sessão do OpenTok.

Archive

getArchive(String archiveId)

Obtém um Archive objeto correspondente ao ID de arquivo fornecido.

Broadcast

getBroadcast(String broadcastId)

Obtém um Broadcast objeto correspondente ao ID de transmissão fornecido.

Render

getRender(String renderId)

Obtém um objeto Render, com detalhes sobre um Experience Composer.

Stream

getStream(String sessionId, String streamId)

Obtém um Stream objeto correspondente ao ID da sessão e ao ID do fluxo fornecidos.

ArchiveList

listArchives()

Retorna uma lista de Archive objetos, representando arquivos que estão tanto concluídos quanto em andamento, para sua chave de API.

ArchiveList

listArchives(int offset, int count)

Retorna uma lista de Archive objetos, representando arquivos que estão tanto concluídos quanto em andamento, para sua chave de API.

ArchiveList

listArchives(String sessionId)

Retorna uma lista de Archive objetos, representando arquivos que estão tanto concluídos quanto em andamento, para sua chave de API.

ArchiveList

listArchives(String sessionId, int offset, int count)

Retorna uma lista de Archive objetos, representando arquivos que estão tanto concluídos quanto em andamento, para sua chave de API.

List<Render>

listRenders()

Obtém uma lista de objetos Render, que representam os Experience Composers associados ao projeto OpenTok.

List<Render>

listRenders(Integer offset, Integer count)

Obtém uma lista de objetos Render, que representam uma lista de Experience Composers associados ao projeto OpenTok.

StreamList

listStreams(String sessionId)

Obtém uma lista de Stream objetos correspondentes ao ID da sessão especificado.

void

playDTMF(String sessionId, String dtmfDigits)

Enviar dígitos DTMF para todos os clientes em uma sessão.

void

playDTMF(String sessionId, String connectionId, String dtmfDigits)

Enviar dígitos DTMF a um cliente específico em uma sessão.

void

removeArchiveStream(String archiveId, String streamId)

Remove um stream de um arquivo do Opentok.

void

removeBroadcastStream(String broadcastId, String streamId)

Remove uma transmissão de uma transmissão ao vivo do Opentok.

void

setArchiveLayout(String archiveId, ArchiveProperties properties)

Define o tipo de layout para um arquivo composto.

void

setBroadcastLayout(String broadcastId, BroadcastProperties properties)

Define o tipo de layout para a transmissão.

void

setStreamLayouts(String sessionId, StreamListProperties properties)

Define a lista de classes de layout para fluxos em uma sessão.

void

signal(String sessionId, SignalProperties props)

Envia um sinal a todos os clientes conectados a uma sessão.

void

signal(String sessionId, String connectionId, SignalProperties props)

Envia um sinal a um cliente específico conectado a uma sessão.

Archive

startArchive(String sessionId)

Archive

startArchive(String sessionId, ArchiveProperties properties)

Inicia o arquivamento de uma sessão do OpenTok.

Archive

startArchive(String sessionId, String name)

Broadcast

startBroadcast(String sessionId, BroadcastProperties properties)

Inicia uma transmissão ao vivo para uma sessão do OpenTok.

Caption

startCaptions(String sessionId, String token, CaptionProperties properties)

Use a API Live Captions para transcrever fluxos de áudio e gerar legendas em tempo real para seu aplicativo.

Render

startRender(String sessionId, String token, RenderProperties properties)

Inicia uma renderização do Experience Composer para uma sessão do OpenTok.

Archive

stopArchive(String archiveId)

Interrompe um arquivo do OpenTok que está sendo gravado.

Broadcast

stopBroadcast(String broadcastId)

Interrompe uma transmissão ao vivo de uma sessão do OpenTok.

void

stopCaptions(String captionsId)

Use este método para interromper as legendas em tempo real de uma sessão.

void

stopRender(String renderId)

Encerra um Experience Composer de uma sessão do OpenTok.

Métodos herdados da classe java.lang.Objeto

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Detalhes do construtor

OpenTok

public OpenTok(int apiKey, String apiSecret)

Cria um objeto OpenTok.

Parâmetros: : apiKey - Sua chave da API do OpenTok. (Consulte sua Página da conta da Video API da Vonage.) : apiSecret - Seu segredo da API do OpenTok. (Consulte seu Página da conta da Video API da Vonage.)

OpenTok

public OpenTok(String applicationId, Caminho privateKeyPath)

Cria um objeto OpenTok para uso com o Video API da Vonage. Esta medida visa ser um passo de curto prazo rumo à migração completa para a Vonage. Consulte o Guia de transição do Java SDK para mais detalhes.

Parâmetros: : applicationId - O UUID do seu aplicativo Vonage com os recursos de vídeo ativados. : privateKeyPath - Caminho absoluto para a chave privada do seu aplicativo.

Desde: : 4.15.0

Detalhes do método

gerarToken

público String generateToken(String sessionId, Opções de tokens tokenOptions) lança Exceção OpenTok

Cria um token para se conectar a uma sessão do OpenTok. Para autenticar um usuário que está se conectando a uma sessão do OpenTok, o cliente envia um token ao se conectar à sessão.

O exemplo a seguir mostra como obter um token com a função “assinante” e que contenha uma string de metadados de conexão:


 import com.opentok.Role;
 import com.opentok.TokenOptions;

 class Test {
     public static void main(String args[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key (see https://tokbox.com/account).
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         //Generate a basic session. Or you could use an existing session ID.
         String sessionId = System.out.println(sdk.createSession());

         // Replace with meaningful metadata for the connection.
         String connectionMetadata = "username=Bob,userLevel=4";

         // Use the Role value appropriate for the user.
         String role = Role.SUBSCRIBER;

         // Generate a token:
         TokenOptions options = new TokenOptions.Buider().role(role).data(connectionMetadata).build();
         String token = sdk.generateToken(sessionId, options);
         System.out.println(token);
     }
 }

Para fins de teste, você também pode gerar tokens fazendo login na sua Account da Video API da Vonage.

Parâmetros: : sessionId - O ID da sessão correspondente à sessão à qual o usuário se conectará. : tokenOptions - Este objeto TokenOptions define as opções do token. Entre elas estão as seguintes:

- The role of the token (subscriber, publisher, or moderator)
- The expiration time of the token
- Connection data describing the end-user

Retorna: : A string do token.

Arremessos: : OpenTokException

gerarToken

público String generateToken(String sessionId) lança Exceção OpenTok

Cria um token para se conectar a uma sessão do OpenTok, utilizando as configurações padrão. As configurações padrão são as seguintes:

Ao token é atribuída a função de editor.
O token expira 24 horas após sua criação.
O token não contém dados de conexão.

O exemplo a seguir mostra como gerar um token com as configurações padrão:


 import com.opentok.OpenTok;

 class Test {
     public static void main(String argv[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key (see https://tokbox.com/account).
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         //Generate a basic session. Or you could use an existing session ID.
         String sessionId = System.out.println(sdk.createSession().getSessionId());

         String token = sdk.generateToken(sessionId);
         System.out.println(token);
     }
 }

Parâmetros: : sessionId - O ID da sessão correspondente à sessão à qual o usuário se conectará.

Retorna: : A string do token.

Arremessos: : OpenTokException

Veja também: : - generateToken(String, TokenOptions)

createSession

público Sessão createSession(Propriedades da sessão propriedades) lança Exceção OpenTok

Cria uma nova sessão do OpenTok.

Por exemplo, ao usar a biblioteca OpenTok.js, utilize o ID da sessão ao chamar o OT.initSession() método (para inicializar uma sessão do OpenTok).

As sessões do OpenTok não expiram. No entanto, os tokens de autenticação expiram (consulte o generateToken(String, TokenOptions) (método). Observe também que as sessões não podem ser encerradas explicitamente.

Uma sequência de caracteres de ID de sessão pode ter até 255 caracteres.

A chamada a este método resulta em um OpenTokException no caso de ocorrer um erro. Verifique a mensagem de erro para obter mais detalhes.

O código a seguir cria uma sessão que tenta enviar fluxos diretamente entre os clientes (recorrendo ao servidor TURN do OpenTok para retransmitir os fluxos caso os clientes não consigam se conectar):


 import com.opentok.MediaMode;
 import com.opentok.OpenTok;
 import com.opentok.Session;
 import com.opentok.SessionProperties;

 class Test {
     public static void main(String argv[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key.
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         SessionProperties sp = new SessionProperties().Builder()
           .mediaMode(MediaMode.RELAYED).build();

         Session session = sdk.createSession(sp);
         System.out.println(session.getSessionId());
     }
 }

Você também pode criar uma sessão usando o OpenTok API REST ou fazendo login na sua Account da Video API da Vonage.

Parâmetros: : properties - Este objeto SessionProperties define as opções da sessão. Entre elas estão as seguintes:

- Whether the session's streams will be transmitted directly between peers or
  using the OpenTok Media Router.
- A location hint for the location of the OpenTok server to use for the session.

Retorna: : Um objeto Session que representa a nova sessão. Chame o getSessionId() método do objeto Session para obter o ID da sessão, que identifica de forma exclusiva a sessão. Você utilizará esse ID da sessão nos SDKs do cliente para identificar a sessão.

Arremessos: : OpenTokException

createSession

público Sessão createSession() lança Exceção OpenTok

Cria uma sessão do OpenTok com as configurações padrão:

O modo de mídia é “retransmitido”. A sessão tentará transmitir fluxos diretamente entre os clientes. Se dois clientes não conseguirem enviar e receber os fluxos um do outro, devido a firewalls nas redes dos clientes, seus fluxos serão retransmitidos por meio do servidor TURN da OpenTok.
A sessão utiliza o primeiro cliente que se conecta para determinar a localização do servidor OpenTok a ser utilizado.

O exemplo a seguir cria uma sessão que utiliza as configurações padrão:


 import com.opentok.OpenTok;
 import com.opentok.SessionProperties;

 class Test {
     public static void main(String argv[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key.
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         String sessionId = sdk.createSession();
         System.out.println(sessionId);
     }
 }

Arremessos: : OpenTokException

Veja também: : - createSession(SessionProperties)

sinal

public void sinal(String sessionId, Propriedades do Sinal adereços) lança Exceção OpenTok

Envia um sinal a todos os clientes conectados a uma sessão.

Para obter mais informações, consulte o Guia do desenvolvedor de sinalização.

Parâmetros: : sessionId - O ID da sessão. : props - O objeto SignalProperties que define os dados e o tipo do sinal.

Arremessos: : OpenTokException

sinal

public void sinal(String sessionId, String connectionId, Propriedades do Sinal adereços) lança Exceção OpenTok

Envia um sinal a um cliente específico conectado a uma sessão.

Para obter mais informações, consulte o Guia do desenvolvedor de sinalização.

Parâmetros: : sessionId - O ID da sessão. : connectionId - O ID da conexão do cliente que receberá o sinal. : props - O objeto SignalProperties que define os dados e o tipo do sinal.

Arremessos: : OpenTokException

getArchive

público Arquivo getArchive(String archiveId) lança Exceção OpenTok

Obtém um Archive objeto correspondente ao ID de arquivo fornecido.

Parâmetros: : archiveId - O ID do arquivo.

Retornos: : O Archive objeto.

Arremessos: : OpenTokException

lista de arquivos

público Lista de arquivos listArchives() lança Exceção OpenTok

Retorna uma lista de Archive objetos, representando arquivos que estão tanto concluídos quanto em andamento, para sua chave de API. Essa lista é limitada a 1.000 arquivos, começando pelo primeiro arquivo registrado. Para um intervalo específico de arquivos, chame listArchives(int offset, int count).

Retornos: : Uma lista de Archive objetos.

Arremessos: : OpenTokException

lista de arquivos

público Lista de arquivos listArchives(String sessionId) lança Exceção OpenTok

Retorna uma lista de Archive objetos, representando arquivos que estão tanto concluídos quanto em andamento, para sua chave de API.

Parâmetros: : sessionId - O ID da sessão que iniciou ou ativou automaticamente o arquivamento. Se a sessão for nula ou estiver vazia, ela será omitida.

Retornos: : Uma lista de Archive objetos.

Arremessos: : OpenTokException

lista de arquivos

público Lista de arquivos listArchives(int offset, int count) throws Exceção OpenTok

Retorna uma lista de Archive objetos, representando arquivos que estão tanto concluídos quanto em andamento, para sua chave de API.

Parâmetros: : offset - O deslocamento de índice do primeiro arquivo. 0 é o deslocamento do arquivo iniciado mais recentemente . 1 é o deslocamento do arquivo iniciado antes do arquivo mais recente. : count - O número de arquivos a serem retornados. O número máximo de arquivos retornados é 1.000.

Retornos: : Uma lista de Archive objetos.

Arremessos: : OpenTokException

lista de arquivos

público Lista de arquivos listArchives(String sessionId, int offset, int count) lança Exceção OpenTok

Retorna uma lista de Archive objetos, representando arquivos que estão tanto concluídos quanto em andamento, para sua chave de API.

Retornos: : Uma lista de Archive objetos.

Arremessos: : OpenTokException

iniciarArquivo

público Arquivo startArchive(String sessionId, Propriedades do arquivo propriedades) lança Exceção OpenTok

Inicia o arquivamento de uma sessão do OpenTok. Esta versão do startArchive() método permite desativar a gravação de áudio ou vídeo.

Os clientes devem estar ativamente conectados à sessão do OpenTok para que você consiga iniciar a gravação de um arquivo.

É possível gravar apenas um arquivo por vez para uma determinada sessão. Só é possível gravar arquivos de sessões que utilizem o OpenTok Media Router (sessões com o modo de mídia (definido como “routed”); não é possível arquivar sessões com o modo de mídia definido como “relayed”.

Para obter mais informações sobre arquivamento, consulte o Arquivamento do OpenTok guia do desenvolvedor.

Parâmetros: : sessionId - O ID da sessão do OpenTok a ser arquivada. : properties - Este objeto ArchiveProperties define as opções do arquivo.

Retorna: : O objeto Archive. Esse objeto inclui propriedades que definem o arquivo, incluindo o ID do arquivo.

Arremessos: : OpenTokException

iniciarArquivo

público Arquivo startArchive(String sessionId) lança Exceção OpenTok

Arremessos: : OpenTokException

iniciarArquivo

público Arquivo startArchive(String sessionId, String nome) lança Exceção OpenTok

Arremessos: : OpenTokException

stopArchive

público Arquivo stopArchive(String archiveId) lança Exceção OpenTok

Interrompe um arquivo do OpenTok que está sendo gravado.

Os arquivos param automaticamente de gravar após 120 minutos ou quando todos os clientes se desconectarem da sessão que está sendo arquivada.

Parâmetros: : archiveId - O ID do arquivo cuja gravação você deseja interromper.

Retorna: : O objeto Archive correspondente ao arquivo que está sendo interrompido.

Arremessos: : OpenTokException

excluirArquivo

public void excluirArquivo(String archiveId) lança Exceção OpenTok

Exclui um arquivo do OpenTok.

Só é possível excluir um arquivo cujo status seja “disponível” ou “carregado”. A exclusão de um arquivo remove seu registro da lista de arquivos. No caso de um arquivo “disponível”, isso também remove o arquivo em si, tornando-o indisponível para download.

Parâmetros: : archiveId - O ID do arquivo que você deseja excluir.

Arremessos: : OpenTokException

addArchiveStream

public void adicionarFluxoDeArquivo(String archiveId, String streamId, boolean hasAudio, boolean hasVideo) lança exceção Exceção OpenTok

Adiciona uma transmissão a um arquivo do OpenTok.

Esse método só funciona para um arquivo que tenha um Archive.StreamMode definir para StreamMode.MANUAL.

Você pode chamar esse método repetidamente com o mesmo ID de stream para ativar e desativar o áudio ou o vídeo, com base no hasAudio e hasVideo valores dos parâmetros.

Parâmetros: : archiveId - O ID do arquivo. : streamId - O ID da transmissão. : hasAudio - Se o áudio da transmissão deve estar ativado no arquivo. : hasVideo - Se o vídeo da transmissão deve estar habilitado no arquivo.

Arremessos: : OpenTokException

removeArchiveStream

public void removeArchiveStream(String archiveId, String streamId) lança Exceção OpenTok

Remove um stream de um arquivo do Opentok.

Esse método só funciona para um arquivo que tenha um Archive.StreamMode definir para StreamMode.MANUAL.

Parâmetros: : archiveId - O ID do arquivo. : streamId - O ID do stream.

Arremessos: : OpenTokException

setArchiveLayout

public void setArchiveLayout(String archiveId, Propriedades do arquivo propriedades) lança Exceção OpenTok

Define o tipo de layout para um arquivo composto. Para obter uma descrição dos tipos de layout, consulte Personalização do layout do vídeo para arquivos compostos.

Parâmetros: : archiveId - {String} O ID do arquivo. : properties - O objeto ArchiveProperties que define o layout do arquivo.

Arremessos: : OpenTokException

iniciarTransmissão

público Transmissão startBroadcast(String sessionId, BroadcastProperties propriedades) lança Exceção OpenTok

Inicia uma transmissão ao vivo para uma sessão do OpenTok. Isso transmite a sessão para um fluxo HLS (HTTP Live Streaming) ou para fluxos RTMP.

Para iniciar com sucesso a transmissão de uma sessão, é necessário que pelo menos um cliente esteja conectado à sessão.

É possível ter apenas uma transmissão ao vivo ativa por vez para uma sessão (no entanto, ter mais de uma não seria útil). A transmissão ao vivo pode ser direcionada a um endpoint HLS e a até cinco servidores RTMP simultaneamente para uma sessão. Você só pode iniciar a transmissão ao vivo para sessões que utilizem o OpenTok Media Router (com o modo de mídia definido como “routed”); não é possível usar a transmissão ao vivo com sessões que tenham o modo de mídia definido como “relayed OpenTok Media Router”. Consulte O OpenTok Media Router e os modos de mídia.

Para obter mais informações sobre transmissão, consulte o Guia do desenvolvedor de transmissões.

Parâmetros: : sessionId - O ID da sessão do OpenTok a ser transmitida. : properties - O objeto BroadcastProperties define as opções para a transmissão.

Retorna: : O objeto Broadcast. Esse objeto inclui propriedades que definem a transmissão, incluindo o ID da transmissão.

Arremessos: : OpenTokException

stopBroadcast

público Transmissão stopBroadcast(String broadcastId) lança Exceção OpenTok

Interrompe uma transmissão ao vivo de uma sessão do OpenTok. Observe que as transmissões são interrompidas automaticamente 120 minutos após o início.

Para obter mais informações sobre transmissão, consulte o Guia do desenvolvedor de transmissões.

Parâmetros: : broadcastId - O ID da transmissão da sessão de transmissão

Retorna: : O objeto Broadcast. Esse objeto inclui propriedades que definem o arquivo, incluindo o ID do arquivo.

Arremessos: : OpenTokException

getBroadcast

público Transmissão getBroadcast(String broadcastId) lança Exceção OpenTok

Obtém um Broadcast objeto correspondente ao ID de transmissão fornecido.

Parâmetros: : broadcastId - O ID da transmissão.

Retornos: : O Broadcast objeto.

Arremessos: : OpenTokException

setBroadcastLayout

public void setBroadcastLayout(String broadcastId, BroadcastProperties propriedades) lança Exceção OpenTok

Define o tipo de layout para a transmissão. Para obter uma descrição dos tipos de layout, consulte Configurando o layout de vídeo para transmissões ao vivo pelo OpenTok.

Parâmetros: : broadcastId - {String} O ID da transmissão. : properties - Este objeto BroadcastProperties define as opções de layout para a transmissão.

Arremessos: : OpenTokException

addBroadcastStream

public void adicionarFluxoDeTransmissão(String broadcastId, String streamId, boolean hasAudio, boolean hasVideo) lança exceção Exceção OpenTok

Adiciona uma transmissão a uma transmissão em massa do Opentok.

Esse método só funciona para um arquivo que tenha um Archive.StreamMode definir para StreamMode.MANUAL.

Você pode chamar esse método repetidamente com o mesmo ID de stream para ativar e desativar o áudio ou o vídeo, com base no hasAudio e hasVideo valores dos parâmetros.

Parâmetros: : broadcastId - O ID da transmissão. : streamId - O ID da transmissão. : hasAudio - Se o áudio da transmissão deve estar ativado. : hasVideo - Se a transmissão deve ter o vídeo ativado durante a exibição.

Arremessos: : OpenTokException

removeBroadcastStream

public void removeBroadcastStream(String broadcastId, String streamId) lança Exceção OpenTok

Remove uma transmissão de uma transmissão ao vivo do Opentok.

Esse método só funciona para um arquivo que tenha um Archive.StreamMode definir para StreamMode.MANUAL.

Parâmetros: : broadcastId - O ID da transmissão. : streamId - O ID do stream.

Arremessos: : OpenTokException

setStreamLayouts

public void setStreamLayouts(String sessionId, Propriedades da lista de transmissões propriedades) lança Exceção OpenTok

Define a lista de classes de layout para streams em uma sessão. As classes de layout são utilizadas no layout de arquivos compostos e transmissões ao vivo. Para obter mais informações, consulte Personalização do layout do vídeo para arquivos compostos e Configurando o layout de vídeo para transmissões ao vivo pelo OpenTok.

É possível definir a lista inicial de classes de layout para os fluxos publicados por um cliente ao gerar usados pelo cliente. Consulte o generateToken(String, TokenOptions) método.

Parâmetros: : sessionId - {String} O ID da sessão à qual os fluxos pertencem. : properties - Este objeto StreamListProperties define listas de classes para um ou mais fluxos na sessão.

Arremessos: : OpenTokException

forceDisconnect

public void forçarDesconexão(String sessionId, String connectionId) lança Exceção OpenTok

Desconectar um cliente de uma sessão do OpenTok

Use esta API para encerrar à força a conexão de uma sessão.

Parâmetros: : sessionId - O ID da sessão da conexão : connectionId - O ID da conexão a ser desconectada

Arremessos: : OpenTokException

forceMuteStream

public void forçarSilêncioDoFluxo(String sessionId, String streamId) lança Exceção OpenTok

Forçar o emissor de uma transmissão específica a silenciar o áudio.

Para obter mais informações, consulte Silenciar o áudio das transmissões em uma sessão.

Parâmetros: : sessionId - O ID da sessão. : streamId - O ID do stream.

Arremessos: : OpenTokException

Veja também: : - forceMuteAll(String, MuteAllProperties)

forceMuteAll

public void forçarSilêncioEmTodos(String sessionId, Silenciar todas as propriedades propriedades) lança Exceção OpenTok

Obliga todas as transmissões (exceto um array opcional de transmissões) em uma sessão a silenciar o áudio publicado.

Além das transmissões existentes, todas as transmissões publicadas após a chamada deste método são publicadas com o áudio silenciado. É possível remover o estado de silêncio de uma sessão chamando o método OpenTok.disableForceMute() método.

Para obter mais informações, consulte Silenciar o áudio das transmissões em uma sessão.

Parâmetros: : sessionId - O ID da sessão. : properties - Define uma lista de IDs de transmissões que devem ser excluídas da ação de silenciar.

Arremessos: : OpenTokException

Veja também: : - forceMuteStream(String, String) - disableForceMute(String)

desativarForçarSilêncio

public void desativarForçarSilêncio(String sessionId) lança Exceção OpenTok

Desativa o estado de mudo ativo da sessão. Após chamar esse método, os novos streams publicados na sessão não terão mais o áudio silenciado.

Depois de chamar a OpenTok.forceMuteAll() método, todas as transmissões publicadas após a chamada são publicadas com o áudio silenciado. Ao chamar o OpenTok.disableForceMute() Com esse método, as transmissões futuras publicadas na sessão não são silenciadas (mas quaisquer transmissões já silenciadas permanecem silenciadas).

Parâmetros: : sessionId - O ID da sessão.

Arremessos: : OpenTokException

Veja também: : - forceMuteAll(String, MuteAllProperties)

getStream

público Transmissão getStream(String sessionId, String streamId) lança Exceção OpenTok

Obtém um Stream objeto correspondente ao ID da sessão e ao ID do fluxo fornecidos.

Parâmetros: : sessionId - O ID da sessão. : streamId - O ID do stream.

Retornos: : O Stream objeto.

Arremessos: : OpenTokException

listStreams

público Lista de transmissões listStreams(String sessionId) lança Exceção OpenTok

Obtém uma lista de Stream objetos correspondentes ao ID da sessão especificado.

Parâmetros: : sessionId - O ID da sessão.

Retorna: : A lista de Stream objetos.

Arremessos: : OpenTokException

discar

público Um gole discar(String sessionId, String token, SipProperties propriedades) lança Exceção OpenTok

Liga para um gateway SIP para conectá-lo a uma sessão do OpenTok.

Parâmetros: : sessionId - O ID da sessão. : token - Token do OpenTok será usado para o participante que está sendo chamado. É possível adicionar dados ao token para identificar se o participante está em um terminal SIP ou para outros dados de identificação, como números de telefone. (As bibliotecas de cliente do OpenTok incluem propriedades para inspecionar os dados de conexão de um cliente conectado a uma sessão.) Consulte o Guia do desenvolvedor para criação de tokens. : properties - O SipProperties objeto que define as opções para a chamada SIP.

Retornos: : O Sip objeto.

Arremessos: : OpenTokException

reproduzir DTMF

public void reproduzirDTMF(String sessionId, String (dtmfDigits) lança Exceção OpenTok

Enviar dígitos DTMF para todos os clientes em uma sessão.

Parâmetros: : sessionId - O ID da sessão. : dtmfDigits - A sequência de dígitos DTMF a ser enviada. Ela pode incluir 0-9, “*”, “#” e “p”. Um “p” indica uma pausa de 500 ms (caso seja necessário adicionar um atraso no envio dos dígitos).

Arremessos: : OpenTokException

reproduzir DTMF

public void reproduzirDTMF(String sessionId, String connectionId, String (dtmfDigits) lança Exceção OpenTok

Enviar dígitos DTMF a um cliente específico em uma sessão.

Parâmetros: : sessionId - O ID da sessão. : connectionId - O ID da sessão do cliente que receberá os dígitos DTMF. : dtmfDigits - A sequência de dígitos DTMF a ser enviada. Ela pode incluir 0-9, “*”, “#” e “p”. Um “p” indica uma pausa de 500 ms (caso seja necessário adicionar um atraso no envio dos dígitos).

Arremessos: : OpenTokException

connectAudioStream

público AudioConnector connectAudioStream(String sessionId, String token, Propriedades do conector de áudio propriedades) lança Exceção OpenTok

Envie áudio de uma sessão da Video API da Vonage para um WebSocket. Para obter mais informações, consulte o Guia do desenvolvedor do Audio Connector.

Parâmetros: : sessionId - O ID da sessão. : token - O token do OpenTok a ser usado para a conexão do Audio Connector à sessão do OpenTok. É possível adicionar dados ao token para identificar que a conexão é do terminal do Audio Connector ou para outros dados de identificação. : properties - O objeto ConnectProperties define as opções utilizadas na solicitação ao endpoint da API do Audio Connector.

Retorna: : O objeto de resposta do Audio Connect proveniente do servidor.

Arremessos: : OpenTokException

startRender

público Renderizar startRender(String sessionId, String token, Propriedades de renderização propriedades) lança Exceção OpenTok

Inicia uma renderização do Experience Composer para uma sessão do OpenTok. Para obter mais informações, consulte o Guia do desenvolvedor do Experience Composer.

Parâmetros: : sessionId - O ID da sessão. : properties - O RenderProperties objeto que define as propriedades para a chamada do Render.

Retornos: : O Render objeto de resposta.

Arremessos: : OpenTokException

getRender

público Renderizar getRender(String renderId) lança Exceção OpenTok

Obtém um objeto Render, com detalhes sobre um Experience Composer.

Parâmetros: : renderId - O ID do Experience Composer a ser recuperado.

Retornos: : O Render objeto de resposta associado ao ID fornecido.

Arremessos: : OpenTokException

stopRender

public void stopRender(String renderId) lança Exceção OpenTok

Interrompe um Experience Composer de uma sessão do OpenTok. Observe que, por padrão, os Experience Composers são encerrados automaticamente 2 horas após serem iniciados. Você também pode definir um valor diferente para `maxDuration` ao criar o Experience Composer. Quando o Experience Composer é encerrado, um evento é enviado para a URL de retorno de chamada, caso você tenha configurado uma para o projeto.

Parâmetros: : renderId - O ID do Experience Composer a ser interrompido.

Arremessos: : OpenTokException

listRenders

público Lista<Renderizar> listRenders() gera uma exceção Exceção OpenTok

Obtém uma lista de objetos Render, que representam os Experience Composers associados ao projeto OpenTok.

Retorna: : A lista de Render objetos.

Arremessos: : OpenTokException

listRenders

público Lista<Renderizar> listRenders(Inteiro deslocamento, Inteiro contagem) lança Exceção OpenTok

Obtém uma lista de objetos Render, que representam uma lista de Experience Composers associados ao projeto OpenTok.

Parâmetros: : offset - (opcional) Deslocamento inicial na lista de Renders existentes. : count - (opcional) Número de renderizações a serem recuperadas a partir do deslocamento. Máximo de 1.000.

Retorna: : A lista de Render objetos.

Arremessos: : OpenTokException

iniciar legendas

público Legenda startCaptions(String sessionId, String token, Propriedades da legenda propriedades) lança Exceção OpenTok

Use a API do Live Captions para transcrever fluxos de áudio e gerar legendas em tempo real para seu aplicativo. O Live Captions está habilitado por padrão para todos os projetos e é um produto cobrado com base no uso. O recurso Live Captions é compatível apenas com sessões roteadas (sessões que utilizam o OpenTok Media Router). Você pode enviar até 50 fluxos de áudio de uma única sessão da Vonage por vez para o serviço de transcrição para a geração de legendas.

Parâmetros: : sessionId - O ID da sessão do OpenTok. O áudio dos emissores que estão transmitindo para essa sessão será usado para gerar as legendas. : token - Um token válido do OpenTok com a função definida como “Moderador”. : properties - O CaptionProperties objeto que define propriedades opcionais da legenda em tempo real.

Retornos: : A Caption resposta contendo o ID das legendas desta chamada.

Arremessos: : OpenTokException

stopCaptions

public void stopCaptions(String captionsId) lança Exceção OpenTok

Use este método para interromper as legendas em tempo real de uma sessão.

Parâmetros: : captionsId - O ID exclusivo da sessão de legenda de áudio, conforme obtido de Caption.getCaptionsId().

Arremessos: : OpenTokException

fechar

public void close()

Chame este método quando terminar de usar o objeto OpenTok, para evitar que descritores de arquivo fiquem pendentes.