java.lang.Object

java.util.Observable

com.opentok.android.Session


classe pública Session estende Observável

Representa uma sessão do OpenTok da qual o cliente está participando. O primeiro passo para usar o SDK do OpenTok para Android é inicializar uma instância de Session chamando o construtor Session().

Ao criar a instância da Session, você passa o ID da sessão do OpenTok, o token e a chave de API. Você obtém uma chave de API quando inscreva-se para um Account no OpenTok. Para fins de teste, você pode gerar IDs e tokens de sessão de teste fazendo login na sua Account da Video API da Vonage. Use o Bibliotecas do OpenTok para o lado do servidor para gerar IDs de sessão e tokens no seu aplicativo de entregas.

Veja também: : - Sessão Criação - Token Criação

Resumo das classes aninhadas

Classes aninhadas

Modificador e Tipo

Classe

Descrição

static interface

Session.ArchiveListener

Monitora quando uma gravação de arquivo da sessão começa e termina.

static class

Session.Builder

static class

Session.Capabilities

Define o valor retornado pela função getCapabilities() método.

protected static class

Session.ConfigurableSessionOptions

static interface

Session.ConnectionListener

Monitora quando outros clientes se conectam e se desconectam da sessão.

static interface

Session.MuteListener

Monitora quando um moderador silencia transmissões na sessão ou desativa o estado de silenciamento na sessão.

static interface

Session.ReconnectionListener

Monitora quando um cliente tenta se reconectar automaticamente após perder a conexão com uma sessão do OpenTok.

static interface

Session.SessionListener

Monitora as mudanças de estado em um Session objeto.

static class

Session.SessionOptions

Uma classe base para definir opções avançadas de sessão com o Session.Builder.sessionOptions(Session.SessionOptions sessionOptions) método.

static interface

Session.SessionOptionsProvider

Obsoleto.

static interface

Session.SignalListener

Monitora quando um sinal é enviado na sessão.

static interface

Session.StreamCaptionsPropertiesListener

Monitora quando as propriedades das legendas das transmissões na sessão são alteradas.

static interface

Session.StreamPropertiesListener

Monitora quando as propriedades dos fluxos na sessão são alteradas.

Resumo do campo

Campos

Modificador e Tipo

Campo

Descrição

protected String

apiKey

protected URL

apiUrl

protected Session.ArchiveListener

archiveListener

protected Session.ConnectionListener

connectionListener

protected android.content.Context

context

protected Session.MuteListener

muteListener

protected Session.ReconnectionListener

reconnectionListener

protected String

sessionId

protected Session.SessionListener

sessionListener

protected Session.SignalListener

signalListener

protected Session.StreamCaptionsPropertiesListener

streamCaptionsPropertiesListener

protected Session.StreamPropertiesListener

streamPropertiesListener

Resumo do Construtor

Construtores

Modificador

Construtor

Descrição

protected

Session(Session.Builder builder)

Resumo do método

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

Modificador e Tipo

Método

Descrição

void

connect(String token)

Conecta-se à sessão do OpenTok fornecida no construtor Session, utilizando o token de autenticação fornecido.

void

disableForceMute()

Desativa o estado de mudo ativo da sessão.

void

disconnect()

Desconecta-se desta sessão.

protected void

finalize()

É chamado pelo coletor de lixo quando este determina que não há mais referências ao objeto Session.

void

forceDisconnect(Connection connection)

Obliga um cliente a se desconectar da sessão.

void

forceMuteAll(Iterable<Stream> excludedStreams)

Obliga todos os transmissores na sessão (exceto aqueles que estão transmitindo streams excluídos) a silenciar o áudio.

void

forceMuteStream(Stream stream)

Obliga o emissor de um stream especificado a silenciar seu áudio.

Session.Capabilities

getCapabilities()

Indica se o cliente pode publicar e se inscrever em fluxos na sessão, com base na função atribuída ao token utilizado para se conectar à sessão.

Connection

getConnection()

Retorna o Connection correspondente à conexão desse cliente a esta sessão.

String

getSessionId()

Retorna o ID da sessão passado durante a instanciação.

protected void

onArchiveStarted(String id, String name)

É chamado quando um arquivo da sessão começa a ser gravado.

