#include <session.h>
Descripción detallada
Funciones de devolución de llamada de sesión.
Esta estructura es un conjunto de punteros a funciones de devolución de llamada para eventos relacionados con una sesión de OpenTok.
Ninguna de las llamadas de retorno se realizará en el hilo de la aplicación ni en el hilo principal, sino en un hilo interno. La aplicación debe devolver la llamada de retorno lo antes posible para evitar bloquear el hilo interno.
Datos que se pasan a una función de devolución de llamada (que no sea session y user_data) se liberarán una vez que se haya llamado a la función de devolución de llamada. Haz una copia de los datos si necesitas conservarlos.
Documentación de campo
on_archive_started
| void(* on_archive_started) (otc_session *session, void *datos_usuario, const char *id_archivo, const char *nombre) |
Se invoca cuando un archivo de la sesión comienza a grabarse. Consulta el Guía del desarrollador de archivado.
Parámetros : | | | | --- | --- | | session | Un puntero a la estructura otc_session. | | archive_id | El identificador del archivo. | | name | El nombre del archivo (si se proporcionó al crearlo). |
on_archive_stopped
| void(* on_archive_stopped) (otc_session *session, void *datos_usuario, const char *id_archivo) |
Se invoca cuando se detiene la grabación de un archivo de la sesión.
Parámetros : | | | | --- | --- | | session | Un puntero a la estructura otc_session. | | user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. | | archive_id | El identificador del archivo. |
on_connected
| void(* on_connected) (otc_session *session, void *datos_usuario) |
Se invoca cuando el otc_session_connect La función conecta correctamente al cliente a una sesión de OpenTok.
Parámetros : | | | | --- | --- | | session | Un puntero a la estructura otc_session. | | user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. |
on_connection_created
| void(* on_connection_created) (otc_session *session, void *datos_usuario, const otc_connection *conexión) |
Se ejecuta cuando se establece una nueva conexión (desde otro cliente).
Parámetros
: | | |
| --- | --- |
| session | Un puntero a la estructura otc_session. |
| user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. |
| connection | El otc_connection estructura correspondiente al cliente que se conecta a la sesión. |
on_connection_dropped
| void(* on_connection_dropped) (otc_session *session, void *datos_usuario, const otc_connection *conexión) |
Se invoca cuando se interrumpe la conexión de otro cliente a la sesión.
Parámetros
: | | |
| --- | --- |
| session | Un puntero a la estructura otc_session. |
| user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. |
| connection | El otc_connection Estructura correspondiente a la desconexión del cliente de la sesión. |
on_disconnected
| void(* on_disconnected) (otc_session *session, void *datos_usuario) |
Se invoca cuando el cliente ya no está conectado a la sesión de OpenTok.
Parámetros : | | | | --- | --- | | session | Un puntero a la estructura otc_session. | | user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. |
on_error
| void(* on_error) (otc_session *session, void *datos_usuario, const char *error_string, enum otc_session_error_code (error) |
Se invoca cuando la sesión falla.
Parámetros
: | | |
| --- | --- |
| session | Un puntero a la estructura otc_session. |
| user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. |
| error_string | La cadena de error. |
| error | El código de error (de tipo otc_session_error_code). |
on_mute_forced
| void(* on_mute_forced) (otc_session *session, void *datos_usuario, otc_on_mute_forced_info *mute_info) |
Se activa cuando un moderador silencia las transmisiones de la sesión o desactiva el estado de silencio en la sesión.
Parámetros
: | | |
| --- | --- |
| session | Un puntero a la estructura otc_session. |
| user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. |
| mute_info | Comprueba el active propiedad de esta estructura. Está establecida en OTC_TRUE cuando un moderador ha silenciado el audio de la sesión. Está configurado en OTC_FALSE cuando un moderador desactiva el estado de silencio del audio en la sesión. |
on_reconnected
| void(* on_reconnected) (otc_session *session, void *datos_usuario) |
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.
Parámetros : | | | | --- | --- | | session | Un puntero a la estructura otc_session. | | user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. |
on_reconnection_started
| void(* on_reconnection_started) (otc_session *session, void *datos_usuario) |
Se invoca cuando el cliente local ha perdido la conexión con la sesión de OpenTok y está intentando volver a conectarse.
Parámetros : | | | | --- | --- | | session | Un puntero a la estructura otc_session. | | user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. |
on_signal_received
| void(* on_signal_received) (otc_session *session, void *datos_usuario, const char *type, const char *signal, const otc_connection *conexión) |
Se invoca cuando se recibe una señal en la sesión. Véase el Resumen sobre la señalización documentación.
Parámetros
: | | |
| --- | --- |
| session | Un puntero a la estructura otc_session. |
| user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. |
| type | La cadena de tipo de la señal (si se proporcionó alguna al enviarla). |
| signal | La cadena de datos de la señal (si se proporcionó alguna al enviarla). |
| connection | La otc_connection que representa al cliente que envió la señal. |
on_stream_dropped
| void(* on_stream_dropped) (otc_session *session, void *datos_usuario, const otc_stream *stream) |
Se invoca cuando se desconecta el flujo de otro cliente de esta sesión de OpenTok.
Parámetros
: | | |
| --- | --- |
| session | Un puntero a la estructura otc_session. |
| user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. |
| stream | El otc_stream estructura que representa el flujo. |
on_stream_has_audio_changed
| void(* on_stream_has_audio_changed) (otc_session *session, void *datos_usuario, const otc_stream *stream, otc_bool has_audio) |
Se invoca cuando una transmisión activa o desactiva el audio.
Parámetros
: | | |
| --- | --- |
| session | Un puntero a la estructura otc_session. |
| user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. |
| stream | El otc_stream Estructura que representa la nueva transmisión. |
| has_audio | Indica si la transmisión tiene ahora audio (OTC_TRUE) o no (OTC_FALSE). |
on_stream_has_captions_changed
| void(* on_stream_has_captions_changed) (otc_session *session, void *datos_usuario, const otc_stream *stream, otc_bool has_captions) |
Se activa cuando una transmisión activa o desactiva los subtítulos.
Parámetros : | | | | --- | --- | | session | Un puntero a la estructura otc_session. | | user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. | | stream | Un puntero a la estructura otc_stream que representa la transmisión. | | has_captions | Indica si la transmisión tiene ahora subtítulos (OTC_TRUE) o no (OTC_FALSE). |
on_stream_has_video_changed
| void(* on_stream_has_video_changed) (otc_session *session, void *datos_usuario, const otc_stream *stream, otc_bool has_video) |
Se invoca cuando una transmisión activa o desactiva el vídeo.
Parámetros : | | | | --- | --- | | session | Un puntero a la estructura otc_session. | | user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. | | stream | Indica si la transmisión contiene vídeo (OTC_TRUE) o no (OTC_FALSE). |
on_stream_received
| void(* on_stream_received) (otc_session *session, void *datos_usuario, const otc_stream *stream) |
Se invoca cuando hay una nueva transmisión en esta sesión de OpenTok. Invoca la función otc_session_subscribe función para suscribirse a la transmisión.
Parámetros
: | | |
| --- | --- |
| session | Un puntero a la estructura otc_session. |
| user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. |
| stream | El otc_stream estructura que representa el nuevo flujo. |
on_stream_video_dimensions_changed
| void(* on_stream_video_dimensions_changed) (otc_session *session, void *datos_usuario, const otc_stream *stream, int ancho, int alto) |
Se invoca cuando cambian las dimensiones de vídeo de una transmisión en la sesión.
Parámetros : | | | | --- | --- | | session | Un puntero a la estructura otc_session. | | user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. | | width | El nuevo ancho del flujo, en píxeles. | | height | La nueva altura del flujo, en píxeles. |
on_stream_video_type_changed
| void(* on_stream_video_type_changed) (otc_session *session, void *datos_usuario, const otc_stream *stream, enum otc_stream_video_type tipo) |
Se invoca cuando cambia el tipo de vídeo de una transmisión en la sesión.
Parámetros : | | | | --- | --- | | session | Un puntero a la estructura otc_session. | | user_data | Un puntero a los datos de usuario (user_data) que has establecido para la sesión. | | type | El nuevo tipo de flujo. |
reservado
| void* reservado |
Un puntero nulo a un área de memoria que contiene recursos reservados utilizados para la implementación interna.
datos_usuario
| void* datos_de_usuario |
Un puntero a los datos que has configurado en relación con la sesión.