OpenTok.Session
public class Session : IDisposable
El primer paso para utilizar el OpenTok El SDK de Windows sirve para 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 al método Dispose() de la 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.
Tipos anidados: OpenTok.Session.ConnectionEventArgs, OpenTok.Session.ErrorEventArgs, OpenTok.Session.SignalEventArgs, OpenTok.Session.StreamEventArgs, OpenTok.Session.ArchiveStartedEventArgs, OpenTok.Session.ArchiveStoppedEventArgs, OpenTok.Session.MuteForcedEventArgs, OpenTok.Session.Builder
Propiedades
| Nombre | Tipo | Descripción |
|---|---|---|
Connection |
Conexión | { get; } Devuelve el Conexión correspondiente a la conexión de este cliente a este Sesión. |
Capabilities |
Capacidades | { get; } Depende del rol asignado al token utilizado para conectarse a la sesión si el cliente solo puede suscribirse a flujos o si puede tanto publicar como suscribirse a ellos. |
Métodos
| Nombre | Descripción |
|---|---|
Session(builder) |
|
Connect(token) |
Cuando se establece la conexión de la sesión, el Sesión El objeto envía el evento «Connected». |
DisableForceMute() |
Una vez que se invoque el método ForceMuteAll (o cuando un moderador de otro cliente realice una llamada para silenciar todas las transmisiones), cualquier transmisión publicada tras la llamada de moderación se publicará con el audio silenciado. |
Disconnect() |
Como práctica recomendada, antes de llamar a este método, llama al método Unpublish(Publisher) para todos los editores y espera a que se produzca el evento Publisher.StreamDestroyed. |
Dispose(disposing) |
|
Dispose() |
Se ocupa de la Sesión los recursos del objeto. |
ForceDisconnect(connection) |
Aunque puedes utilizar el método ForceDisconnect para cortar tu propia conexión, es más sencillo llamar al método Disconnect. |
ForceMuteAll(excludedStreams) |
Además, cualquier flujo que se publique después de la llamada a la función ForceMuteAll() Los vídeos de este método se publican con el audio silenciado. |
ForceMuteStream(stream) |
Compruebe el CanForceMute propiedad del objeto Session.Capabilities para comprobar si puedes llamar a esta función correctamente. |
Publish(publisher) |
|
SendSignal(type, data, connection, retryAfterReconnect) |
|
SetEncryptionSecret(secret) |
Véase el Cifrado de extremo a extremo guía del desarrollador. |
Subscribe(subscriber) |
|
Unpublish(publisher) |
|
Unsubscribe(subscriber) |
Sesión (generador)
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
builder |
Constructor |
Conectar(token)
Cuando se establece la conexión de la sesión, el Sesión El objeto envía el evento «Connected».
Si la sesión no consigue conectarse, el Sesión El objeto envía el evento «Error».
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
token |
cadena | El token del usuario. Véase Visión general de la creación de tokens. |
DisableForceMute()
Una vez que se haya llamado al método ForceMuteAll (o cuando un moderador de otro cliente haya realizado una llamada para silenciar todas las transmisiones), cualquier transmisión publicada tras la llamada de moderación se publicará 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 evento «MuteForced», con el IsActive propiedad del MuteForcedEventArgs objeto que se va a establecer en false.
Compruebe el CanForceMute propiedad del objeto Session.Capabilities para comprobar si puedes llamar a esta función correctamente. Está reservada 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: : - Capacidades, Silenciar todo, Silenciamiento forzado
Desconectar()
Como buena práctica, antes de llamar a este método, llama al método Unpublish(Publisher) para todos los editores y espera a que se produzca el evento Publisher.StreamDestroyed. 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 para una posible reconexión.
Cuando se desconecta la sesión, el Sesión envía el evento «Desconectado».
Eliminar (eliminando)
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
disposing |
bool |
Dispose()
Se ocupa de la Sesión los recursos del objeto.
ForceDisconnect(conexió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, se activan los eventos «Disconnected», «ConnectionDropped» y «Publisher.StreamDestroyed» del mismo modo que si la conexión se hubiera cerrado por sí misma mediante «Disconnect».
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
connection |
Conexión | La conexión para desconectarse. |
ForceMuteAll(flujos excluidos)
Además, cualquier flujo que se publique después de la llamada a la función ForceMuteAll() Los flujos se publican con el audio silenciado. Puedes desactivar el estado de silencio de una sesión llamando al método DisableForceMute(). Una vez que hayas llamado al método DisableForceMute(), los nuevos flujos publicados 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 evento «MuteForced», con el IsActive propiedad del MuteForcedEventArgs objeto que se va a establecer en true.
Compruebe el CanForceMute propiedad del objeto Session.Capabilities para comprobar si puedes llamar a esta función correctamente. Está reservada 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:
| Nombre | Tipo | Descripción |
|---|---|---|
excludedStreams |
IEnumerable<Transmisión> | Flujos que se deben excluir de la solicitud de silenciamiento. Establece este valor en null (o no establezcas este parámetro) para silenciar todos los flujos de la sesión (incluidos los publicados por el cliente local). |
Véase: : - Capacidades, ForceMuteStream, DisableForceMute(), Session.MuteForced, Editor.SilenciarForzado
ForceMuteStream(stream)
Compruebe el CanForceMute propiedad del objeto Session.Capabilities para comprobar si puedes llamar a esta función correctamente. Está reservada 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:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
Transmisión | La transmisión que se va a silenciar. |
Véase: : - Capacidades, Silenciar todo, Editor.SilenciarForzado
Publicar (editor)
Parámetros:
SendSignal(tipo, datos, conexión, reintentoTrasReconexión)
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
type |
cadena | El tipo de la señal. El tipo se establece en el argumento SignalEventArgs.Type del detector de eventos Signal. |
data |
cadena | Los datos que se van a enviar. El límite de tamaño de los datos es de 8 kB. El tipo se establece en el argumento SignalEventArgs.Data del detector de eventos Signal. |
connection |
Conexión | |
retryAfterReconnect |
bool |
SetEncryptionSecret(secret)
Véase el Cifrado de extremo a extremo guía del desarrollador.
La sesión debe haberse configurado con cifrado de extremo a extremo mediante el SDK del servidor. Si ya se sabe que la sesión no cuenta con cifrado de extremo a extremo, este método lanza una excepción `OpenTokException` con `ErrorCode.EncryptionNotEnabled`, y todos los emisores y suscriptores existentes reciben el mismo error y se desconectan. Si aún no se sabe (por ejemplo, cuando el secreto se establece antes de que se conecte la sesión), este método se ejecuta correctamente y el error se notifica más tarde, al publicar o suscribirse.
Pase null o una cadena vacía restablece (borra) el secreto de cifrado establecido anteriormente. Siempre está permitido restablecer el secreto, incluso en una sesión de la que se sabe que no está cifrada de extremo a extremo.
Cualquier otro secreto debe tener una longitud de entre 8 y 256 bytes cuando esté codificado en UTF-8; de lo contrario, se lanzará una excepción OpenTokException con ErrorCode.InvalidEncryptionSecret.
Se aplica un nuevo secreto a los editores y suscriptores que ya están en funcionamiento, así como a los que se creen a partir de ese momento. Sin embargo, el restablecimiento del secreto solo surte efecto para los editores y suscriptores creados a partir de ese momento: los que ya están en funcionamiento siguen cifrando y descifrando con el secreto anterior hasta que se vuelvan a crear.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
secret |
cadena | Valor del secreto de cifrado, o null o una cadena vacía para restablecer el secreto de cifrado establecido anteriormente. |
Suscribirse (suscriptor)
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
Suscriptor | El abonado asociado a la transmisión que se va a recibir. |
Retirar de la publicación (editor)
Parámetros:
Darse de baja (suscriptor)
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
Suscriptor | El suscriptor al que quieres dar de baja. |
Eventos
Conectado
event EventHandler Connected
Se envía cuando el cliente se conecta al OpenTok sesión.
Desconectado
event EventHandler Disconnected
Se envía cuando el cliente se desconecta del OpenTok sesión.
Conexión creada
event EventHandler<ConnectionEventArgs> ConnectionCreated
El objeto ConnectionEventArgs.Connection 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 evento «Connected».
Se ha perdido la conexión
event EventHandler<ConnectionEventArgs> ConnectionDropped
El objeto ConnectionEventArgs.Connection 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 evento «Connected».
StreamReceived
event EventHandler<StreamEventArgs> StreamReceived
El objeto StreamEventArgs.Stream representa una instantánea del flujo en el momento de la llamada de retorno. Crea un Subscriber y llama al método Subscribe(Subscriber) para suscribirte al flujo.
StreamDropped
event EventHandler<StreamEventArgs> StreamDropped
El objeto StreamEventArgs.Stream 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).
Error
event EventHandler<ErrorEventArgs> Error
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 se envíe el evento «Desconectado».
Señal
event EventHandler<SignalEventArgs> Signal
Se invoca cuando se recibe una señal en la sesión.
StreamHasCaptionsChanged
event EventHandler<StreamEventArgs> StreamHasCaptionsChanged
Se activa cuando una transmisión de la sesión pasa de tener subtítulos a no tenerlos, o viceversa.
StreamHasAudioChanged
event EventHandler<StreamEventArgs> StreamHasAudioChanged
Se invoca cuando un flujo de la sesión pasa de tener audio a no tenerlo. El objeto `StreamEventArgs.Stream` representa una instantánea del flujo en el momento de la llamada de retorno.
StreamHasVideoChanged
event EventHandler<StreamEventArgs> StreamHasVideoChanged
Se invoca cuando una transmisión de la sesión pasa de tener vídeo a no tenerlo. El objeto `StreamEventArgs.Stream` representa una instantánea de la transmisión en el momento de la llamada de retorno.
StreamDimensionsChanged
event EventHandler<StreamEventArgs> StreamDimensionsChanged
Se invoca cuando cambian las dimensiones de vídeo de una transmisión en la sesión. El objeto `StreamEventArgs.Stream` representa una instantánea de la transmisión en el momento de la llamada de retorno.
Inicio de la reconexión
event EventHandler ReconnectionStart
Si el cliente puede volver a conectarse a la sesión, el Sesión El objeto envía el evento «ReconnectionSuccess». De lo contrario, si el cliente no puede volver a conectarse, el Sesión El objeto envía el evento «Disconnected».
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: : - Reconexión realizada con éxito, Desconectado
Reconexión realizada con éxito
event EventHandler ReconnectionSuccess
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.
De forma predeterminada, cualquier señal generada por el cliente local mediante el método SendSignal(string, string, Connection, bool) se envía cuando el cliente se vuelve a conectar. Para evitar que se envíen las señales generadas mientras el cliente estaba desconectado, configura el retryAfterReconnect parámetro del método SendSignal a false. (Todas las señales enviadas por otros clientes mientras tu cliente estaba desconectado se reciben al volver a conectarse.)
Véase: : - Inicio de la reconexión
Inicio del archivo
event EventHandler<ArchiveStartedEventArgs> ArchiveStarted
Se invoca cuando se inicia la grabación de un archivo de la sesión. En respuesta a este método, es posible que desees añadir una notificación en la interfaz de usuario (como un icono en el Editorial (vista) que indica que se está grabando la sesión.
Archivo: Detenido
event EventHandler<ArchiveStoppedEventArgs> ArchiveStopped
Se invoca cuando se detiene la grabación de un archivo de la sesión. En respuesta a este método, es posible que desees eliminar una notificación de la interfaz de usuario (como un icono en el Editorial (ver) la grabación de la sesión se ha detenido.
Silenciamiento forzado
event EventHandler<MuteForcedEventArgs> MuteForced
Se invoca cuando un moderador obliga a los clientes que publican flujos en la sesión a silenciar el audio (el IsActive propiedad del MuteForcedEventArgs El objeto está establecido en true), o cuando un moderador desactiva el estado de silencio de audio en la sesión (el IsActive propiedad del MuteForcedEventArgs El objeto está establecido en false).