protected void

onArchiveStopped(String id)

É chamado quando a gravação do arquivo da sessão é interrompida.

protected void

onConnected()

É acionado quando o cliente se conecta à sessão do OpenTok.

protected void

onConnectionCreated(Connection connection)

É chamado quando outro o cliente se conecta à sessão.

protected void

onConnectionDestroyed(Connection connection)

É acionado quando outro cliente sai da sessão.

protected void

onDisconnected()

É acionado quando o cliente não está mais conectado à sessão do OpenTok .

protected void

onError(OpentokError error)

É acionado quando ocorre algum problema ao se conectar ou durante a conexão com a sessão.

protected void

onMuteForced(MuteForcedInfo info)

É acionado quando um moderador silencia as transmissões na sessão ou desativa o estado de silenciamento na sessão.

void

onPause()

Chame este método quando a atividade do aplicativo for pausada.

protected void

onReconnected()

É acionado quando o cliente local se reconecta à sessão do OpenTok após a perda temporária da conexão de rede.

protected void

onReconnecting()

É acionado quando o cliente local perde a conexão com uma sessão do OpenTok e está tentando se reconectar.

void

onResume()

Chame este método quando a atividade do aplicativo for retomada.

protected void

onSignalReceived(String type, String data, Connection connection)

É chamada quando um sinal é recebido na sessão.

protected void

onStreamDropped(Stream stream)

É chamado quando outro o cliente deixa de transmitir para esta sessão do OpenTok.

protected void

onStreamHasAudioChanged(Stream stream, int hasAudio)

É chamado quando um stream na sessão alterna entre ter áudio e não ter áudio.

protected void

onStreamHasCaptionsChanged(Stream stream, int hasCaptions)

É chamado quando uma transmissão na sessão alterna entre ter legendas e não ter legendas.

protected void

onStreamHasVideoChanged(Stream stream, int hasVideo)

É chamado quando uma transmissão na sessão alterna entre ter vídeo e não ter vídeo.

protected void

onStreamReceived(Stream stream)

É acionado quando há um novo stream publicado por outro cliente nesta sessão do OpenTok.

protected void

onStreamVideoDimensionsChanged(Stream stream, int width, int height)

É chamado quando as dimensões do vídeo de um stream na sessão são alteradas.

protected void

onStreamVideoTypeChanged(Stream stream, int videoType)

É chamado quando o tipo de vídeo de um stream na sessão é alterado.

void

publish(PublisherKit publisher)

Inicia um Publisher transmitindo para a sessão.

String

reportIssue()

Relate que seu aplicativo apresentou um problema.

void

sendSignal(String type, String data)

Envia um sinal para todos os clientes em uma sessão.

void

sendSignal(String type, String data, boolean retryAfterReconnect)

Envia um sinal para todos os clientes em uma sessão.

void

sendSignal(String type, String data, Connection connection)

Envia um sinal para um cliente específico em uma sessão.

void

sendSignal(String type, String data, Connection connection, boolean retryAfterReconnect)

Envia um sinal para um cliente específico em uma sessão. Esta versão do método inclui um retryAfterReconnect parâmetro.

void

setArchiveListener(Session.ArchiveListener listener)

Define um Session.ArchiveListener objeto a ser monitorado quando uma gravação de arquivo começa ou termina nesta sessão.

void

setConnectionListener(Session.ConnectionListener listener)

Define um Session.ConnectionListener objeto para monitorar quando outros clientes se conectam e se desconectam desta sessão.

void

setEncryptionSecret(String secret)

Define o segredo de criptografia de ponta a ponta utilizado por todos os emissores e assinantes.

void

setMuteListener(Session.MuteListener listener)

Define um Session.MuteListener objeto a ser monitorado quando o comando “mute forced” for enviado nesta sessão.

void

setReconnectionListener(Session.ReconnectionListener listener)

Define um Session.ReconnectionListener objeto a ser notificado quando o cliente estiver tentando se reconectar ou tiver se reconectado a uma sessão do OpenTok.

void

setSessionListener(Session.SessionListener listener)

Define um Session.SessionListener objeto para monitorar as mudanças de estado deste objeto Session.

void

setSignalListener(Session.SignalListener listener)

