OpenTok.Suscriptor

public class Subscriber : IDisposable

Utiliza el Subscriber.Builder clase para crear un Suscriptor instancia. Los suscriptores pueden conectarse para recibir contenidos multimedia cuando se invoca el método Session.Subscribe(Subscriber).

El Suscriptor La clase implementa la interfaz System.IDisposable. Asegúrate de llamar al método Dispose() de la Suscriptor objeto para que libere sus recursos cuando ya no lo necesites (por ejemplo, cuando el Suscriptor deja de reproducir el vídeo o cuando se cierra la aplicación o la ventana).

Tipos anidados: 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

Propiedades

#### Stream

Tipo: Transmisión

{ get; }

El flujo de este suscriptor. Las propiedades del Transmisión Los objetos son una instantánea del estado del flujo en el momento en que se accede a esta propiedad y no se actualizarán a medida que cambie el estado del flujo.

#### SubscribeToCaptions

Tipo: bool

{ get; set; }

Si el Suscriptor es suscribirse a los subtítulos (true) o no (false). El valor por defecto es el valor de «captions» de la propiedad Publisher.Publisher.PublishCaptions del editor de la transmisión.

#### CaptionsTranslationLanguage

Tipo: cadena

{ get; set; }

Esta configuración solo surte efecto cuando los subtítulos están activados. Establece este valor en un código de idioma BCP-47 compatible para recibir subtítulos traducidos, o null para desactivar la traducción. El valor por defecto es null (no hay traducción configurada).

Los códigos de idioma compatibles se definen en la especificación de la API del servidor.

#### SubscribeToAudio

Tipo: bool

{ get; set; }

Si el Suscriptor se está suscribiendo al audio (true) o no (false).

#### SubscribeToVideo

Tipo: bool

{ get; set; }

Si el Suscriptor es suscribirse a los vídeos (true) o no (false).

#### VideoRenderer

Tipo: IVideoRenderer

{ get; }

Configura el renderizador de vídeo pasando el parámetro VideoRenderer al llamar al constructor de `Subscriber(Context, Stream, IVideoRenderer)`.

#### Id

Tipo: cadena

{ get; }

El identificador único del Suscriptor.

#### PreferredResolution

Tipo: Tamaño

{ get; set; }

La resolución preferida para la transmisión del suscriptor.

Limitar la resolución del vídeo y la frecuencia de fotogramas (PreferredFramerate) reduce el uso de la red y de la CPU en el cliente suscrito. Es posible que te interese utilizar una resolución más baja en función de las dimensiones del vídeo del suscriptor en la aplicación. Quizá te interese utilizar una frecuencia de fotogramas o una resolución más bajas para los suscriptores de una transmisión que sea menos importante (y más pequeña) que otras transmisiones.

Esta propiedad solo se aplica al suscribirse a un flujo que utilice el función de vídeo escalable. Hay vídeo escalable disponible:

  • Solo en las sesiones que utilizan el OpenTok Enrutador multimedia (sesiones con el modo multimedia enrutado).
  • Solo para transmisiones publicadas por clientes que admitan vídeo escalable (consulta la documentación de función de vídeo escalable).

En las transmisiones que no utilizan vídeo escalable, la configuración de esta propiedad no tiene ningún efecto.

Nota: La resolución de las transmisiones de vídeo escalables se ajusta automáticamente para cada suscriptor, en función de las condiciones de la red y del uso de la CPU, incluso si no se configura esta propiedad. Configura esta propiedad si deseas establecer una resolución máxima para este suscriptor.

No todas las resoluciones están disponibles para los suscriptores. Cuando establezcas la resolución preferida, el OpenTok El SDK de Windows selecciona la mejor resolución disponible que se ajuste a tus limitaciones. Las resoluciones disponibles dependen de la anchura y la altura máximas que Editorial conjuntos para el flujo, que son devueltos por la función Stream.Width y Altura del arroyo propiedades del Transmisión objeto. Cada una de las resoluciones disponibles para una transmisión utilizará la misma relación de aspecto.

#### AudioVolume

Tipo: doble

