Representa una sesión de la Video API de Vonage en la que participa el cliente. Más...

Heredan de IDisposable.

Descripción detallada

Representa una sesión de la Video API de Vonage en la que participa el cliente.

El primer paso para utilizar el SDK de Windows de la Video API de Vonage es crear una instancia de un Sesión objeto utilizando el Session.Builder clase.

El Sesión La clase implementa la interfaz System.IDisposable. Asegúrate de llamar a la Dispose() método del Sesión El objeto debe liberar sus recursos cuando ya no lo necesites (por ejemplo, al cerrar la aplicación o la ventana).

Ver también Creación de sesiones y Creación de fichas.

Documentación sobre funciones de miembro

Conectar()

Se conecta a la sesión de la Video API de Vonage proporcionada en el Sesión constructor, utilizando el token de autenticación facilitado.

Cuando se establece la conexión de la sesión, el Sesión El objeto envía el Conectado evento.

Si la sesión no consigue conectarse, el Sesión El objeto envía el Error evento.

Parámetros : | | | | --- | --- | | token | El token del usuario. Véase Visión general de la creación de tokens. |

DisableForceMute()

Desactiva el estado de silencio activo de la sesión. Una vez que se llame a este método, las nuevas transmisiones publicadas en la sesión ya no tendrán el audio silenciado.

Después de llamar a la Silenciar todo método (o cuando un moderador de otro cliente realiza una llamada para silenciar todas las transmisiones), las transmisiones publicadas tras la llamada de moderación se publican con el audio silenciado. Llama al DisableForceMute() Método para desactivar el estado de silencio de una sesión (de modo que las nuevas transmisiones publicadas no se silencien automáticamente).

Al llamar a este método, se produce el Sesión objeto en cada cliente conectado a la sesión para enviar el Silenciamiento forzado con el evento IsActive propiedad del MuteForcedEventArgs objeto que se va a establecer en false.

Compruebe el CanForceMute propiedad del Session.Capabilities objeto para comprobar si puedes llamar a esta función correctamente. Esto está reservado para los clientes que se hayan conectado con un token al que se le haya asignado el rol de moderador (consulta el Descripción general de la creación de tokens).

Véase Silenciar el audio de los flujos de una sesión.

Véase también : Capacidades, Silenciar todo, Silenciamiento forzado

Desconectar()

Se desconecta de esta sesión. Todo Suscriptor y Editorial Las instancias se desconectarán.

Como buena práctica, antes de llamar a este método, llama al Retirar de la publicación (Editor) método para todos los editores y esperar a que el Publisher.StreamDestroyed evento. Esto garantiza la eliminación completa de los editores, especialmente si los problemas de conectividad de red impiden dicha eliminación debido a la función de reconexión, que puede mantener activos los flujos de los editores a la espera de una posible reconexión.

Cuando se desconecta la sesión, el Sesión envía el Desconectado evento.

ForceDisconnect()

Obliga a un cliente a desconectarse de la sesión.

Aunque puedes utilizar el método `ForceDisconnect` para cortar tu propia conexión, es más sencillo llamar al método `Disconnect`. Se devolverá un error si el rol del usuario no incluye los permisos necesarios para forzar la desconexión de otros usuarios. El rol de un usuario se define al crear el token de usuario.

Cuando se cierra una conexión mediante este método, el Desconectado, Se ha perdido la conexión y los eventos Publisher.StramDestroyed se envían de la misma forma que si la conexión se hubiera interrumpido por sí misma mediante Disconnect.

Parámetros : | | | | --- | --- | | conexión | La conexión que se va a desconectar. |

ForceMuteAll()

Obliga a todos los emisores de la sesión (excepto a aquellos que emiten transmisiones excluidas) a silenciar el audio.

Además, cualquier flujo que se publique después de la llamada a la función ForceMuteAll() se publican con el audio silenciado. Puede eliminar el estado de silencio de una sesión llamando al método DisableForceMute() método. Una vez que hayas llamado al DisableForceMute() De esta forma, las nuevas retransmisiones publicadas en la sesión ya no tendrán el audio silenciado.

Al llamar a este método, se produce el Sesión objeto en cada cliente conectado a la sesión para enviar el Silenciamiento forzado con el evento IsActive propiedad del MuteForcedEventArgs objeto que se va a establecer en true.

Compruebe el CanForceMute propiedad del Session.Capabilities objeto para comprobar si puedes llamar a esta función correctamente. Esto está reservado para los clientes que se hayan conectado con un token al que se le haya asignado el rol de moderador (consulta el Descripción general de la creación de tokens).

Véase Silenciar el audio de los flujos de una sesión.

Parámetros : | | | | --- | --- | | excludedStreams | Flujos que se deben excluir de la solicitud de silenciamiento. Establece este valor en null (o no definas este parámetro) para silenciar todos los flujos de la sesión (incluidos los publicados por el cliente local). |

Véase también : Capacidades, ForceMuteStream, DisableForceMute(), Session.MuteForced, Editor.SilenciarForzado

ForceMuteStream()

Obliga al emisor de una transmisión determinada a silenciar su audio.