Define um Session.SignalListener objeto a ser monitorado quando os sinais forem enviados nesta sessão.

void

setStreamCaptionsPropertiesListener(Session.StreamCaptionsPropertiesListener listener)

Define um Session.StreamCaptionsPropertiesListener objeto para monitorar as propriedades da propriedade “captions” do stream.

void

setStreamPropertiesListener(Session.StreamPropertiesListener listener)

Define um Session.StreamPropertiesListener objeto para monitorar as propriedades dos fluxos nesta sessão à medida que elas mudam.

void

subscribe(SubscriberKit subscriber)

Iniciar a recepção e a reprodução de dados de transmissão de áudio e vídeo para o assinante especificado.

void

unpublish(PublisherKit publisher)

Desconecta o Editor da sessão.

void

unsubscribe(SubscriberKit subscriber)

Interrompe a assinatura (o recebimento de um stream) de um assinante especificado na sessão.

Métodos herdados da classe java.util.Observável

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Métodos herdados da classe java.lang.Objeto

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

Detalhes do campo

sessionListener

protegido  Session.SessionListener sessionListener

connectionListener

protegido  Session.ConnectionListener connectionListener

streamPropertiesListener

protegido  Session.StreamPropertiesListener streamPropertiesListener

streamCaptionsPropertiesListener

protegido  Session.StreamCaptionsPropertiesListener streamCaptionsPropertiesListener

signalListener

protegido  Session.SignalListener signalListener

archiveListener

protegido  Session.ArchiveListener archiveListener

reconnectionListener

protegido  Session.ReconnectionListener reconnectionListener

muteListener

protegido  Session.MuteListener muteListener

contexto

protected android.content.Context context

apiKey

protegido  String apiKey

sessionId

protegido  String sessionId

apiUrl

protegido  URL apiUrl

Detalhes do construtor

Sessão

