com.opentok.android.Session
clase pública Session extende Observable
Representa una sesión de OpenTok en la que participa el cliente. El primer paso para utilizar el SDK de OpenTok para Android consiste en inicializar una instancia de Session mediante la llamada al constructor Session().
Al crear la instancia de Session, se deben introducir el ID de sesión de OpenTok, el token y la clave API. Se obtiene una clave API al registrarse para crear un Account de OpenTok. A efectos de prueba, puedes generar identificadores de sesión y tokens de prueba iniciando sesión en tu Cuenta API de Video de Vonage. Utiliza el Bibliotecas de OpenTok para el lado del servidor para generar identificadores de sesión y tokens en tu aplicación de envíos.
Véase también: : - Sesión Creación - Token Creación
Resumen de clases anidadas
Clases anidadas
Modificador y tipo
Clase
Descripción
static interface
Session.ArchiveListener
Supervisa cuándo comienza y cuándo finaliza la grabación de archivo de la sesión.
static class
Session.Builder
static class
Session.Capabilities
Define el valor devuelto por la getCapabilities() método.
protected static class
Session.ConfigurableSessionOptions
static interface
Session.ConnectionListener
Supervisa cuándo otros clientes se conectan y se desconectan de la sesión.
static interface
Session.MuteListener
Supervisa cuándo un moderador silencia las transmisiones de la sesión o desactiva el estado de silencio en la sesión.
static interface
Session.ReconnectionListener
Supervisa cuándo un cliente intenta volver a conectarse automáticamente tras perder la conexión con una sesión de OpenTok.
static interface
Session.SessionListener
Supervisa los cambios de estado en un Session objeto.
static class
Session.SessionOptions
Una clase base para definir opciones avanzadas de sesión con el
Session.Builder.sessionOptions(Session.SessionOptions sessionOptions) método.
static interface
Session.SessionOptionsProvider
En desuso.
static interface
Session.SignalListener
Supervisa cuándo se envía una señal en la sesión.
static interface
Session.StreamCaptionsPropertiesListener
Supervisa los cambios en las propiedades de los subtítulos de las transmisiones de la sesión.
static interface
Session.StreamPropertiesListener
Supervisa los cambios que se producen en las propiedades de los flujos de la sesión.
Resumen del campo
Campos
Modificador y tipo
Campo
Descripción
protected String
apiKey
protected URL
apiUrl
protected Session.ArchiveListener
archiveListener
protected Session.ConnectionListener
connectionListener
protected android.content.Context
context
protected Session.MuteListener
muteListener
protected Session.ReconnectionListener
reconnectionListener
protected String
sessionId
protected Session.SessionListener
sessionListener
protected Session.SignalListener
signalListener
protected Session.StreamCaptionsPropertiesListener
streamCaptionsPropertiesListener
protected Session.StreamPropertiesListener
streamPropertiesListener
Resumen del constructor
Constructores
Modificador
Constructor
Descripción
protected
Session(Session.Builder builder)
Resumen del método
Todos los métodosMétodos de instanciaMétodos concretos
Modificador y tipo
Método
Descripción
void
connect(String token)
Se conecta a la sesión de OpenTok proporcionada en el constructor de la sesión, utilizando el token de autenticación facilitado.
void
disableForceMute()
Desactiva el estado de silencio activo de la sesión.
void
disconnect()
Te desconecta de esta sesión.
protected void
finalize()
El recolector de basura lo invoca cuando determina que ya no hay referencias al objeto Session.
void
forceDisconnect(Connection connection)
Obliga a un cliente a desconectarse de la sesión.
void
forceMuteAll(Iterable<Stream> excludedStreams)
Obliga a todos los emisores de la sesión (excepto a aquellos que emiten transmisiones excluidas) a silenciar el audio.
void
forceMuteStream(Stream stream)
Obliga al emisor de una transmisión determinada a silenciar su audio.
Session.Capabilities
getCapabilities()
Indica si el cliente puede publicar y suscribirse a flujos en la sesión, en función del rol asignado al token utilizado para conectarse a la sesión.
Connection
getConnection()
Devuelve el Connection correspondiente a la conexión de este cliente
a esta sesión.
String
getSessionId()
Devuelve el ID de sesión pasado durante la instanciación.
protected void
onArchiveStarted(String id, String name)
Se invoca cuando un archivo de la sesión comienza a grabarse.
protected void
onArchiveStopped(String id)
Se invoca cuando se detiene la grabación de un archivo de la sesión.
protected void
onConnected()
Se invoca cuando el cliente se conecta a la sesión de OpenTok.
protected void
onConnectionCreated(Connection connection)
Se invoca cuando otro El cliente se conecta a la sesión.
protected void
onConnectionDestroyed(Connection connection)
Se activa cuando otro cliente abandona la sesión.
protected void
onDisconnected()
Se invoca cuando el cliente ya no está conectado a la sesión de OpenTok .
protected void
onError(OpentokError error)
Se activa cuando surge un error al conectarse o mientras se está conectado a la sesión.
protected void
onMuteForced(MuteForcedInfo info)
Se activa cuando un moderador silencia las transmisiones de la sesión o desactiva el estado de silencio en la sesión.
void
onPause()
Llama a este método cuando se pause la actividad de la aplicación.
protected void
onReconnected()
Se invoca cuando el cliente local se ha vuelto a conectar a la sesión de OpenTok tras haber perdido temporalmente la conexión a la red.
protected void
onReconnecting()
Se invoca cuando el cliente local ha perdido la conexión con una sesión de OpenTok y está intentando volver a conectarse.
void
onResume()
Llama a este método cuando se reanude la actividad de la aplicación.
protected void
onSignalReceived(String type, String data, Connection connection)
Se invoca cuando se recibe una señal en la sesión.
protected void
onStreamDropped(Stream stream)
Se invoca cuando otro El cliente deja de publicar un flujo en esta sesión de OpenTok.
protected void
onStreamHasAudioChanged(Stream stream, int hasAudio)
Se invoca cuando una transmisión de la sesión pasa de tener audio a no tenerlo.
protected void
onStreamHasCaptionsChanged(Stream stream, int hasCaptions)
Se invoca cuando un flujo de la sesión pasa de tener subtítulos a no tenerlos.
protected void
onStreamHasVideoChanged(Stream stream, int hasVideo)
Se invoca cuando una transmisión de la sesión pasa de tener vídeo a no tenerlo.
protected void
onStreamReceived(Stream stream)
Se activa cuando se publica un nuevo flujo por parte de otro cliente en esta sesión de OpenTok.
protected void
onStreamVideoDimensionsChanged(Stream stream, int width, int height)
Se invoca cuando cambian las dimensiones de vídeo de una transmisión en la sesión.
protected void
onStreamVideoTypeChanged(Stream stream, int videoType)
Se invoca cuando cambia el tipo de vídeo de una transmisión en la sesión.
void
publish(PublisherKit publisher)
Inicia la transmisión de un Publisher a la sesión.
String
reportIssue()
Informa de que tu aplicación ha tenido un problema.
void
sendSignal(String type, String data)
Envía una señal a todos los clientes de una sesión.
void
sendSignal(String type, String data, boolean retryAfterReconnect)
Envía una señal a todos los clientes de una sesión.
void
sendSignal(String type, String data, Connection connection)
Envía una señal a un cliente concreto dentro de una sesión.
void
sendSignal(String type, String data, Connection connection, boolean retryAfterReconnect)
Envía una señal a un cliente concreto dentro de una sesión. Esta versión del método incluye
un retryAfterReconnect parámetro.
void
setArchiveListener(Session.ArchiveListener listener)
Establece un Session.ArchiveListener objeto para supervisar cuándo se inicia
o se detiene una grabación de archivo en esta sesión.
void
setConnectionListener(Session.ConnectionListener listener)
Establece un Session.ConnectionListener objeto para supervisar cuándo otros clientes
se conectan y se desconectan de esta sesión.
void
setEncryptionSecret(String secret)
Establece la clave de cifrado de extremo a extremo que utilizan todos los emisores y suscriptores.
void
setMuteListener(Session.MuteListener listener)
Establece un Session.MuteListener objeto que se supervisará cuando se envíe la orden de
silenciamiento forzado en esta sesión.
void
setReconnectionListener(Session.ReconnectionListener listener)
Establece un Session.ReconnectionListener objeto al que se debe enviar una notificación cuando el cliente
intente volver a conectarse o se haya vuelto a conectar a una sesión de OpenTok.
void
setSessionListener(Session.SessionListener listener)
Establece un Session.SessionListener objeto para supervisar los cambios de estado de este
objeto Session.
void
setSignalListener(Session.SignalListener listener)
Establece un Session.SignalListener objeto que se va a supervisar cuando se
envíen señales en esta sesión.
void
setStreamCaptionsPropertiesListener(Session.StreamCaptionsPropertiesListener listener)
Establece un Session.StreamCaptionsPropertiesListener objeto para supervisar las propiedades
de la propiedad «captions» del flujo.
void
setStreamPropertiesListener(Session.StreamPropertiesListener listener)
Establece un Session.StreamPropertiesListener objeto para supervisar los cambios en las propiedades
de los flujos de esta sesión.
void
subscribe(SubscriberKit subscriber)
Iniciar la recepción y la reproducción de datos de transmisión de audio y vídeo para el usuario especificado.
void
unpublish(PublisherKit publisher)
Desconecta al editor de la sesión.
void
unsubscribe(SubscriberKit subscriber)
Deja de suscribirse (de recibir una transmisión) a un suscriptor específico en la sesión.
Métodos heredados de la clase java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged
Métodos heredados de la clase java.lang.Objeto
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Detalles del campo
sessionListener
protegido Session.SessionListener sessionListener
connectionListener
protegido Session.ConnectionListener connectionListener
streamPropertiesListener
protegido Session.StreamPropertiesListener streamPropertiesListener
streamCaptionsPropertiesListener
protegido Session.StreamCaptionsPropertiesListener streamCaptionsPropertiesListener
signalListener
protegido Session.SignalListener signalListener
archiveListener
protegido Session.ArchiveListener archiveListener
reconnectionListener
protegido Session.ReconnectionListener reconnectionListener
muteListener
protegido Session.MuteListener muteListener
contexto
protected android.content.Context context
apiKey
protegido Cadena apiKey
sessionId
protegido Cadena sessionId
apiUrl
protegido URL apiUrl
Datos del constructor
Sesión
sesión protegida(Session.Builder constructor) lanza Excepción
Lanzamientos:
: Exception
Detalles del método
getConnection
público Conexión getConnection()
Devuelve el Connection correspondiente a la conexión de este cliente
a esta sesión.
Cuando se crea un Stream, el
Session.SessionListener.onStreamReceived(Session session, Stream stream)
se invoca el método. Compara el objeto Connection devuelto por el
Stream.getConnection() método con el objeto Connection devuelto
por Sesssion.getConnection() para comprobar si tu cliente ha publicado
la nueva transmisión.
Devuelve: : El identificador de sesión de OpenTok correspondiente a esta instancia.
Véase también:
: - Session.SessionListener.onConnected(Session session)
- Session.SessionListener.onStreamReceived(Session session, Stream stream)
- Stream.getConnection()
getSessionId
público Cadena getSessionId()
Devuelve el ID de sesión pasado durante la instanciación.
Devuelve: : El identificador de sesión de OpenTok correspondiente a esta instancia.
setSessionListener
public void setSessionListener(Session.SessionListener oyente)
Establece un Session.SessionListener objeto para supervisar los cambios de estado de este
objeto Session.
Parámetros:
: listener - El Session.SessionListener instancia.
setConnectionListener
public void setConnectionListener(Session.ConnectionListener oyente)
Establece un Session.ConnectionListener objeto para supervisar cuándo otros clientes
se conectan y se desconectan de esta sesión.
Parámetros:
: listener - El Session.ConnectionListener instancia.
setStreamPropertiesListener
public void setStreamPropertiesListener(Session.StreamPropertiesListener oyente)
Establece un Session.StreamPropertiesListener objeto para supervisar los cambios en las propiedades
de las transmisiones de esta sesión. Entre ellas se incluyen las propiedades que indican si
la transmisión tiene audio, si tiene vídeo y cuáles son las dimensiones del vídeo.
Parámetros:
: listener - El Session.StreamPropertiesListener instancia.
setStreamCaptionsPropertiesListener
public void setStreamCaptionsPropertiesListener(Session.StreamCaptionsPropertiesListener oyente)
Establece un Session.StreamCaptionsPropertiesListener objeto para supervisar las propiedades
de la propiedad «captions» del flujo.
Parámetros:
: listener - El Session.StreamCaptionsPropertiesListener instancia.
setSignalListener
public void setSignalListener(Session.SignalListener oyente)
Establece un Session.SignalListener objeto que se va a supervisar cuando se
envíen señales en esta sesión.
Parámetros:
: listener - El Session.SignalListener instancia.
setArchiveListener
public void setArchiveListener(Session.ArchiveListener oyente)
Establece un Session.ArchiveListener objeto para supervisar cuándo se inicia
o se detiene una grabación de archivo en esta sesión.
Parámetros:
: listener - El Session.ArchiveListener instancia.
setReconnectionListener
public void setReconnectionListener(Session.ReconnectionListener oyente)
Establece un Session.ReconnectionListener objeto al que se debe enviar una notificación cuando el cliente
intente volver a conectarse o se haya vuelto a conectar a una sesión de OpenTok.
Parámetros:
: listener - El Session.ReconnectionListener instancia.
setMuteListener
public void setMuteListener(Session.MuteListener oyente)
Establece un Session.MuteListener objeto que se supervisará cuando se envíe la orden de
silenciamiento forzado en esta sesión.
Parámetros:
: listener - El Session.MuteListener instancia.
conectar
public void connect(Cadena token)
Se conecta a la sesión de OpenTok proporcionada en el constructor de la sesión, utilizando el token de autenticación facilitado.
Cuando se establece la conexión de la sesión, el
Session.SessionListener.onConnected(Session session) se
invoca el método.
Si la sesión no consigue conectarse, el
Session.SessionListener.onError(Session session, OpentokError error)
se llama el método.
Parámetros:
: token - El token del usuario. Véase Token
Descripción general de la creación.
desconectar
public void desconectar()
Se desconecta de esta sesión. Todas las instancias de Suscriptor y Editor
se desconectarán. Como práctica recomendada, antes de llamar a este método,
llama al unpublish(PublisherKit) método para todos los editores
y esperar a que el PublisherKit.onStreamDestroyed(Stream)
función de devolución de llamada. 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
Session.SessionListener.onDisconnected(Session session) se
invoca el método.
onPause
public void onPause()
Llama a este método cuando la actividad de la aplicación se ponga en pausa. Esto pone en pausa el renderizador y el capturador de vídeo de cualquier emisor de la sesión. También pone en pausa los renderizadores de vídeo de todos los suscriptores.
Las cámaras utilizadas por los editores de OpenTok ahora se liberan al llamar a este método.
Los editores vuelven a adquirir el control de las cámaras al llamar al onResume() método.
onResume
public void onResume()
Llama a este método cuando se reanude la actividad de la aplicación. Esto reanuda el renderizador y el capturador de vídeo de cualquier editor en la sesión. También reanuda los renderizadores de vídeo de todos los suscriptores.
Cualquier cámara (utilizada por los editores de OpenTok) que se hubiera lanzado al mercado cuando
llamaste al onPause() Los métodos se vuelven a adquirir al llamar a
Session.onResume().
publicar
public void publicar(PublisherKit editor)
Inicia la transmisión de un Publisher a la sesión.
Parámetros:
: publisher - El Publisher al que quieres transmitir la sesión.
despublicar
public void retirar-publicación(PublisherKit editor)
Desconecta al editor de la sesión.
Parámetros:
: publisher - El editor debe retirar la publicación.
suscríbase a
public void suscribirse(SubscriberKit suscriptor)
Iniciar la recepción y la reproducción de datos de transmisión de audio y vídeo para el usuario especificado.
Parámetros:
: subscriber - El abonado asociado a la transmisión que se va a recibir.
darse de baja
public void darse de baja(SubscriberKit suscriptor)
Deja de suscribirse (de recibir una transmisión) a un suscriptor específico en la sesión.
Parámetros:
: subscriber - El suscriptor al que quieres dar de baja.
sendSignal
public void enviarSeñal(Cadena tipo, Cadena datos)
Envía una señal a todos los clientes de una sesión.
Parámetros:
: type - El tipo de señal. El tipo también se establece en el
Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) método.
: data - Los datos que se van a enviar. El límite de tamaño de los datos es de 8 kB.
Véase también:
: - sendSignal(String type, String data, Connection connection)
- sendSignal(String type, String data, boolean retryAfterReconnect)
- Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)
sendSignal
public void enviarSeñal(Cadena tipo, Cadena datos, booleano reintentarTrasReconexión)
Envía una señal a todos los clientes de una sesión. Esta versión del método incluye
un retryAfterReconnect parámetro.
Parámetros:
: type - El tipo de señal. El tipo también se establece en el
Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)
método.
: data - Los datos que se van a enviar. El límite de tamaño de los datos es de 8 kB.
: retryAfterReconnect - Al volver a conectarse a la sesión, si se deben enviar las señales que
se iniciaron mientras se estaba desconectado. Si el cliente pierde la conexión
con la sesión de OpenTok debido a una interrupción en la conectividad de red, el cliente
intenta volver a conectarse a la sesión, y el
Session.ReconnectionListener.onReconnecting(Session session) método
se invoca. Por defecto, las señales generadas mientras el cliente está desconectado
se envían cuando (y si) el cliente se vuelve a conectar a la sesión de OpenTok.
Puedes evitarlo configurando el retryAfterReconnect
parámetro a false. (El valor por defecto es true.)
Véase también:
: - sendSignal(String type, String data)
- Session.ReconnectionListener.onReconnecting(Session session)
- Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)
sendSignal
public void enviarSeñal(Cadena tipo, Cadena datos, Conexión conexión)
Envía una señal a un cliente concreto dentro de una sesión.
Parámetros:
: type - El tipo de señal. El tipo también se establece en el
Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) método.
: data - Los datos que se van a enviar. El límite de tamaño de los datos es de 8 kB.
: connection - Un objeto Connection. El objeto Connection representa la
conexión de un cliente a la sesión. Se trata del cliente al
que se envía el mensaje. (Véase
Session.ConnectionListener.onConnectionCreated(Session session, Connection connection) y Connection.
Véase también:
: - sendSignal(String type, String data)
- sendSignal(String type, String data, Connection connection, boolean retryAfterReconnect)
- Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)
sendSignal
public void enviarSeñal(Cadena tipo, Cadena datos, Conexión conexión, booleano reintentarTrasReconexión)
Envía una señal a un cliente concreto dentro de una sesión. Esta versión del método incluye
un retryAfterReconnect parámetro.
Parámetros:
: type - El tipo de señal. El tipo también se establece en el
Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) método.
: data - Los datos que se van a enviar. El límite de tamaño de los datos es de 8 kB.
: connection - Un objeto Connection. El objeto Connection representa la
conexión de un cliente a la sesión. Se trata del cliente al
que se envía el mensaje. (Véase
Session.ConnectionListener.onConnectionCreated(Session session, Connection connection) y Connection.
: retryAfterReconnect - Al volver a conectarse a la sesión, si se deben enviar las señales que
se iniciaron mientras se estaba desconectado. Si el cliente pierde la conexión
con la sesión de OpenTok debido a una interrupción en la conectividad de red,
el cliente intenta volver a conectarse a la sesión, y el
Session.ReconnectionListener.onReconnecting(Session session) método
se invoca. Por defecto, las señales generadas mientras se está desconectado se envían
cuando (y si) el cliente se vuelve a conectar a la sesión de OpenTok. Puedes
evitarlo configurando el retryAfterReconnect parámetro
a false. (El valor por defecto es true.)
Véase también:
: - sendSignal(String type, String data)
- sendSignal(String type, String data, Connection connection)
- sendSignal(String type, String data, boolean retryAfterReconnect)
- Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)
getCapabilities
público Session.Capabilities getCapabilities()
Indica si el cliente puede publicar y suscribirse a flujos en la sesión, en función
del rol asignado al token utilizado para conectarse a la sesión. Este método devuelve
null hasta que te hayas conectado a una sesión y el
Session.SessionListener.onConnected(Session session) Se ha llamado al método.
informar de un problema
público Cadena reportIssue()
Informa de que tu aplicación ha tenido un problema. Puedes utilizar el ID del problema con el Inspector o cuando se trate un asunto con el equipo de atención al cliente de TokBox.
Resultados: : El ID asociado a la incidencia.
forceDisconnect
public void forceDisconnect(@NonNull Conexión conexión)
Obliga al cliente a desconectarse de la sesión.
Aunque puedes utilizar forceDisconnect(Connection)
Para cerrar la conexión, es más sencillo llamar al método «disconnect».
Se devuelve un error si el rol del cliente no incluye los permisos
necesarios para forzar la desconexión de otros usuarios. El rol de un cliente se define
al crear el token de usuario. Cuando se cierra una conexión mediante
este método, Session.SessionListener.onDisconnected(Session),
onConnectionDestroyed(Connection)
y PublisherKit.onStreamDestroyed(Stream)
Las funciones de devolución de llamada se ejecutan del mismo modo que si la
conexión se hubiera cerrado por sí misma mediante disconnect().
Parámetros:
: connection - La conexión que hay que desconectar.
forceMuteStream
public void forceMuteStream(@NonNull Transmisión (flujo)
Obliga al emisor de una transmisión determinada a silenciar su audio.
Compruebe el canForceMute propiedad del objeto devuelto al llamar a
getCapabilities() 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
Creación de fichas
(documentación).
Parámetros:
: stream - El objeto que representa la transmisión para la solicitud de silenciamiento forzado.
Esto incluye la transmisión que debe silenciarse.
Véase también:
: - getCapabilities()
- forceMuteAll(Iterable)
- PublisherKit.onMuteForced()
- Silenciar el audio
de las transmisiones en una sesión
forceMuteAll
public void forzarSilencioGeneral(@Nullable Iterable<Transmisión> excludedStreams)
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() método
se publican con el audio silenciado. Puedes desactivar el silencio de una sesión llamando al
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 Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info)
método que se invocará en cada cliente conectado a la sesión, con el getActive()
método del info objeto que devuelve true.
Compruebe el canForceMute propiedad del objeto devuelto al llamar a
getCapabilities() 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
Creación de fichas
(documentación).
Parámetros:
: excludedStreams - El objeto que representa las transmisiones que deben excluirse de la solicitud de
silenciamiento forzado. Esto incluye la transmisión que no debe silenciarse.
Véase también:
: - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info)
- getCapabilities()
- disableForceMute()
- forceMuteStream(Stream stream)
- Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info)
- PublisherKit.onMuteForced()
- Silenciar el audio
de las transmisiones en una sesión
desactivar el silenciamiento forzado
public void desactivarSilenciamientoForzado()
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 forceMuteAll(Iterable)
método (o cuando un moderador de otro cliente realiza una llamada para silenciar todas las transmisiones), cualquier transmisión
publicada tras la llamada de moderación se publica con el audio silenciado. Llama al
disableForceMute() Método para desactivar el estado de silencio de una sesión
(para que las nuevas transmisiones publicadas no se silencien automáticamente).
Al llamar a este método, se produce el Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info)
método que se va a llamar, con el getActive() método del info objeto
que devuelve false.
Compruebe el canForceMute propiedad del objeto devuelto al llamar a
getCapabilities() 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
Creación de fichas
(documentación).
Véase también:
: - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info)
- getCapabilities()
- forceMuteAll(Iterable)
- Silenciar el audio
de las transmisiones en una sesión
establecerSecretoDeCifrado
public void establecerSecretoDeCifrado(Cadena (secreto)
Establece la clave de cifrado de extremo a extremo que utilizan todos los emisores y suscriptores.
Véase el Guía para desarrolladores sobre el cifrado de extremo a extremo.
Parámetros:
: secret - Valor del secreto de cifrado.
onArchiveStarted
protected void onArchiveStarted(Cadena id, Cadena nombre)
Se invoca cuando se inicia la grabación de un archivo de la sesión. En respuesta a este método, puede que te interese añadir una notificación en la interfaz de usuario (como un icono en la vista «Publisher») que indique que la sesión se está grabando.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onArchiveStarted() método de la interfaz
Session.ArchiveListener.
Parámetros:
: id - El identificador único del archivo.
: name - El nombre del archivo (si se le asignó uno al crearlo).
onArchiveStopped
protected void onArchiveStopped(Cadena id)
Se invoca cuando se detiene la grabación de un archivo de la sesión. En respuesta a este método, puede que desees eliminar una notificación de la interfaz de usuario (como un icono en la vista «Publisher») que indique que la grabación de la sesión se ha detenido.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onArchiveStopped() método de la interfaz
Session.ArchiveListener.
Parámetros:
: id - El identificador único del archivo.
onStreamHasAudioChanged
protected void onStreamHasAudioChanged(Transmisión stream, int hasAudio)
Se invoca cuando una transmisión de la sesión pasa de tener audio a no tenerlo.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onStreamHasAudioChanged() método de la interfaz Session.StreamPropertiesListener
.
Parámetros:
: stream - El arroyo.
: hasAudio - Si la transmisión tiene audio (true) o no (
false).
onStreamHasCaptionsChanged
protected void onStreamHasCaptionsChanged(Transmisión stream, int hasCaptions)
Se invoca cuando un flujo de la sesión pasa de tener subtítulos a no tenerlos.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onStreamHasCaptionsChanged() método de la interfaz Session.StreamPropertiesListener
.
Parámetros:
: stream - El arroyo.
: hasCaptions - Si la retransmisión tiene subtítulos (true) o no (
false).
onStreamHasVideoChanged
protected void onStreamHasVideoChanged(Transmisión stream, int tieneVídeo)
Se invoca cuando una transmisión de la sesión pasa de tener vídeo a no tenerlo.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onStreamHasVideoChanged() método de la interfaz Session.StreamPropertiesListener
.
Parámetros:
: stream - El arroyo.
: hasVideo - Si la transmisión incluye vídeo (true) o no (
false).
onStreamVideoDimensionsChanged
protected void onStreamVideoDimensionsChanged(Transmisión stream, int width, int height)
Se invoca cuando cambian las dimensiones de vídeo de una transmisión en la sesión.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onStreamVideoDimensionsChanged() método de la interfaz Session.StreamPropertiesListener
.
Parámetros:
: stream - El arroyo.
: width - El nuevo ancho del arroyo, en píxeles.
: height - La nueva altura del flujo, en píxeles.
onStreamVideoTypeChanged
protected void onStreamVideoTypeChanged(Transmisión stream, int videoType)
Se invoca cuando cambia el tipo de vídeo de una transmisión en la sesión.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onStreamVideoTypeChanged() método de la interfaz Session.StreamPropertiesListener
.
Parámetros:
: stream - El arroyo.
: videoType - El nuevo tipo de vídeo de la transmisión.
onConnectionCreated
protected void onConnectionCreated(Conexión conexión)
Se invoca cuando otro El cliente se conecta a la sesión. El
objeto `Connection` representa la conexión del cliente a 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
Session.SessionListener.onConnected(Session session) Se llama
al método.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onConnectionCreated() método de la interfaz Session.ConnectionListener
.
Parámetros:
: connection - La nueva conexión en la sesión.
onConnectionDestroyed
protected void onConnectionDestroyed(Conexión conexión)
Se invoca cuando otro cliente abandona la sesión. El objeto Connection
representa la conexión anterior del cliente a la sesión. Cuando tu
propio Cuando el cliente se desconecta, el
Session.SessionListener.onDisconnected(Session session)
se llama el método.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onConnectionDestroyed() método de la interfaz Session.ConnectionListener
.
Parámetros:
: connection - La conexión que abandonó la sesión.
onSignalReceived
protected void onSignalReceived(Cadena tipo, Cadena datos, Conexión conexión)
Se invoca cuando se recibe una señal en la sesión.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onSignalReceived() método de la interfaz Session.SignalListener
.
Parámetros:
: type - La cadena de tipo de la señal.
: data - Los datos de la señal.
: connection - La conexión que identifica al cliente que envió el
mensaje. Este valor puede ser null.
Al volver a conectarse
protected void onReconnecting()
Se invoca cuando el cliente local ha perdido la conexión con una sesión de OpenTok 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
Session.ReconnectionListener.onReconnected(Session session) se llama al método.
De lo contrario, si el cliente no puede volver a conectarse, el
Session.SessionListener.onDisconnected(Session session) se llama al método.
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 interrumpido temporalmente.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onReconnecting() método de la interfaz Session.ReconnectionListener
.
Véase también:
: - onReconnected()
onReconnected
protected void onReconnected()
Se invoca cuando el cliente local se ha vuelto a conectar a la sesión de OpenTok tras haber
perdido temporalmente la conexión a la red. Cuando se pierde la conexión, el
Session.ReconnectionListener.onReconnecting(Session session) se llama al método,
antes de la Session.ReconnectionListener.onReconnected(Session session)
método. Si el cliente no puede volver a conectarse a la sesión, el
Session.SessionListener.onDisconnected(Session session) se llama al método.
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(String type, String data) 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,
utiliza el sendSignal(String type, String data, boolean retryAfterReconnect)
método para enviar la señal y configurar el retryAfterReconnect parámetro a
false. (Todas las señales enviadas por otros clientes mientras tu cliente estaba desconectado
se reciben al volver a conectarse.)
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onReconnected() método de la interfaz Session.ReconnectionListener
.
Véase también:
: - onReconnecting()
onConnected
protected void onConnected()
Se invoca cuando el cliente se conecta a la sesión de OpenTok.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onConnected() método de la interfaz Session.SessionListener
.
onDisconnected
protected void onDisconnected()
Se invoca cuando el cliente ya no está conectado a la sesión de OpenTok .
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onDisconnected() método de la interfaz Session.SessionListener
.
onStreamReceived
protected void onStreamReceived(Transmisión (flujo)
Se activa cuando se publica un nuevo flujo por parte de otro cliente en esta sesión de OpenTok.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onStreamReceived() método de la interfaz Session.SessionListener
.
Parámetros:
: stream - Un objeto `Stream` que representa el nuevo flujo, que puede
utilizarse para crear un `Subscriber`.
onStreamDropped
protected void onStreamDropped(Transmisión (flujo)
Se invoca cuando otro El cliente deja de publicar un flujo en esta sesión de OpenTok.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onStreamDropped() método de la interfaz Session.SessionListener
.
Parámetros:
: stream - Un objeto `Stream` que representa el flujo descartado, el cual puede
utilizarse para identificar a un suscriptor.
onError
protected void onError(OpentokError (error)
Se invoca cuando surge un error al conectarse o mientras se está conectado a la sesión. Una vez invocado este método, la sesión debe considerarse inactiva y no disponible. No intentes volver a conectarte ni llamar a otros métodos del objeto Session.
Este método se invoca si falla el intento de conectarse a la sesión.
También se invoca si la conexión a la sesión se interrumpe debido a un error tras
una conexión correcta; en este caso, el método se invoca justo antes
de la Session.SessionListener.onDisconnected(Session session) se llama al método.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onError() método de la interfaz Session.SessionListener
.
Parámetros:
: error - Un mensaje de error en el que se describe la causa del error.
onMuteForced
protected void onMuteForced(MuteForcedInfo (información)
Se activa cuando un moderador silencia las transmisiones de la sesión o desactiva el estado de silencio en la sesión.
Si extiendes la clase `Session`, puedes sobrescribir este método en lugar del
onMuteForced() método de la interfaz Session.MuteListener.
Parámetros:
: info - Llama al getActive método de este objeto para determinar si
el moderador ha silenciado las transmisiones de la sesión (true) o
desactivado el estado de silencio en la sesión (false).
Véase también:
: - forceMuteAll(Iterable)
- disableForceMute()
- onMuteForced(MuteForcedInfo)
- PublisherKit.onMuteForced()
- Silenciar el audio
de las transmisiones en una sesión
finalizar
protected void finalize() throws Lanzable
El recolector de basura lo invoca cuando determina que ya no hay referencias al objeto Session.
Sobrescrituras:
: finalize en clase Object
Lanzamientos:
: Throwable