otc_session_callbacks
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.
Propiedades
| Nombre | Tipo | Descripción |
|---|---|---|
user_data |
void * | Un puntero a los datos que has configurado en relación con la sesión. |
reserved |
void * | Un puntero nulo a un área de memoria que contiene recursos reservados utilizados para la implementación interna. |
Devoluciones de llamada
| Nombre | Descripción |
|---|---|
on_connected(session, user_data) |
Se invoca cuando el otc_session_connect La función conecta correctamente al cliente a una sesión de OpenTok. |
on_disconnected(session, user_data) |
Se invoca cuando el cliente ya no está conectado a la sesión de OpenTok. |
on_connection_created(session, user_data, connection) |
Se ejecuta cuando se establece una nueva conexión (desde otro cliente). |
on_connection_dropped(session, user_data, connection) |
Se invoca cuando se interrumpe la conexión de otro cliente a la sesión. |
on_stream_received(session, user_data, stream) |
Se invoca cuando hay una nueva transmisión en esta sesión de OpenTok. |
on_stream_dropped(session, user_data, stream) |
Se invoca cuando se desconecta el flujo de otro cliente de esta sesión de OpenTok. |
on_stream_has_audio_changed(session, user_data, stream, has_audio) |
Se invoca cuando una transmisión activa o desactiva el audio. |
on_stream_has_video_changed(session, user_data, stream, has_video) |
Se invoca cuando una transmisión activa o desactiva el vídeo. |
on_stream_has_captions_changed(session, user_data, stream, has_captions) |
Se activa cuando una transmisión activa o desactiva los subtítulos. |
on_stream_video_dimensions_changed(session, user_data, stream, width, height) |
Se invoca cuando cambian las dimensiones de vídeo de una transmisión en la sesión. |
on_stream_video_type_changed(session, user_data, stream, type) |
Se invoca cuando cambia el tipo de vídeo de una transmisión en la sesión. |
on_signal_received(session, user_data, type, signal, connection) |
Se invoca cuando se recibe una señal en la sesión. |
on_reconnection_started(session, user_data) |
Se invoca cuando el cliente local ha perdido la conexión con la sesión de OpenTok y está intentando volver a conectarse. |
on_reconnected(session, user_data) |
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. |
on_archive_started(session, user_data, archive_id, name) |
Se invoca cuando un archivo de la sesión comienza a grabarse. |
on_archive_stopped(session, user_data, archive_id) |
Se invoca cuando se detiene la grabación de un archivo de la sesión. |
on_error(session, user_data, error_string, error) |
Se invoca cuando la sesión falla. |
on_mute_forced(session, user_data, mute_info) |
Se activa cuando un moderador silencia las transmisiones de la sesión o desactiva el estado de silencio en la sesión. |
on_connected(sesión, datos_de_usuario)
Se invoca cuando el otc_session_connect La función conecta correctamente al cliente a una sesión de OpenTok.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
on_disconnected(sesión, datos_de_usuario)
Se invoca cuando el cliente ya no está conectado a la sesión de OpenTok.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
on_connection_created(sesión, datos_de_usuario, conexión)
Se ejecuta cuando se establece una nueva conexión (desde otro cliente).
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
connection |
const otc_connection * | El otc_connection struct correspondiente al cliente que se conecta a la sesión. |
on_connection_dropped(sesión, datos_de_usuario, conexión)
Se invoca cuando se interrumpe la conexión de otro cliente a la sesión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
connection |
const otc_connection * | El otc_connection struct correspondiente al cliente que se desconecta de la sesión. |
on_stream_received(sesión, datos_de_usuario, flujo)
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:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
stream |
const otc_stream * | El otc_stream estructura que representa el nuevo flujo. |
on_stream_dropped(sesión, datos_de_usuario, flujo)
Se invoca cuando se desconecta el flujo de otro cliente de esta sesión de OpenTok.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
stream |
const otc_stream * | El otc_stream estructura que representa el flujo. |
on_stream_has_audio_changed(sesión, datos_de_usuario, transmisión, hay_audio)
Se invoca cuando una transmisión activa o desactiva el audio.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
stream |
const otc_stream * | El otc_stream estructura que representa el nuevo flujo. |
has_audio |
otc_bool | Si la transmisión tiene audio (OTC_TRUE) o no (OTC_FALSE). |
on_stream_has_video_changed(sesión, datos_de_usuario, transmisión, tiene_vídeo)
Se invoca cuando una transmisión activa o desactiva el vídeo.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
stream |
const otc_stream * | Si la transmisión contiene vídeo (OTC_TRUE) o no (OTC_FALSE). |
has_video |
otc_bool |
on_stream_has_captions_changed(sesión, datos_de_usuario, transmisión, tiene_subtítulos)
Se activa cuando una transmisión activa o desactiva los subtítulos.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
stream |
const otc_stream * | Un enlace a la otc_stream estructura que representa el flujo. |
has_captions |
otc_bool | Si la transmisión tiene subtítulos (OTC_TRUE) o no (OTC_FALSE). |
on_stream_video_dimensions_changed(sesión, datos_de_usuario, transmisión, anchura, altura)
Se invoca cuando cambian las dimensiones de vídeo de una transmisión en la sesión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
stream |
const otc_stream * | |
width |
int | El nuevo ancho del arroyo, en píxeles. |
height |
int | El nuevo ancho del arroyo, en píxeles. |
on_stream_video_type_changed(sesión, datos_de_usuario, transmisión, tipo)
Se invoca cuando cambia el tipo de vídeo de una transmisión en la sesión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
stream |
const otc_stream * | |
type |
enumeración otc_stream_video_type | El nuevo tipo de flujo. |
on_signal_received(sesión, datos_de_usuario, tipo, señal, 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:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
type |
const char * | La cadena de tipo de la señal (si se facilitó alguna al enviarla). |
signal |
const char * | La cadena de datos de la señal (si se facilitó alguna al enviarla). |
connection |
const otc_connection * | El otc_connection que representa al cliente que envió la señal. |
on_reconnection_started(sesión, datos_de_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:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
on_reconnected(sesión, datos_de_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:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
on_archive_started(sesión, datos_de_usuario, id_archivo, nombre)
Se invoca cuando un archivo de la sesión comienza a grabarse. Consulta el Guía del desarrollador de archivado.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | |
archive_id |
const char * | El identificador del archivo. |
name |
const char * | El nombre del archivo (si se le asignó uno al crearlo). |
on_archive_stopped(sesión, datos_de_usuario, id_archivo)
Se invoca cuando se detiene la grabación de un archivo de la sesión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
archive_id |
const char * | El identificador del archivo. |
on_error(sesión, datos_de_usuario, cadena_de_error, error)
Se invoca cuando la sesión falla.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
error_string |
const char * | La cadena de error. |
error |
enumeración otc_session_error_code | El código de error (de tipo otc_session_error_code). |
on_mute_forced(sesión, datos_de_usuario, información_de_silenciamiento)
Se activa cuando un moderador silencia las transmisiones de la sesión o desactiva el estado de silencio en la sesión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
session |
otc_session * | Un enlace a la otc_session struct. |
user_data |
void * | Un puntero al `user_data` que has establecido para la sesión. |
mute_info |
otc_on_mute_forced_info * | Compruebe 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. |