OpenTok.Assinante

public class Subscriber : IDisposable

Use o Subscriber.Builder classe para criar um Assinante instância. Os assinantes podem se conectar para receber mídia quando você chama o método Session.Subscribe(Subscriber).

O Assinante A classe implementa a interface System.IDisposable. Certifique-se de chamar o método Dispose() da Assinante objeto deve liberar seus recursos quando você não precisar mais dele (por exemplo, quando o Assinante interrompe a transmissão de vídeo ou quando o aplicativo ou a janela está sendo fechado).

Tipos aninhados: OpenTok.Subscriber.ErrorEventArgs, OpenTok.Subscriber.VideoEventArgs, OpenTok.Subscriber.CaptionTextArgs, OpenTok.Subscriber.AudioNetworkStatsEventArgs, OpenTok.Subscriber.VideoNetworkStatsEventArgs, OpenTok.Subscriber.VideoQualityChangedEventArgs, OpenTok.Subscriber.SubscriberMediaLinkStats, OpenTok.Subscriber.SubscriberMediaLinkStatsEventArgs, OpenTok.Subscriber.NetworkConditionChangedEventArgs, OpenTok.Subscriber.AudioLevelArgs, OpenTok.Subscriber.AudioDataEventArgs, OpenTok.Subscriber.RtcStatsReportArgs, OpenTok.Subscriber.Builder, OpenTok.Subscriber.SenderStats

Propriedades

#### Stream

Tipo: Transmissão

{ get; }

O fluxo para este assinante. As propriedades do Transmissão As propriedades do objeto representam um instantâneo do estado do fluxo no momento em que essa propriedade é acessada e não serão atualizadas à medida que o estado do fluxo mudar.

#### SubscribeToCaptions

Tipo: bool

{ get; set; }

Se o Assinante está se inscrevendo para receber legendas (true) ou não (false). O valor padrão é o valor de legendas definido em Publisher.Publisher.PublishCaptions do emissor do stream.

#### CaptionsTranslationLanguage

Tipo: string

{ get; set; }

Essa configuração só entra em vigor quando as legendas estão ativadas. Defina-a com um código de idioma compatível com o BCP-47 para receber legendas traduzidas, ou null para desativar a tradução. O valor padrão é null (não há tradução configurada).

Os códigos de idiomas compatíveis estão definidos na especificação da API do servidor.

#### SubscribeToAudio

Tipo: bool

{ get; set; }

Se o Assinante está assinando o conteúdo de áudio (true) ou não (false).

#### SubscribeToVideo

Tipo: bool

{ get; set; }

Se o Assinante está se inscrevendo no canal de vídeo (true) ou não (false).

#### VideoRenderer

Tipo: IVideoRenderer

{ get; }

Defina o renderizador de vídeo passando o VideoRenderer ao chamar o construtor de `Subscriber(Context, Stream, IVideoRenderer)`.

#### Id

Tipo: string

{ get; }

O identificador exclusivo para o Assinante.

#### PreferredResolution

Tipo: Tamanho

{ get; set; }

A resolução preferencial para o stream do assinante.

Limitar a resolução do vídeo e a taxa de quadros (PreferredFramerate) reduz o uso da rede e da CPU no cliente assinante. Você pode optar por usar uma resolução mais baixa com base nas dimensões do vídeo do assinante no aplicativo. Você pode optar por usar uma taxa de quadros ou resolução mais baixa para assinantes de uma transmissão que seja menos importante (e menor) do que outras transmissões.