{ get; set; }

El volumen de audio del abonado, entre 0 y 100. Al establecer el valor, si no se encuentra dentro de este intervalo, se ajustará a él.

El valor por defecto es 100.

#### PreferredFramerate

Tipo: flotante

{ get; set; }

Limitar la velocidad de fotogramas y la resolución de vídeo (PreferredResolution) reduce el uso de la red y de la CPU en el cliente suscrito. Es posible que te interese utilizar una resolución más baja en función de las dimensiones del vídeo del suscriptor en la aplicación. Quizá te interese utilizar una frecuencia de fotogramas o una resolución más baja para los suscriptores de una transmisión que sea menos importante (y más pequeña) que otras transmisiones.

Esta propiedad solo se aplica al suscribirse a un flujo que utilice el función de vídeo escalable. Hay vídeo escalable disponible:

  • Solo en las sesiones que utilizan el OpenTok Enrutador multimedia (sesiones con el modo multimedia enrutado).
  • Solo para transmisiones publicadas por clientes que admitan vídeo escalable (consulta la documentación de función de vídeo escalable).

En las transmisiones que no utilizan vídeo escalable, la configuración de esta propiedad no tiene ningún efecto.

Nota: La frecuencia de fotogramas de las transmisiones de vídeo escalables se ajusta automáticamente para cada suscriptor, en función de las condiciones de la red y del uso de la CPU, incluso si no se configura esta propiedad. Configura esta propiedad si deseas establecer una frecuencia de fotogramas máxima para este suscriptor.

Las velocidades de fotogramas disponibles se basan en el valor de la velocidad de fotogramas máxima disponible para la transmisión. Cuando se configura la velocidad de fotogramas preferida para el suscriptor, el OpenTok El SDK de Windows selecciona la mejor frecuencia de fotogramas disponible que más se aproxime a la frecuencia de fotogramas preferida, en función del ancho de banda del cliente y de las limitaciones de la CPU.

Las velocidades de fotogramas reales disponibles dependen, de forma dinámica, de los recursos de red y de la CPU de que disponga el editor.

enum VideoReason

Define los valores de las propiedades VideoEventArgs.Reason y VideoEventArgs.Reason.

Nombre Valor Descripción
PublishVideo 1 El incidente se produjo porque el emisor de la retransmisión comenzó o dejó de publicar el vídeo.
SubscriberToVideo 2 El evento se produjo porque el cliente local comenzó o dejó de suscribirse al servicio de vídeo.
Quality 3 Transmisión La calidad puede variar debido a las condiciones de la red o al uso de la CPU, tanto por parte del suscriptor como del editor. Cuando está habilitada, la función de recambio de audio genera un evento cuando el suscriptor interrumpe la transmisión de vídeo debido a una degradación de la calidad del vídeo, lo que da lugar a que el suscriptor envíe el evento «VideoDisabled». Cuando las condiciones mejoran, la transmisión de vídeo se reanuda, y el Suscriptor envía el evento «VideoEnabled». Cuando se interrumpe la transmisión de vídeo, el suscriptor sigue recibiendo la transmisión de audio, si la hay. En las sesiones enrutadas, el origen de este comportamiento puede ser el enrutador de medios de la Video API de Vonage (Suscriptor «Audio de reserva») o el cliente de publicación (Editorial Alternativa de audio). Cuando el cliente emisor es la fuente, la aplicación del suscriptor recibe el evento correspondiente «Session.StreamHasVideoChanged», lo que indica que el canal de vídeo al que está suscrito ya no está activo. En general, este comportamiento sugiere una degradación de la red por parte del editor; sin embargo, las métricas comunicadas por el suscriptor pueden influir en las decisiones de recambio del editor, lo que puede complicar la determinación de la fuente exacta de la degradación. En las sesiones retransmitidas, el evento «calidad» se activa exclusivamente debido a la lógica interna de recambio de audio del editor (Recambio de audio del editor). A esto no le sigue ningún evento adicional que indique que el vídeo está inactivo, ya que es posible que otros suscriptores con mejores condiciones de red sigan recibiendo la transmisión. Tenga en cuenta que, aunque el cambio a una alternativa proviene del editor en las sesiones retransmitidas, la degradación subyacente de la red puede producirse tanto en el lado del editor como en el del suscriptor.
CodecNotSupported 4 El problema con el vídeo se produjo porque el vídeo de la transmisión del suscriptor se desactivó, ya que la transmisión utiliza un códec de vídeo (como H.264) que no es compatible con el dispositivo.
CodecChange 8 Ha cambiado el códec de vídeo de la transmisión.
ResolutionChange 9 Cambio en la resolución del vídeo o en el número de capas. Esto puede deberse a limitaciones en la tasa de bits, a la adaptación del codificador, a cambios en la fuente de la cámara (como cambiar de cámara o modificar la resolución de entrada) o a cambios en la configuración. No implica necesariamente una pérdida de calidad.
VideoInterruption 10 Indica que la transmisión de vídeo al abonado se ha interrumpido durante un periodo prolongado (normalmente, más de cinco segundos). Cuando se produce una interrupción en la transmisión de vídeo, las aplicaciones pueden consultar el indicador «VideoStatsUpdated» para identificar los factores que la han provocado, como una baja tasa de bits o una latencia elevada.
SenderQualityRestriction 11 El remitente ha limitado la calidad del vídeo.

