OpenTok.Session
public class Session : IDisposable
O primeiro passo para usar o OpenTok O Windows SDK serve para instanciar um Sessão objeto usando o Session.Builder classe.
O Sessão A classe implementa a interface System.IDisposable. Certifique-se de chamar o método Dispose() da Sessão o objeto deve liberar seus recursos quando você não precisar mais dele (por exemplo, quando o aplicativo ou a janela estiver sendo fechado).
Veja também Criação de sessão e Criação de tokens.
Tipos aninhados: OpenTok.Session.ConnectionEventArgs, OpenTok.Session.ErrorEventArgs, OpenTok.Session.SignalEventArgs, OpenTok.Session.StreamEventArgs, OpenTok.Session.ArchiveStartedEventArgs, OpenTok.Session.ArchiveStoppedEventArgs, OpenTok.Session.MuteForcedEventArgs, OpenTok.Session.Builder
Propriedades
| Nome | Tipo | Descrição |
|---|---|---|
Connection |
Conexão | { get; } Retorna o Conexão correspondente à conexão desse cliente com este Sessão. |
Capabilities |
Recursos | { get; } Depende da função atribuída ao token usado para se conectar à sessão se o cliente pode apenas assinar fluxos ou se pode tanto publicar quanto assinar fluxos. |
Métodos
| Nome | Descrição |
|---|---|
Session(builder) |
|
Connect(token) |
Quando a sessão se conecta, o Sessão O objeto envia o evento “Connected”. |
DisableForceMute() |
Depois que você chamar o método ForceMuteAll (ou quando um moderador em outro cliente solicitar o silenciamento de todas as transmissões), todas as transmissões publicadas após essa solicitação de moderação serão publicadas com o áudio silenciado. |
Disconnect() |
Como prática recomendada, antes de chamar esse método, chame o método Unpublish(Publisher) para todos os editores e aguarde o evento Publisher.StreamDestroyed. |
Dispose(disposing) |
|
Dispose() |
Dispõe do Sessão recursos do objeto. |
ForceDisconnect(connection) |
Embora seja possível usar o método ForceDisconnect para encerrar sua própria conexão, chamar o método Disconnect é mais simples. |
ForceMuteAll(excludedStreams) |
Além disso, quaisquer streams publicados após a chamada à função ForceMuteAll() Os vídeos do método são publicados com o áudio desativado. |
ForceMuteStream(stream) |
Verifique o CanForceMute propriedade do objeto Session.Capabilities para verificar se é possível chamar essa função com sucesso. |
Publish(publisher) |
|
SendSignal(type, data, connection, retryAfterReconnect) |
|
SetEncryptionSecret(secret) |
Veja o Criptografia de ponta a ponta guia do desenvolvedor. |
Subscribe(subscriber) |
|
Unpublish(publisher) |
|
Unsubscribe(subscriber) |
Sessão (construtor)
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
builder |
Construtor |
Conectar(token)
Quando a sessão se conecta, o Sessão O objeto envia o evento “Connected”.
Se a sessão não conseguir se conectar, o Sessão O objeto dispara o evento Error.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
token |
sequência de caracteres | O token do usuário. Consulte Visão geral da criação de tokens. |
DisableForceMute()
Depois que você chamar o método ForceMuteAll (ou quando um moderador em outro cliente solicitar o silenciamento de todas as transmissões), todas as transmissões publicadas após essa solicitação de moderação serão publicadas com o áudio silenciado. Chame o DisableForceMute() método para desativar o silenciamento de uma sessão (para que os novos fluxos publicados não sejam automaticamente silenciados).
A chamada a este método faz com que o Sessão objeto em cada cliente conectado à sessão para enviar o evento MuteForced, com o IsActive propriedade do MuteForcedEventArgs objeto a ser definido como false.
Verifique o CanForceMute propriedade do objeto Session.Capabilities para verificar se é possível chamar essa função com sucesso. Isso é reservado para clientes que se conectaram com um token ao qual foi atribuída a função de moderador (consulte o Visão geral da criação de tokens).
Veja Silenciar o áudio das transmissões em uma sessão.
Veja: : - Recursos, ForceMuteAll, Silenciamento forçado
Desconectar()
Como prática recomendada, antes de chamar este método, chame o método Unpublish(Publisher) para todos os publicadores e aguarde o evento Publisher.StreamDestroyed. Isso garante a remoção completa dos publicadores, especialmente se problemas de conectividade de rede impedirem a remoção devido ao recurso de reconexão, o que pode manter os fluxos dos publicadores ativos para uma possível reconexão.
Quando a sessão é encerrada, o Sessão envia o evento “Desconectado”.
Descartar (descartando)
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
disposing |
bool |
Dispose()
Dispõe do Sessão recursos do objeto.
ForceDisconnect(conexão)
Embora seja possível usar o método ForceDisconnect para encerrar sua própria conexão, chamar o método Disconnect é mais simples. Será retornado um erro se a função do usuário não incluir as permissões necessárias para forçar outros usuários a se desconectarem. Você define a função de um usuário ao criar o token do usuário.
Quando uma conexão é encerrada por meio desse método, os eventos `Disconnected`, `ConnectionDropped` e `Publisher.StreamDestroyed` são disparados da mesma forma que seriam se a conexão tivesse sido encerrada automaticamente por meio do método `Disconnect`.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
connection |
Conexão | A conexão para se desconectar. |
ForceMuteAll(excludedStreams)
Além disso, quaisquer streams publicados após a chamada à função ForceMuteAll() As sessões são publicadas com o áudio silenciado. É possível desativar o silenciamento de uma sessão chamando o método DisableForceMute(). Após chamar o método DisableForceMute(), os novos fluxos publicados na sessão não terão mais o áudio silenciado.
A chamada a este método faz com que o Sessão objeto em cada cliente conectado à sessão para enviar o evento MuteForced, com o IsActive propriedade do MuteForcedEventArgs objeto a ser definido como true.
Verifique o CanForceMute propriedade do objeto Session.Capabilities para verificar se é possível chamar essa função com sucesso. Isso é reservado para clientes que se conectaram com um token ao qual foi atribuída a função de moderador (consulte o Visão geral da criação de tokens).
Veja Silenciar o áudio das transmissões em uma sessão.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
excludedStreams |
IEnumerable<Transmissão> | Fluxos a serem excluídos da solicitação de silenciamento. Defina este parâmetro como nulo (ou não o defina) para silenciar todos os fluxos da sessão (incluindo aqueles publicados pelo cliente local). |
Veja: : - Recursos, ForceMuteStream, DisableForceMute(), Session.MuteForced, Editor.SilenciarForçado
ForceMuteStream(stream)
Verifique o CanForceMute propriedade do objeto Session.Capabilities para verificar se é possível chamar essa função com sucesso. Isso é reservado para clientes que se conectaram com um token ao qual foi atribuída a função de moderador (consulte o Visão geral da criação de tokens).
Veja Silenciar o áudio das transmissões em uma sessão.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
stream |
Transmissão | A transmissão a ser silenciada. |
Veja: : - Recursos, ForceMuteAll, Editor.SilenciarForçado
Publicar (editora)
Parâmetros:
SendSignal(tipo, dados, conexão, novaTentativaApósReconexão)
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
type |
sequência de caracteres | O tipo do sinal. O tipo é definido no argumento SignalEventArgs.Type do ouvinte de eventos Signal. |
data |
sequência de caracteres | Os dados a serem enviados. O limite de tamanho dos dados é de 8 kB. O tipo é definido no argumento SignalEventArgs.Data do ouvinte de eventos Signal. |
connection |
Conexão | |
retryAfterReconnect |
bool |
SetEncryptionSecret(segredo)
Veja o Criptografia de ponta a ponta guia do desenvolvedor.
A sessão deve ter sido configurada com criptografia de ponta a ponta usando o SDK do servidor. Se já se souber que a sessão não possui criptografia de ponta a ponta, este método lança uma exceção `OpenTokException` com `ErrorCode.EncryptionNotEnabled`, e todos os emissores e assinantes existentes recebem o mesmo erro e são desconectados. Se isso ainda não for conhecido (por exemplo, quando o segredo é definido antes da conexão da sessão), este método é executado com sucesso e o erro é relatado posteriormente, durante a publicação ou a assinatura.
Passagem null ou uma string vazia redefine (limpa) o segredo de criptografia definido anteriormente. A redefinição do segredo é sempre permitida, mesmo em uma sessão que se sabe não ser criptografada de ponta a ponta.
Qualquer outro segredo deve ter entre 8 e 256 bytes quando codificado em UTF-8; caso contrário, será lançada uma exceção OpenTokException com o código de erro ErrorCode.InvalidEncryptionSecret.
Um novo segredo entra em vigor para os publicadores e assinantes que já estão em execução, bem como para aqueles criados posteriormente. A redefinição do segredo, no entanto, só entra em vigor para os publicadores e assinantes criados posteriormente: aqueles que já estão em execução continuam criptografando e descriptografando com o segredo anterior até que sejam recriados.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
secret |
sequência de caracteres | Valor do segredo de criptografia, ou null ou uma string vazia para redefinir o segredo de criptografia definido anteriormente. |
Inscrever-se (assinante)
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
subscriber |
Assinante | O assinante vinculado ao fluxo a ser recebido. |
Retirar da publicação (editor)
Parâmetros:
Cancelar inscrição (assinante)
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
subscriber |
Assinante | O assinante cuja assinatura você deseja cancelar. |
Eventos
Conectado
event EventHandler Connected
Enviado quando o cliente se conecta ao OpenTok sessão.
Desconectado
event EventHandler Disconnected
Enviado quando o cliente se desconecta do OpenTok sessão.
Conexão criada
event EventHandler<ConnectionEventArgs> ConnectionCreated
O objeto ConnectionEventArgs.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 Sessão envia o evento “Connected”.
Conexão interrompida
event EventHandler<ConnectionEventArgs> ConnectionDropped
O objeto ConnectionEventArgs.Connection representa a conexão anterior do cliente com a sessão. Observe que esse método é chamado quando outros os clientes saem da sessão. Quando o seu próprio Quando o cliente se desconecta, o Sessão O objeto envia o evento “Connected”.
StreamReceived
event EventHandler<StreamEventArgs> StreamReceived
O objeto StreamEventArgs.Stream representa um instantâneo do fluxo no momento da chamada de retorno. Crie um Subscriber e chame o método Subscribe(Subscriber) para se inscrever no fluxo.
StreamDropped
event EventHandler<StreamEventArgs> StreamDropped
O objeto StreamEventArgs.Stream representa um instantâneo do fluxo no momento da chamada de retorno. Ele pode ser usado para identificar um Assinante (se houver).
Erro
event EventHandler<ErrorEventArgs> Error
Este evento é enviado se a tentativa de conexão com a sessão falhar. Ele também é enviado se a conexão com a sessão for interrompida devido a um erro após uma conexão bem-sucedida; nesse caso, o evento é enviado imediatamente antes do envio do evento “Desconectado”.
Sinal
event EventHandler<SignalEventArgs> Signal
É chamada quando um sinal é recebido na sessão.
StreamHasCaptionsChanged
event EventHandler<StreamEventArgs> StreamHasCaptionsChanged
É chamado quando uma transmissão na sessão alterna entre ter ou não legendas.
StreamHasAudioChanged
event EventHandler<StreamEventArgs> StreamHasAudioChanged
É chamado quando um stream na sessão alterna entre ter áudio e não ter áudio. O objeto StreamEventArgs.Stream representa um instantâneo do stream no momento da chamada de retorno.
StreamHasVideoChanged
event EventHandler<StreamEventArgs> StreamHasVideoChanged
É chamado quando uma transmissão na sessão alterna entre ter vídeo e não ter vídeo. O objeto StreamEventArgs.Stream representa um instantâneo da transmissão no momento da chamada de retorno.
StreamDimensionsChanged
event EventHandler<StreamEventArgs> StreamDimensionsChanged
É chamado quando as dimensões de vídeo de um stream na sessão são alteradas. O objeto StreamEventArgs.Stream representa um instantâneo do stream no momento da chamada de retorno.
Início da reconexão
event EventHandler ReconnectionStart
Se o cliente conseguir se reconectar à sessão, o Sessão O objeto dispara o evento ReconnectionSuccess. Caso contrário, se o cliente não conseguir se reconectar, o Sessão O objeto envia o evento “Desconectado”.
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.
Veja: : - Reconexão bem-sucedida, Desconectado
Reconexão bem-sucedida
event EventHandler ReconnectionSuccess
Quando a conexão é perdida, o Sessão o objeto envia o Session.ReconnectionStart evento, antes de enviar o Session.ReconnectionSuccess evento. Se o cliente não conseguir se reconectar à sessão, o Sessão o objeto envia o Session.Desconectado evento.
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 por meio do método SendSignal(string, string, Connection, bool) são enviados quando o cliente se reconecta. Para impedir que sinais iniciados enquanto o cliente estava desconectado sejam enviados, defina o retryAfterReconnect parâmetro do método SendSignal para false. (Todos os sinais enviados por outros clientes enquanto o seu cliente estava desconectado são recebidos assim que ele se reconecta.)
Veja: : - Início da reconexão
Arquivo Iniciado
event EventHandler<ArchiveStartedEventArgs> ArchiveStarted
É chamado quando um arquivo da sessão começa a ser gravado. Em resposta a esse método, talvez seja interessante adicionar uma notificação na interface do usuário (como um ícone no Editora (visualização) que indica que a sessão está sendo gravada.
Arquivado/Suspenso
event EventHandler<ArchiveStoppedEventArgs> ArchiveStopped
É chamado quando a gravação do arquivo da sessão é interrompida. Em resposta a esse método, talvez seja necessário remover uma notificação da interface do usuário (como um ícone na Editora (visualizar) a gravação da sessão foi interrompida.
Silenciamento forçado
event EventHandler<MuteForcedEventArgs> MuteForced
É chamado quando um moderador obriga os clientes que estão transmitindo fluxos para a sessão a silenciar o áudio (o IsActive propriedade do MuteForcedEventArgs o objeto está definido como true), ou quando um moderador desativa o silenciamento do áudio na sessão (o IsActive propriedade do MuteForcedEventArgs o objeto está definido como false).