Compruebe el CanForceMute propiedad del Session.Capabilities objeto para comprobar si puedes llamar a esta función correctamente. Esto está reservado para los clientes que se hayan conectado con un token al que se le haya asignado el rol de moderador (consulta el Descripción general de la creación de tokens).

Véase Silenciar el audio de los flujos de una sesión.

Parámetros : | | | | --- | --- | | stream | La transmisión que se va a silenciar. |

Véase también : Capacidades, Silenciar todo, Editor.SilenciarForzado

Publicar()

Inicia un Editorial transmisión en directo a la sesión.

Parámetros : | | | | --- | --- | | editor | El Editorial que quieras transmitir a la sesión. |

SendSignal()

Envía una señal a todos los clientes de la sesión.

Parámetros : | | | | --- | --- | | tipo | El tipo de la señal. El tipo se establece en el SignalEventArgs.Type argumento del Señal escucha de eventos. | | datos | Los datos que se van a enviar. El tamaño máximo de los datos es de 8 kB. El tipo se establece en el SignalEventArgs.Data argumento del Señal escucha de eventos. | | conexión | | | reintentoTrasReconexión | |

SetEncryptionSecret()

Establece la clave de cifrado de extremo a extremo que utilizan todos los emisores y suscriptores.

Véase el Cifrado de extremo a extremo guía del desarrollador.

Parámetros : | | | | --- | --- | | secreto | Valor del secreto de cifrado. |

Suscribirse()

Iniciar la recepción y la reproducción de datos de transmisión de audio y vídeo para el abonado especificado.

Parámetros : | | | | --- | --- | | suscriptor | El suscriptor vinculado al flujo que se va a recibir. |

Despublicar()

Desconecta el Editorial de la sesión.

Parámetros : | | | | --- | --- | | editor | El Editorial para retirar la publicación. |

Cancelar suscripción()

Deja de suscribirse (de recibir una transmisión) a un suscriptor específico de la sesión.

Parámetros : | | | | --- | --- | | suscriptor | El suscriptor al que quieres dar de baja. |

Documentación del evento

Conexión creada

Se envía cuando otro cliente se conecta a la sesión.

El ConnectionEventArgs.Connection El objeto representa la conexión del cliente con la sesión. Ten en cuenta que este método se invoca cuando otros los clientes se conectan a la sesión. Cuando tu propio Cuando el cliente se conecta, el Sesión envía el Conectado evento.

Se ha perdido la conexión

Se envía cuando otro cliente abandona la sesión.

El ConnectionEventArgs.Connection El objeto representa la conexión anterior del cliente a la sesión. Ten en cuenta que este método se invoca cuando otros los clientes se marchan de la sesión. Cuando tu propio Cuando el cliente se desconecta, el Sesión El objeto envía el Conectado evento.

Error

Se envía cuando se produce un error al conectarse o mientras se está conectado a la sesión.

Este evento se envía si falla el intento de conectarse a la sesión. También se envía si la conexión a la sesión se interrumpe debido a un error tras una conexión correcta; en este caso, el evento se envía justo antes de que el Desconectado se envía el evento.

Inicio de la reconexión

Se envía cuando el cliente local ha perdido la conexión con una sesión de la Video API de Vonage y está intentando volver a conectarse. Esto se debe a una pérdida de conectividad de red.

Si el cliente puede volver a conectarse a la sesión, el Sesión El objeto envía el Reconexión realizada con éxito evento. De lo contrario, si el cliente no puede volver a conectarse, el Sesión El objeto envía el Desconectado evento.

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

Véase también : Reconexión realizada con éxito, Desconectado

Reconexión realizada con éxito

Se invoca cuando el cliente local se ha vuelto a conectar a la sesión de la Video API de Vonage tras haber perdido temporalmente la conexión a la red.

Cuando se pierde la conexión, el Sesión El objeto envía el Session.ReconnectionStart evento, antes de enviar el Session.ReconnectionSuccess evento. Si el cliente no puede volver a conectarse a la sesión, el Sesión El objeto envía el Sesión desconectada evento.

Los editores y suscriptores existentes se vuelven a conectar automáticamente cuando el cliente se vuelve a conectar y se invoca este método.

Por defecto, cualquier señal iniciada por el cliente local mediante el SendSignal(cadena, cadena, Conexión, bool) Las señales de este método se envían cuando el cliente se vuelve a conectar. Para evitar que se envíen las señales iniciadas mientras se estaba desconectado, configura el retryAfterReconnect del SendSignal método para false. (Todas las señales enviadas por otros clientes mientras tu cliente estaba desconectado se reciben al volver a conectarse.)

Véase también : Inicio de la reconexión

StreamDropped

Enviado el otro El cliente deja de publicar una transmisión en esta sesión de la Video API de Vonage.

El StreamEventArgs.Stream El objeto representa una instantánea del flujo en el momento de la llamada de retorno. Se puede utilizar para identificar el correspondiente Suscriptor (si es que hay alguno).

StreamReceived

Se envía cuando se publica una nueva transmisión por parte de otro cliente en esta sesión de la Video API de Vonage.

El StreamEventArgs.Stream El objeto representa una instantánea del flujo en el momento de la llamada de retorno. Crea un Suscriptor y llama al Suscribirse (Suscriptor) método para suscribirse a la transmisión.