Métodos

Nombre Descripción
Subscriber(builder)
Dispose(disposing)
Dispose() Se ocupa de la Suscriptor los recursos del objeto.
GetRtcStatsReport() Consulta también AudioStatsUpdated, VideoStatsUpdated y Publisher.GetRtcStatsReport().

Suscriptor (constructor)

Parámetros:
Nombre Tipo Descripción
builder Constructor

Eliminar (eliminando)

Parámetros:
Nombre Tipo Descripción
disposing bool

Dispose()

Se ocupa de la Suscriptor los recursos del objeto.

GetRtcStatsReport()

Consulta también AudioStatsUpdated, VideoStatsUpdated y Publisher.GetRtcStatsReport().

Eventos

Conectado

event EventHandler Connected

Se invoca cuando la instancia se ha conectado correctamente al flujo y comienza a reproducir el contenido multimedia.

Conexión de streaming interrumpida

event EventHandler StreamDisconnected

Al ejecutarse este método, es posible que quieras mostrar una notificación en la interfaz de usuario para informar al usuario de que la transmisión de audio y vídeo se ha desconectado temporalmente y de que la aplicación está intentando volver a conectarse a la transmisión.

Si el cliente se vuelve a conectar a la transmisión, el Subscriber envía el evento StreamReconnected. De lo contrario, el Sesión El objeto envía el evento «Session.StreamDropped».

StreamReconnected

event EventHandler StreamReconnected

El Suscriptor envía este evento después de enviar el evento StreamDisconnected.

Texto de la leyenda

event EventHandler<CaptionTextArgs> CaptionText

Se envía cuando el flujo del suscriptor recibe el texto de los subtítulos.

Vídeo desactivado

event EventHandler<VideoEventArgs> VideoDisabled

Compruebe el reason propiedad de los argumentos del evento que indica el motivo por el que se detuvo el vídeo.

Compatible con vídeo

event EventHandler<VideoEventArgs> VideoEnabled

Compruebe el reason propiedad de los argumentos del evento que indica el motivo por el que se activó el vídeo.

Error

event EventHandler<ErrorEventArgs> Error

La mayoría de los errores son graves: el suscriptor se desconecta automáticamente y ya no se puede seguir utilizando. Algunos errores no impiden continuar y permiten seguir utilizando el suscriptor; cuando un error no es grave, así se indica en la descripción del error.

Desactivar advertencia de vídeo

event EventHandler VideoDisableWarning

Si la calidad sigue empeorando, el suscriptor desactiva el vídeo y el Suscriptor envía el mensaje «VideoDisabled». Si la calidad de la transmisión mejora, el Suscriptor envía el evento «VideoDisableWarningLifted».