Essa propriedade só se aplica ao assinar um stream que utilize o recurso de vídeo escalável. O vídeo escalável está disponível:

  • Somente nas sessões que utilizam o OpenTok Roteador de mídia (sessões com o modo de mídia (definido como “roteado”).
  • Apenas para transmissões publicadas por clientes que suportam vídeo escalável (consulte a documentação do recurso de vídeo escalável).

Em transmissões que não utilizam vídeo escalável, definir essa propriedade não tem efeito.

Observação: A resolução das transmissões de vídeo escaláveis é ajustada automaticamente para cada assinante, com base nas condições da rede e no uso da CPU, mesmo que você não defina essa propriedade. Defina essa propriedade se desejar estabelecer uma resolução máxima para esse assinante.

Nem todas as resoluções estão disponíveis para um assinante. Ao definir a resolução preferida, o OpenTok O Windows SDK seleciona a melhor resolução disponível que atenda às suas restrições. As resoluções disponíveis dependem da largura e altura máximas que o Editora conjuntos para o fluxo, que são retornados pela função Stream.Width e Stream.Height propriedades do Transmissão objeto. Cada uma das resoluções disponíveis para uma transmissão utilizará a mesma proporção de tela.

#### AudioVolume

Tipo: duplo

{ get; set; }

O volume do áudio do assinante, entre 0 e 100. Ao definir o valor, se ele não estiver nesse intervalo, será ajustado para dentro dele.

O valor padrão é 100.

#### PreferredFramerate

Tipo: flutuar

{ get; set; }

Limitar a taxa de quadros e a resolução do vídeo (PreferredResolution) reduz o uso da rede e da CPU no cliente assinante. Você pode optar por usar uma resolução mais baixa com base nas dimensões do vídeo do assinante no aplicativo. Pode ser interessante usar uma taxa de quadros ou resolução mais baixa para assinantes de uma transmissão que seja menos importante (e menor) do que outras transmissões.

Essa propriedade só se aplica ao assinar um stream que utilize o recurso de vídeo escalável. O vídeo escalável está disponível:

  • Somente nas sessões que utilizam o OpenTok Roteador de mídia (sessões com o modo de mídia (definido como “roteado”).
  • Apenas para transmissões publicadas por clientes que suportam vídeo escalável (consulte a documentação do recurso de vídeo escalável).

Em transmissões que não utilizam vídeo escalável, definir essa propriedade não tem efeito.

Observação: A taxa de quadros para transmissões de vídeo escaláveis se ajusta automaticamente para cada assinante, com base nas condições da rede e no uso da CPU, mesmo que você não defina essa propriedade. Defina essa propriedade se desejar estabelecer uma taxa de quadros máxima para esse assinante.

As taxas de quadros disponíveis são baseadas no valor da taxa de quadros máxima disponível para a transmissão. Ao definir a taxa de quadros preferencial para o assinante, o OpenTok O Windows SDK seleciona a melhor taxa de quadros disponível que seja mais próxima da taxa de quadros preferida, com base na largura de banda do cliente e nas restrições da CPU.

As taxas de quadros efetivamente disponíveis dependem, de forma dinâmica, dos recursos de rede e da CPU disponíveis para o editor.

enum VideoReason

Define os valores das propriedades VideoEventArgs.Reason e VideoEventArgs.Reason.

Nome Valor Descrição
PublishVideo 1 O evento ocorreu porque o transmissor iniciou ou interrompeu a transmissão do vídeo.
SubscriberToVideo 2 O evento ocorreu porque o cliente local iniciou ou encerrou a assinatura do vídeo.
Quality 3 Transmissão A qualidade pode variar devido às condições da rede ou ao uso da CPU, tanto no lado do assinante quanto no do editor. Quando ativado, o fallback de áudio gera um evento quando o assinante interrompe a transmissão de vídeo devido à degradação da qualidade do vídeo, fazendo com que o assinante envie o evento VideoDisabled. Quando as condições melhoram, a transmissão de vídeo é retomada, e o Assinante envia o evento VideoEnabled. Quando o fluxo de vídeo é interrompido, o assinante continua a receber o fluxo de áudio, caso haja um. Em sessões roteadas, a origem desse comportamento pode ser o Media Router da Video API da Vonage (Assinante (Reserva de áudio) ou o cliente de publicação (Editora Recurso alternativo de áudio). Quando o cliente de publicação é a fonte, o aplicativo assinante recebe o evento correspondente `Session.StreamHasVideoChanged`, indicando que o canal de vídeo assinado não está mais ativo. Em geral, esse comportamento sugere uma degradação da rede no lado do editor; no entanto, as métricas relatadas pelo assinante podem influenciar as decisões de fallback do editor, o que pode complicar a determinação da origem exata da degradação. Em sessões retransmitidas, o evento “qualidade” é acionado exclusivamente devido à lógica interna de fallback de áudio do editor (Fallback de Áudio do Editor). Isso não é seguido por nenhum evento adicional indicando que o vídeo está inativo, pois a transmissão ainda pode ser recebida por outros assinantes com melhores condições de rede. Observe que, embora o fallback tenha origem no editor em sessões retransmitidas, a degradação subjacente da rede pode ocorrer tanto no lado do editor quanto no lado do assinante.
CodecNotSupported 4 O problema com o vídeo ocorreu porque o vídeo na transmissão do assinante foi desativado, já que a transmissão utiliza um codec de vídeo (como o H.264) que não é compatível com o dispositivo.
CodecChange 8 O codec de vídeo da transmissão foi alterado.
ResolutionChange 9 Alteração na resolução do vídeo ou no número de camadas. Isso pode ocorrer devido a restrições de taxa de bits, adaptação do codificador, alterações na fonte da câmera (como troca de câmera ou alteração da resolução de entrada) ou alterações na configuração. Não implica necessariamente em perda de qualidade.
VideoInterruption 10 Indica que a transmissão do vídeo para o assinante foi pausada por um período prolongado (normalmente superior a cinco segundos). Quando ocorre uma interrupção no vídeo, as Applications podem verificar o VideoStatsUpdated para identificar fatores que contribuíram para isso, como baixa taxa de bits ou alta latência.
SenderQualityRestriction 11 Qualidade do vídeo restrita pelo remetente.

Métodos

Nome Descrição
Subscriber(builder)
Dispose(disposing)
Dispose() Dispõe do Assinante recursos do objeto.
GetRtcStatsReport() Consulte também AudioStatsUpdated, VideoStatsUpdated e Publisher.GetRtcStatsReport().

Assinante (construtor)

Parâmetros:
Nome Tipo Descrição
builder Construtor

Descartar (descartando)

Parâmetros:
Nome Tipo Descrição
disposing bool

Dispose()

Dispõe do Assinante recursos do objeto.

GetRtcStatsReport()

Consulte também AudioStatsUpdated, VideoStatsUpdated e Publisher.GetRtcStatsReport().

Eventos

Conectado

event EventHandler Connected

É acionado quando a instância se conecta com sucesso ao stream e começa a reproduzir a mídia.

Transmissão desconectada

event EventHandler StreamDisconnected

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 fluxo de áudio e vídeo está temporariamente desconectado e que o aplicativo está tentando se reconectar ao fluxo.

Se o cliente se reconectar ao stream, o Subscribers envia o evento StreamReconnected. Caso contrário, o Sessão O objeto dispara o evento Session.StreamDropped.

StreamReconnected

event EventHandler StreamReconnected

O Assinante envia esse evento após enviar o evento StreamDisconnected.

Texto da legenda

event EventHandler<CaptionTextArgs> CaptionText

Enviado quando o stream do assinante recebe o texto da legenda.

Vídeo desativado

event EventHandler<VideoEventArgs> VideoDisabled

Verifique o reason propriedade dos argumentos do evento que indica o motivo pelo qual o vídeo parou.

Compatível com vídeo

event EventHandler<VideoEventArgs> VideoEnabled

Verifique o reason propriedade dos argumentos do evento que indica o motivo pelo qual o vídeo foi ativado.

Erro

event EventHandler<ErrorEventArgs> Error

A maioria dos erros é fatal: o assinante é automaticamente encerrado e não pode mais ser utilizado. Alguns erros permitem a continuidade e mantêm o assinante utilizável; quando um erro não é fatal, isso é indicado na descrição do erro.

Desativar aviso de vídeo

event EventHandler VideoDisableWarning

Se a qualidade piorar ainda mais, o assinante desativa o vídeo e o Assinante envia a mensagem VideoDisabled. Se a qualidade do stream melhorar, o Assinante envia o evento VideoDisableWarningLifted.

Esse recurso está disponível apenas em sessões que utilizam o OpenTok Roteador de mídia (sessões com o modo de mídia definido como “roteado”), não em sessões com o modo de mídia definido como “retransmitido”. (Consulte O OpenTok Media Router e os modos de mídia).

Esse método é chamado principalmente quando a qualidade da conexão se deteriora.

Aviso sobre desativação de vídeo suspenso

event EventHandler VideoDisableWarningLifted

Esse recurso está disponível apenas em sessões que utilizam o OpenTok Roteador de mídia (sessões com o modo de mídia definido como “roteado”), não em sessões com o modo de mídia definido como “retransmitido”. (Consulte O OpenTok Media Router e os modos de mídia).

Esse método é chamado principalmente quando a qualidade da conexão melhora.

Qualidade do vídeo alterada

event EventHandler<VideoQualityChangedEventArgs> VideoQualityChanged

Este evento é acionado quando ocorrem alterações significativas na qualidade do fluxo de vídeo do assinante, como uma interrupção detectada no vídeo (pausa) ou uma mudança de codec.

A implementação atual só aciona esse evento em caso de interrupções de vídeo ou mudanças de codec. Os travamentos são monitorados internamente e refletidos nas estatísticas, mas não acionam esse evento individualmente devido à sua curta duração e alta frequência. Uma chamada de retorno é acionada somente quando uma pausa (sem quadro renderizado por 5 segundos ou mais) é detectada, pois isso representa uma interrupção mais significativa na reprodução.

O valor VideoReason especifica a causa do evento e segue esta ordem de prioridade: VideoInterruption, CodecChange.

Este evento difere dos eventos `VideoDisabled` e `VideoEnabled`, pois relata alterações relacionadas à qualidade, em vez de simples transições de ativação/desativação da trilha de vídeo. Os eventos VideoDisabled e VideoEnabled indicam quando a trilha de vídeo do assinante foi desativada ou ativada (por exemplo, devido a um fallback de áudio ou a atualizações nas propriedades do stream). Em contrapartida, este evento fornece informações de diagnóstico sobre as causas da degradação da qualidade, como travamentos, contagem de pausas e estatísticas atualizadas do vídeo.

Este evento considera qualquer interrupção de vídeo com duração de cinco segundos ou mais. Em situações como o recurso de áudio alternativo ou a desativação do vídeo, a interrupção também é registrada como uma pausa nas estatísticas, e um evento correspondente de alteração de qualidade pode ser gerado.

Os aplicativos podem utilizar esse evento para lidar com questões de qualidade, como atualizar indicadores da interface do usuário, registrar dados de telemetria ou notificar os usuários.

Alteração na condição da rede

event EventHandler<NetworkConditionChangedEventArgs> NetworkConditionChanged

Este evento é acionado quando ocorrem mudanças significativas nas condições da rede, fornecendo estatísticas do link de mídia juntamente com o motivo da mudança.

MediaLinkEstatísticasAtualizadas

event EventHandler<SubscriberMediaLinkStatsEventArgs> MediaLinkStatsUpdated

É executado periodicamente para gerar relatórios com as estatísticas de links de mídia do assinante.

Nível de Áudio

event EventHandler<AudioLevelArgs> AudioLevel

Enviado periodicamente para informar o nível de áudio do assinante.

Dados de áudio

event EventHandler<AudioDataEventArgs> AudioData

É chamado periodicamente para relatar os dados de áudio do PCM do assinante.

Estatísticas de áudio atualizadas

event EventHandler<AudioNetworkStatsEventArgs> AudioStatsUpdated

É acionado quando o assinante tem estatísticas de áudio para compartilhar.

Estatísticas de vídeo atualizadas

event EventHandler<VideoNetworkStatsEventArgs> VideoStatsUpdated

É chamado quando o assinante tem estatísticas de vídeo para compartilhar.

RtcStatsReport

event EventHandler<RtcStatsReportArgs> RtcStatsReport

Enviado em resposta a uma chamada à função GetRtcStatsReport().