Representa uma sessão da Video API da Vonage da qual o cliente está participando. Mais...

Herdou da interface IDisposable.

Descrição detalhada

Representa uma sessão da Video API da Vonage da qual o cliente está participando.

O primeiro passo para usar o SDK do Windows da Video API da Vonage é 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 Dispose() método do 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.

Documentação das funções de membro

Conectar()

Conecta-se à sessão da Video API da Vonage fornecida no Sessão construtor, utilizando o token de autenticação fornecido.

Quando a sessão se conecta, o Sessão o objeto envia o Conectado evento.

Se a sessão não conseguir se conectar, o Sessão o objeto envia o Erro evento.

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

DisableForceMute()

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 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 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 Silenciamento forçado evento, com o IsActive propriedade do MuteForcedEventArgs objeto a ser definido como false.

Verifique o CanForceMute propriedade do Session.Capabilities objeto 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 Visão geral da criação de tokens).

Veja Silenciar o áudio das transmissões em uma sessão.

Veja também : Recursos, ForceMuteAll, Silenciamento forçado

Desconectar()

Desconecta-se desta sessão. Todos Assinante e Editora as instâncias serão desconectadas.

Como prática recomendada, antes de chamar esse método, chame o Retirar da publicação (Editor) método para todos os editores e aguardar o Publisher.StreamDestroyed evento. 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, que pode manter os fluxos dos editores ativos para uma possível reconexão.

Quando a sessão é encerrada, o Sessão envia o Desconectado evento.

ForceDisconnect()

Obliga um cliente a se desconectar da sessã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, o Desconectado, Conexão interrompida e os eventos Publisher.StramDestroyed são disparados da mesma forma que seriam se a conexão tivesse sido encerrada por meio do método Disconnect.

Parâmetros : | | | | --- | --- | | conexão | A conexão a ser desconectada. |

ForceMuteAll()

Obliga todos os transmissores da 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() As sessões são publicadas com o áudio silenciado. É possível desativar o silenciamento de uma sessão chamando a funçã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 Sessão objeto em cada cliente conectado à sessão para enviar o Silenciamento forçado evento, com o IsActive propriedade do MuteForcedEventArgs objeto a ser definido como true.

Verifique o CanForceMute propriedade do Session.Capabilities objeto 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 Visão geral da criação de tokens).

Veja Silenciar o áudio das transmissões em uma sessão.

Parâmetros : | | | | --- | --- | | excludedStreams | 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 também : Recursos, ForceMuteStream, DisableForceMute(), Session.MuteForced, Editor.SilenciarForçado

ForceMuteStream()

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

Verifique o CanForceMute propriedade do Session.Capabilities objeto 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 Visão geral da criação de tokens).

Veja Silenciar o áudio das transmissões em uma sessão.

Parâmetros : | | | | --- | --- | | stream | O stream a ser silenciado. |

Veja também : Recursos, ForceMuteAll, Editor.SilenciarForçado

Publicar()

Inicia um Editora transmissão para a sessão.

Parâmetros : | | | | --- | --- | | editor | O Editora que você deseja transmitir para a sessão. |

SendSignal()

Envia um sinal a todos os clientes da sessão.

Parâmetros : | | | | --- | --- | | tipo | O tipo do sinal. O tipo é definido no SignalEventArgs.Type argumento do Sinal ouvinte de evento. | | dados | Os dados a serem enviados. O limite de tamanho dos dados é de 8 kB. O tipo é definido no SignalEventArgs.Data argumento do Sinal ouvinte de evento. | | conexão | | | retryAfterReconnect | |

SetEncryptionSecret()

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

Veja o Criptografia de ponta a ponta guia do desenvolvedor.

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

Inscrever-se()

Inicie o recebimento e a reprodução dos dados do fluxo de áudio e vídeo para o assinante especificado.

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

Retirar da publicação()

Desconecta o Editora da sessão.

Parâmetros : | | | | --- | --- | | editor | O Editora para retirar da publicação. |

Cancelar inscrição()

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

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

Documentação do evento

Conexão criada

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

O ConnectionEventArgs.Connection O objeto 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 Conectado evento.

Conexão interrompida

Enviado quando outro cliente sai da sessão.

O ConnectionEventArgs.Connection O objeto 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 Conectado evento.

Erro

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

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 Desconectado o evento é enviado.

Início da reconexão

Enviado quando o cliente local perde a conexão com uma sessão da Video API da Vonage e está tentando se reconectar. Isso ocorre devido a uma perda de conectividade de rede.

Se o cliente conseguir se reconectar à sessão, o Sessão o objeto envia o Reconexão bem-sucedida evento. Caso contrário, se o cliente não conseguir se reconectar, o Sessão o objeto envia o Desconectado evento.

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 também : Reconexão bem-sucedida, Desconectado

Reconexão bem-sucedida

É acionado quando o cliente local se reconecta à sessão da Video API da Vonage após uma perda temporária da conexão de rede.

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 usando o SendSignal(string, string, Connection, bool) Os sinais desse método são enviados quando o cliente se reconecta. Para impedir que quaisquer sinais iniciados durante o período em que o cliente esteve desconectado sejam enviados, defina o retryAfterReconnect parâmetro do SendSignal método para false. (Todos os sinais enviados por outros clientes enquanto o seu cliente estava desconectado são recebidos assim que ele se reconecta.)

Veja também : Início da reconexão

StreamDropped

Enviado quando outro o cliente interrompe a transmissão para esta sessão da Video API do Vonage.

O StreamEventArgs.Stream O objeto representa um instantâneo do fluxo no momento da chamada de retorno. Ele pode ser usado para identificar um Assinante (se houver).

StreamReceived

Enviado quando há um novo stream publicado por outro cliente nesta sessão da Video API da Vonage.

O StreamEventArgs.Stream O objeto representa um instantâneo do fluxo no momento da chamada de retorno. Crie um Assinante e ligue para o Inscrever-se (Assinante) método para se inscrever no stream.