Session protegida(Session.Builder (construtor) lança Exceção

Arremessos: : Exception

Detalhes do método

getConnection

público  Conexão getConnection()

Retorna o Connection correspondente à conexão desse cliente a esta sessão.

Quando um Stream é criado, o Session.SessionListener.onStreamReceived(Session session, Stream stream) método é chamado. Compare o objeto Connection retornado pelo Stream.getConnection() método com o objeto Connection retornado por Sesssion.getConnection() para verificar se o novo stream foi publicado pelo seu cliente.

Retorna: : O ID da sessão do OpenTok para esta instância.

Veja também: : - Session.SessionListener.onConnected(Session session) - Session.SessionListener.onStreamReceived(Session session, Stream stream) - Stream.getConnection()

getSessionId

público  String getSessionId()

Retorna o ID da sessão passado durante a instanciação.

Retorna: : O ID da sessão do OpenTok para esta instância.

setSessionListener

public void setSessionListener(Session.SessionListener ouvinte)

Define um Session.SessionListener objeto para monitorar as mudanças de estado deste objeto Session.

Parâmetros: : listener - O Session.SessionListener instância.

setConnectionListener

public void setConnectionListener(Session.ConnectionListener ouvinte)

Define um Session.ConnectionListener objeto para monitorar quando outros clientes se conectam e se desconectam desta sessão.

Parâmetros: : listener - O Session.ConnectionListener instância.

setStreamPropertiesListener

public void setStreamPropertiesListener(Session.StreamPropertiesListener ouvinte)

Define um Session.StreamPropertiesListener objeto para monitorar as propriedades dos fluxos nesta sessão à medida que elas mudam. Isso inclui propriedades que indicam se o fluxo contém áudio, se contém vídeo e as dimensões do vídeo.

Parâmetros: : listener - O Session.StreamPropertiesListener instância.

setStreamCaptionsPropertiesListener

public void setStreamCaptionsPropertiesListener(Session.StreamCaptionsPropertiesListener ouvinte)

Define um Session.StreamCaptionsPropertiesListener objeto para monitorar as propriedades da propriedade “captions” do stream.

Parâmetros: : listener - O Session.StreamCaptionsPropertiesListener instância.

setSignalListener

public void setSignalListener(Session.SignalListener ouvinte)

Define um Session.SignalListener objeto a ser monitorado quando os sinais forem enviados nesta sessão.

Parâmetros: : listener - O Session.SignalListener instância.

setArchiveListener

public void setArchiveListener(Session.ArchiveListener ouvinte)

Define um Session.ArchiveListener objeto a ser monitorado quando uma gravação de arquivo começa ou termina nesta sessão.

Parâmetros: : listener - O Session.ArchiveListener instância.

setReconnectionListener

public void setReconnectionListener(Session.ReconnectionListener ouvinte)

Define um Session.ReconnectionListener objeto a ser notificado quando o cliente estiver tentando se reconectar ou tiver se reconectado a uma sessão do OpenTok.

Parâmetros: : listener - O Session.ReconnectionListener instância.

setMuteListener

public void setMuteListener(Session.MuteListener ouvinte)

Define um Session.MuteListener objeto a ser monitorado quando o comando “mute forced” for enviado nesta sessão.

Parâmetros: : listener - O Session.MuteListener instância.

conectar

public void conectar(String (token)

Conecta-se à sessão do OpenTok fornecida no construtor Session, utilizando o token de autenticação fornecido.

Quando a sessão se conecta, o Session.SessionListener.onConnected(Session session) O método é chamado.

Se a sessão não conseguir se conectar, o Session.SessionListener.onError(Session session, OpentokError error) o método é chamado.

Parâmetros: : token - O token do usuário. Consulte Token Visão geral da criação.

desconectar

public void desconectar()

Desconecta desta sessão. Todas as instâncias de Assinante e Editor serão desconectadas. Como prática recomendada, antes de chamar este método, chame o unpublish(PublisherKit) método para todos os editores e aguardar o PublisherKit.onStreamDestroyed(Stream) callback. Isso garante a remoção completa dos editores, especialmente se problemas de conectividade de rede impedirem a remoção devido ao recurso de reconexão, o que pode manter os fluxos dos editores ativos para uma possível reconexão.

Quando a sessão for encerrada, o Session.SessionListener.onDisconnected(Session session) O método é chamado.

onPause

public void onPause()

Chame este método quando a atividade do aplicativo for pausada. Isso pausa o renderizador e o capturador de vídeo de todos os emissores da sessão. Também pausa os renderizadores de vídeo de todos os assinantes.

As câmeras utilizadas pelos editores do OpenTok agora são liberadas quando você chama esse método. Os editores recuperam o controle das câmeras quando você chama o onResume() método.

onResume

public void onResume()

Chame este método quando a atividade do aplicativo for retomada. Isso retoma o renderizador e o capturador de vídeo de qualquer emissor na sessão. Também retoma os renderizadores de vídeo de todos os assinantes.

Quaisquer câmeras (utilizadas pelos editores do OpenTok) que tenham sido lançadas quando você chamou a onPause() Os recursos do método são recuperados quando você chama Session.onResume().

publicar

public void publicar(PublisherKit editora)

Inicia um Publisher transmitindo para a sessão.

Parâmetros: : publisher - O Publisher para o qual você deseja transmitir a sessão.

retirar do ar

public void retirar-da-publicação(PublisherKit editora)

Desconecta o Editor da sessão.

Parâmetros: : publisher - O editor deve retirar a publicação.

inscrever-se

public void subscribe(SubscriberKit assinante)

Iniciar a recepção e a reprodução de dados de transmissão de áudio e vídeo para o assinante especificado.

Parâmetros: : subscriber - O assinante vinculado ao fluxo a ser recebido.

cancelar inscrição

public void cancelarInscrição(SubscriberKit assinante)

Interrompe a assinatura (o recebimento de um stream) de um assinante especificado na sessão.

Parâmetros: : subscriber - O assinante cuja assinatura você deseja cancelar.

sendSignal

public void enviarSinal(String tipo, String dados)

Envia um sinal para todos os clientes em uma sessão.

Parâmetros: : type - O tipo do sinal. O tipo também é definido no Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) método. : data - Os dados a serem enviados. O limite de tamanho dos dados é de 8 kB.

Veja também: : - sendSignal(String type, String data, Connection connection) - sendSignal(String type, String data, boolean retryAfterReconnect) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

sendSignal

public void enviarSinal(String tipo, String dados, booleano retryAfterReconnect)

Envia um sinal a todos os clientes em uma sessão. Esta versão do método inclui um retryAfterReconnect parâmetro.

Parâmetros: : type - O tipo do sinal. O tipo também é definido no Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) método. : data - Os dados a serem enviados. O limite de tamanho dos dados é de 8 kB. : retryAfterReconnect - Ao se reconectar à sessão, se deve enviar quaisquer sinais que tenham sido iniciados enquanto estava desconectado. Se o seu cliente perder a conexão com a sessão do OpenTok, devido a uma queda na conectividade de rede, o cliente tenta se reconectar à sessão, e o Session.ReconnectionListener.onReconnecting(Session session) método é chamado. Por padrão, os sinais gerados enquanto o cliente está desconectado são enviados quando (e se) o cliente se reconectar à sessão do OpenTok. É possível evitar isso definindo o retryAfterReconnect parâmetro para false. (O valor padrão é true.)