Esta función sólo está disponible en las sesiones que utilizan la función OpenTok Enrutador multimedia (sesiones en las que el modo multimedia está configurado como «enrutado»), no en sesiones en las que el modo multimedia está configurado como «retransmitido». (Véase El OpenTok Media Router y los modos multimedia).

Este método se invoca principalmente cuando la calidad de la conexión se deteriora.

Se ha desactivado la advertencia sobre el vídeo

event EventHandler VideoDisableWarningLifted

Esta función sólo está disponible en las sesiones que utilizan la función OpenTok Enrutador multimedia (sesiones en las que el modo multimedia está configurado como «enrutado»), no en sesiones en las que el modo multimedia está configurado como «retransmitido». (Véase El OpenTok Media Router y los modos multimedia).

Este método se activa principalmente cuando mejora la calidad de la conexión.

Se ha modificado la calidad del vídeo

event EventHandler<VideoQualityChangedEventArgs> VideoQualityChanged

Este evento se activa cuando se producen cambios significativos en la calidad de la transmisión de vídeo del suscriptor, como la detección de una interrupción del vídeo (pausa) o un cambio de códec.

La implementación actual solo activa este evento en caso de interrupciones de vídeo o cambios de códec. Los bloqueos se registran internamente y se reflejan en las estadísticas, pero no activan este evento de forma individual debido a su corta duración y alta frecuencia. Solo se activa una llamada de retorno cuando se detecta una pausa (sin fotogramas reproducidos durante más de 5 segundos), ya que esto representa una interrupción más significativa de la reproducción.

El valor «VideoReason» especifica la causa del evento y sigue este orden de prioridad: VideoInterruption, CodecChange.

Este evento se diferencia de «VideoDisabled» y «VideoEnabled» en que informa de cambios relacionados con la calidad, en lugar de simples transiciones de activación o desactivación de la pista de vídeo. Los eventos «VideoDisabled» y «VideoEnabled» indican cuándo se ha desactivado o activado la pista de vídeo del suscriptor (por ejemplo, debido a un cambio a audio alternativo o a actualizaciones de las propiedades de la transmisión). Por el contrario, este evento proporciona información de diagnóstico sobre las causas de la degradación de la calidad, como los bloqueos, el número de pausas y las estadísticas de vídeo actualizadas.

Este evento tiene en cuenta cualquier interrupción de vídeo que dure cinco segundos o más. En situaciones como el cambio a audio de reserva o la desactivación del vídeo, la interrupción también se registra como una pausa en las estadísticas, y puede generarse el correspondiente evento de cambio de calidad.

Las aplicaciones pueden utilizar este evento para responder a problemas de calidad, como actualizar los indicadores de la interfaz de usuario, registrar datos de telemetría o notificar a los usuarios.

Cambio en el estado de la red

event EventHandler<NetworkConditionChangedEventArgs> NetworkConditionChanged

Este evento se activa cuando se producen cambios significativos en el estado de la red, y proporciona estadísticas sobre los enlaces de red junto con el motivo del cambio.

MediaLinkEstadísticasActualizado

event EventHandler<SubscriberMediaLinkStatsEventArgs> MediaLinkStatsUpdated

Se ejecuta periódicamente para generar informes sobre las estadísticas de enlaces multimedia del suscriptor.

Nivel de audio

event EventHandler<AudioLevelArgs> AudioLevel

Se envía periódicamente para informar del nivel de audio del abonado.

AudioData

event EventHandler<AudioDataEventArgs> AudioData

Se invoca periódicamente para comunicar los datos de audio del PCM del abonado.

Estadísticas de audio actualizadas

event EventHandler<AudioNetworkStatsEventArgs> AudioStatsUpdated

Se invoca cuando el suscriptor tiene estadísticas de audio que compartir.

Estadísticas de vídeo: Actualizado

event EventHandler<VideoNetworkStatsEventArgs> VideoStatsUpdated

Se activa cuando el suscriptor tiene estadísticas de vídeo que compartir.

RtcStatsReport

event EventHandler<RtcStatsReportArgs> RtcStatsReport

Se envía en respuesta a una llamada a GetRtcStatsReport().