Veja também: : - sendSignal(String type, String data) - Session.ReconnectionListener.onReconnecting(Session session) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

sendSignal

public void enviarSinal(String tipo, String dados, Conexão conexão)

Envia um sinal para um cliente específico em uma sessão.

Parâmetros: : type - O tipo do sinal. O tipo também é definido no Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) método. : data - Os dados a serem enviados. O limite de tamanho dos dados é de 8 kB. : connection - Um objeto Connection. O objeto Connection representa a conexão de um cliente à sessão. Esse é o cliente para o qual a mensagem é enviada. (Veja Session.ConnectionListener.onConnectionCreated(Session session, Connection connection) e Connection.

Veja também: : - sendSignal(String type, String data) - sendSignal(String type, String data, Connection connection, boolean retryAfterReconnect) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

sendSignal

public void enviarSinal(String tipo, String dados, Conexão conexão, booleano retryAfterReconnect)

Envia um sinal para um cliente específico em uma sessão. Esta versão do método inclui um retryAfterReconnect parâmetro.

Parâmetros: : type - O tipo do sinal. O tipo também é definido no Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) método. : data - Os dados a serem enviados. O limite de tamanho dos dados é de 8 kB. : connection - Um objeto Connection. O objeto Connection representa a conexão de um cliente à sessão. Esse é o cliente para o qual a mensagem é enviada. (Veja Session.ConnectionListener.onConnectionCreated(Session session, Connection connection) e Connection. : retryAfterReconnect - Ao se reconectar à sessão, se deve enviar quaisquer sinais que tenham sido iniciados enquanto estava desconectado. Se o seu cliente perder a conexão com a sessão do OpenTok, devido a uma queda na conectividade de rede, o cliente tentará se reconectar à sessão, e o Session.ReconnectionListener.onReconnecting(Session session) método é chamado. Por padrão, os sinais gerados enquanto o cliente está desconectado são enviados quando (e se) o cliente se reconectar à sessão do OpenTok. Você pode evitar isso definindo o retryAfterReconnect parâmetro para false. (O valor padrão é true.)

Veja também: : - sendSignal(String type, String data) - sendSignal(String type, String data, Connection connection) - sendSignal(String type, String data, boolean retryAfterReconnect) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

getCapabilities

público  Session.Capabilities getCapabilities()

Indica se o cliente pode publicar e se inscrever em fluxos na sessão, com base na função atribuída ao token utilizado para se conectar à sessão. Este método retorna null até que você tenha se conectado a uma sessão e o Session.SessionListener.onConnected(Session session) O método foi chamado.

relatar problema

público  String reportIssue()

Relate que seu aplicativo apresentou um problema. Você pode usar o ID do problema com o Inspetor ou ao discutir um problema com a equipe de suporte da TokBox.

Retorna: : O ID associado ao problema.

forceDisconnect

public void forceDisconnect(@NonNull Conexão conexão)

Obriga um cliente a se desconectar da sessão. Embora seja possível usar forceDisconnect(Connection) Para encerrar sua conexão, é mais simples chamar o método `disconnect`. É retornado um erro se a função do cliente não incluir as permissões necessárias para forçar outros usuários a se desconectarem. Você define a função de um cliente ao criar o token do usuário. Quando uma conexão é encerrada usando esse método, Session.SessionListener.onDisconnected(Session), onConnectionDestroyed(Connection) e PublisherKit.onStreamDestroyed(Stream) as chamadas de retorno são despachadas da mesma forma que seriam se a conexão tivesse sido encerrada automaticamente por meio de disconnect().

Parâmetros: : connection - A conexão para se desconectar.

forceMuteStream

public void forceMuteStream(@NonNull Transmissão (stream)

Obliga o emissor de um stream especificado a silenciar seu áudio.

Verifique o canForceMute propriedade do objeto retornado pela chamada de getCapabilities() para verificar se você consegue chamar essa função com sucesso. Isso está reservado para clientes que se conectaram com um token ao qual foi atribuída a função de moderador (consulte o Criação de tokens (documentação).

Parâmetros: : stream - O objeto que representa a transmissão para a solicitação de silenciamento forçado. Isso inclui a transmissão que deve ser silenciada.

Veja também: : - getCapabilities() - forceMuteAll(Iterable) - PublisherKit.onMuteForced() - Silenciar o áudio das transmissões em uma sessão

forceMuteAll

public void forceMuteAll(@Nullable Iterável<Transmissão> excludedStreams)

Obliga todos os transmissores na sessão (exceto aqueles que estão transmitindo streams excluídos) a silenciar o áudio.

Além disso, quaisquer streams publicados após a chamada à função forceMuteAll() método são publicadas com o áudio silenciado. É possível desativar o silenciamento de uma sessão chamando o disableForceMute() método. Depois de chamar o disableForceMute() Com esse método, as novas transmissões publicadas na sessão não terão mais o áudio silenciado.

A chamada a este método faz com que o Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) método a ser chamado em cada cliente conectado à sessão, com o getActive() método do info retorno do objeto true.

Verifique o canForceMute propriedade do objeto retornado pela chamada de getCapabilities() para verificar se você consegue chamar essa função com sucesso. Isso está reservado para clientes que se conectaram com um token ao qual foi atribuída a função de moderador (consulte o Criação de tokens (documentação).

Parâmetros: : excludedStreams - O objeto que representa as transmissões a serem excluídas da solicitação de silenciamento forçado. Isso inclui a transmissão que não deve ser silenciada.

Veja também: : - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) - getCapabilities() - disableForceMute() - forceMuteStream(Stream stream) - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) - PublisherKit.onMuteForced() - Silenciar o áudio das transmissões em uma sessão

desativarForçarSilêncio

public void desativarForçarSilêncio()

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 forceMuteAll(Iterable) método (ou quando um moderador em outro cliente executa uma chamada para silenciar todas as transmissões), quaisquer transmissões publicadas após a chamada de moderação são publicadas com o áudio silenciado. Chame o disableForceMute() método para desativar o silêncio de uma sessão (para que os novos streams publicados não sejam automaticamente silenciados).

A chamada a este método faz com que o Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) método a ser chamado, com o getActive() método do info objeto retornando false.

Verifique o canForceMute propriedade do objeto retornado pela chamada de getCapabilities() para verificar se você consegue chamar essa função com sucesso. Isso está reservado para clientes que se conectaram com um token ao qual foi atribuída a função de moderador (consulte o Criação de tokens (documentação).

Veja também: : - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) - getCapabilities() - forceMuteAll(Iterable) - Silenciar o áudio das transmissões em uma sessão

definirSegredoDeCriptografia

public void setEncryptionSecret(String (segredo)

Define o segredo de criptografia de ponta a ponta utilizado por todos os emissores e assinantes.

Veja o Guia do desenvolvedor sobre criptografia de ponta a ponta.

Parâmetros: : secret - Valor do segredo de criptografia.

onArchiveStarted

protected void onArchiveStarted(String id, String nome)

É chamado quando um arquivo da sessão começa a ser gravado. Em resposta a esse método, você pode querer adicionar uma notificação na interface do usuário (como um ícone na visualização do Publisher) que indique que a sessão está sendo gravada.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onArchiveStarted() método da interface Session.ArchiveListener .

Parâmetros: : id - O ID exclusivo do arquivo. : name - O nome do arquivo (caso tenha sido fornecido no momento da criação do arquivo).

onArchiveStopped

protected void onArchiveStopped(String id)

Chamado quando a gravação de um arquivo da sessão é interrompida. Em resposta a esse método, pode ser necessário remover uma notificação da interface do usuário (como um ícone na visualização do Publisher) indicando que a gravação da sessão foi interrompida.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onArchiveStopped() método da interface Session.ArchiveListener .

Parâmetros: : id - O ID exclusivo do arquivo.

onStreamHasAudioChanged

protected void onStreamHasAudioChanged(Transmissão stream, int temÁudio)

É chamado quando um stream na sessão alterna entre ter áudio e não ter áudio.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onStreamHasAudioChanged() método da interface Session.StreamPropertiesListener .

Parâmetros: : stream - O riacho. : hasAudio - Se a transmissão tem áudio (true) ou não ( false).

onStreamHasCaptionsChanged

protected void onStreamHasCaptionsChanged(Transmissão stream, int temLegendas)

É chamado quando uma transmissão na sessão alterna entre ter legendas e não ter legendas.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onStreamHasCaptionsChanged() método da interface Session.StreamPropertiesListener .

Parâmetros: : stream - O riacho. : hasCaptions - Se a transmissão possui legendas (true) ou não ( false).

onStreamHasVideoChanged

protected void onStreamHasVideoChanged(Transmissão stream, int temVídeo)

É chamado quando uma transmissão na sessão alterna entre ter vídeo e não ter vídeo.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onStreamHasVideoChanged() método da interface Session.StreamPropertiesListener .

Parâmetros: : stream - O riacho. : hasVideo - Se a transmissão contém vídeo (true) ou não ( false).

onStreamVideoDimensionsChanged

protected void onStreamVideoDimensionsChanged(Transmissão stream, int width, int height)

É chamado quando as dimensões do vídeo de um stream na sessão são alteradas.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onStreamVideoDimensionsChanged() método da interface Session.StreamPropertiesListener .

Parâmetros: : stream - O riacho. : width - A nova largura do stream, em pixels. : height - A nova altura do fluxo, em pixels.

onStreamVideoTypeChanged

protected void onStreamVideoTypeChanged(Transmissão stream, int videoType)

É chamado quando o tipo de vídeo de um stream na sessão é alterado.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onStreamVideoTypeChanged() método da interface Session.StreamPropertiesListener .

Parâmetros: : stream - O riacho. : videoType - O novo tipo de vídeo da transmissão.

onConnectionCreated

protected void onConnectionCreated(Conexão conexão)

É chamado quando outro o cliente se conecta à sessão. O objeto `Connection` representa a conexão do cliente com a sessão. Observe que esse método é chamado quando outros os clientes se conectam à sessão. Quando o seu próprio Quando o cliente se conecta, o Session.SessionListener.onConnected(Session session) método é chamado.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onConnectionCreated() método da interface Session.ConnectionListener .

Parâmetros: : connection - A nova conexão na sessão.

onConnectionDestroyed

protected void onConnectionDestroyed(Conexão conexão)

É acionado quando outro cliente sai da sessão. O objeto Connection representa a conexão anterior do cliente com a sessão. Quando o seu próprio Quando o cliente se desconecta, o Session.SessionListener.onDisconnected(Session session) o método é chamado.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onConnectionDestroyed() método da interface Session.ConnectionListener .

Parâmetros: : connection - A conexão que encerrou a sessão.

onSignalReceived

protected void onSignalReceived(String tipo, String dados, Conexão conexão)

É chamada quando um sinal é recebido na sessão.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onSignalReceived() método da interface Session.SignalListener .

Parâmetros: : type - A string de tipo do sinal. : data - Os dados do sinal. : connection - A conexão que identifica o cliente que enviou a mensagem. Esse valor pode ser null.

Ao se reconectar

protected void onReconnecting()

É acionado quando o cliente local perde a conexão com uma sessão do OpenTok e está tentando se reconectar. Isso ocorre devido a uma perda de conectividade de rede. Se o cliente conseguir se reconectar à sessão, o Session.ReconnectionListener.onReconnected(Session session) método é chamado. Caso contrário, se o cliente não conseguir se reconectar, o Session.SessionListener.onDisconnected(Session session) o método é chamado.

Em resposta à chamada desse método, talvez seja interessante exibir uma notificação na interface do usuário para informar ao usuário que o aplicativo está tentando se reconectar à sessão e que os fluxos de áudio e vídeo estão temporariamente desconectados.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onReconnecting() método da interface Session.ReconnectionListener .

Veja também: : - onReconnected()

onReconnected

protected void onReconnected()

É acionado quando o cliente local se reconecta à sessão do OpenTok após a perda temporária da conexão de rede. Quando a conexão é perdida, o Session.ReconnectionListener.onReconnecting(Session session) o método é chamado, antes do Session.ReconnectionListener.onReconnected(Session session) método. Se o cliente não conseguir se reconectar à sessão, o Session.SessionListener.onDisconnected(Session session) o método é chamado.

Quaisquer editores e assinantes existentes são automaticamente reconectados quando o cliente se reconecta e esse método é chamado.

Por padrão, quaisquer sinais iniciados pelo cliente local usando o sendSignal(String type, String data) Os sinais desse método são enviados quando o cliente se reconecta. Para evitar que sinais iniciados durante o período em que o cliente estava desconectado sejam enviados, use o sendSignal(String type, String data, boolean retryAfterReconnect) método para enviar o sinal e definir o retryAfterReconnect parâmetro para false. (Todos os sinais enviados por outros clientes enquanto o seu cliente estava desconectado são recebidos assim que a conexão for restabelecida.)

Se você estender a classe Session, poderá sobrescrever esse método em vez do onReconnected() método da interface Session.ReconnectionListener .

Veja também: : - onReconnecting()

onConnected

protected void onConnected()

É acionado quando o cliente se conecta à sessão do OpenTok.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onConnected() método da interface Session.SessionListener .

onDisconnected

protected void onDisconnected()

É acionado quando o cliente não está mais conectado à sessão do OpenTok .

Se você estender a classe Session, poderá sobrescrever esse método em vez do onDisconnected() método da interface Session.SessionListener .

onStreamReceived

protected void onStreamReceived(Transmissão (stream)

É acionado quando há um novo stream publicado por outro cliente nesta sessão do OpenTok.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onStreamReceived() método da interface Session.SessionListener .

Parâmetros: : stream - Um objeto `Stream` que representa o novo fluxo, o qual pode ser usado para criar um `Subscriber`.

onStreamDropped

protected void onStreamDropped(Transmissão (stream)

É chamado quando outro o cliente deixa de transmitir para esta sessão do OpenTok.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onStreamDropped() método da interface Session.SessionListener .

Parâmetros: : stream - Um objeto `Stream` que representa o fluxo descartado, o qual pode ser usado para identificar um assinante.

onError

protected void onError(OpentokError erro)

É chamado quando ocorre algum problema ao se conectar ou durante a conexão com a sessão. Após a chamada desse método, a sessão deve ser considerada inativa e indisponível. Não tente se reconectar nem chamar outros métodos do objeto Session.

Este método é chamado se a tentativa de conexão com a sessão falhar. Ele também é chamado se a conexão com a sessão for interrompida devido a um erro após uma conexão bem-sucedida; nesse caso, o método é chamado imediatamente antes da Session.SessionListener.onDisconnected(Session session) o método é chamado.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onError() método da interface Session.SessionListener .

Parâmetros: : error - Uma mensagem de erro que descreve a causa do erro.

onMuteForced

protected void onMuteForced(MuteForcedInfo (informações)

É acionado quando um moderador silencia as transmissões na sessão ou desativa o estado de silenciamento na sessão.

Se você estender a classe Session, poderá sobrescrever esse método em vez do onMuteForced() método da interface Session.MuteListener.

Parâmetros: : info - Ligue para o getActive método deste objeto para determinar se o moderador silenciou as transmissões na sessão (true) ou desativou o modo mudo na sessão (false).

Veja também: : - forceMuteAll(Iterable) - disableForceMute() - onMuteForced(MuteForcedInfo) - PublisherKit.onMuteForced() - Silenciar o áudio das transmissões em uma sessão

finalizar

protected void finalize() throws Arremessável

É chamado pelo coletor de lixo quando este determina que não há mais referências ao objeto Session.

Substituições: : finalize na aula  Object

Arremessos: : Throwable