otc_publisher_callbacks

Funciones de devolución de llamada del editor.

Esta estructura es un conjunto de punteros a funciones de devolución de llamada que pueden invocarse en respuesta a eventos relacionados con un emisor 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 publisher 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 el editor.
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_stream_created(publisher, user_data, stream) Se invoca cuando se crea el flujo del editor.
on_stream_destroyed(publisher, user_data, stream) Se invoca cuando se destruye el flujo del editor.
on_render_frame(publisher, user_data, frame) Se invoca cuando hay un nuevo fotograma listo para ser renderizado por el editor.
on_audio_level_updated(publisher, user_data, audio_level) Se invoca periódicamente para informar del nivel de audio del editor.
on_publisher_mute_forced(publisher, user_data) Se activa cuando un moderador ha obligado a este editor a silenciar el audio.
on_audio_stats(publisher, user_data, audio_stats, number_of_stats) Se ejecuta periódicamente para enviar estadísticas de audio al editor.
on_video_stats(publisher, user_data, video_stats, number_of_stats) Se ejecuta periódicamente para enviar un informe con las estadísticas de vídeo al editor.
on_error(publisher, user_data, error_string, error_code) Se ejecuta cuando falla el editor.
on_video_disabled(publisher, user_data, reason) Se invoca cuando el vídeo del editor está desactivado.
on_video_enabled(publisher, user_data, reason) Se ejecuta cuando se activa el vídeo del editor.
on_video_disable_warning(publisher, user_data) Se invoca cuando el editor determina que el nivel de congestión de la red ha empeorado y que el vídeo se desactivará si la calidad sigue deteriorándose.
on_video_disable_warning_lifted(publisher, user_data) Se invoca cuando el editor determina que el nivel de congestión de la red ha mejorado hasta el punto de que la desactivación del vídeo ya no supone un riesgo inmediato.
on_network_condition_changed(publisher, user_data, stats, reason) Esta función de devolución de llamada se activa cada vez que se produce un cambio en el estado de calidad de la transmisión de vídeo del editor.
on_media_link_stats(publisher, user_data, media_link_stats, number_of_stats) Se ejecuta periódicamente para generar informes sobre las estadísticas de enlaces multimedia del editor.

on_stream_created(publisher, user_data, stream)

Se invoca cuando se crea el flujo del editor.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * Una referencia a la editorial.
user_data void * Un puntero al `user_data` que has establecido para el editor.
stream const otc_stream * Un puntero al flujo.

on_stream_destroyed(publisher, user_data, stream)

Se invoca cuando se destruye el flujo del editor.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * Una referencia a la editorial.
user_data void * Un puntero al `user_data` que has establecido para el editor.
stream const otc_stream * Un puntero al flujo.

on_render_frame(editor, datos_de_usuario, fotograma)

Se invoca cuando hay un nuevo fotograma listo para ser renderizado por el editor. No llamar a cualquier función de la API de OpenTok (excepto las que se encuentran en video_frame.h) en el mismo hilo que invoca esta función de devolución de llamada. Si necesitas llamar a una función de la API de OpenTok (por ejemplo, funciones en publisher.h o subscriber.h), reprogramar su ejecución en un hilo diferente.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * Una referencia a la editorial.
user_data void * Un puntero al `user_data` que has establecido para el editor.
frame const otc_video_frame * Un puntero al nuevo fotograma de vídeo.

on_audio_level_updated(editor, datos_de_usuario, nivel_de_audio)

Se invoca periódicamente para informar del nivel de audio del editor.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * Una referencia a la editorial.
user_data void * Un puntero al `user_data` que has establecido para el editor.
audio_level flotante El valor del nivel de audio, de 0 a 1,0.

on_publisher_mute_forced(publisher, user_data)

Se activa cuando un moderador ha obligado a este editor a silenciar el audio.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * Una referencia a la editorial.
user_data void * Un puntero al `user_data` que has establecido para el editor.

on_audio_stats(editor, datos_del_usuario, estadísticas_de_audio, número_de_estadísticas)

Se ejecuta periódicamente para enviar estadísticas de audio al editor.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * Una referencia a la editorial.
user_data void * Un puntero al `user_data` que has establecido para el editor.
audio_stats struct otc_publisher_audio_stats [] Una serie de estadísticas de audio de las editoriales.
number_of_stats size_t El número de estadísticas de audio que contiene la matriz.

on_video_stats(editor, datos_del_usuario, estadísticas_del_vídeo, número_de_estadísticas)

Se ejecuta periódicamente para enviar un informe con las estadísticas de vídeo al editor.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * Una referencia a la editorial.
user_data void * Un puntero al `user_data` que has establecido para el editor.
video_stats struct otc_publisher_video_stats [] Una serie de estadísticas sobre vídeos de las editoriales.
number_of_stats size_t El número de estadísticas de vídeo que contiene la matriz.

on_error(publisher, user_data, error_string, error_code)

Se ejecuta cuando falla el editor.

La mayoría de los errores son graves: el editor se descarta automáticamente y ya no se puede utilizar. Algunos errores no impiden continuar y permiten seguir utilizando el editor; cuando un error no es grave, así se indica en la descripción del error.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * Una referencia a la editorial.
user_data void * Un puntero al `user_data` que has establecido para el editor.
error_string const char * Una cadena que contiene el mensaje de error.
error_code enumeración otc_publisher_error_code Un valor de enumeración de código de error.

on_video_disabled(editor, datos_del_usuario, motivo)

Se invoca cuando el vídeo del editor está desactivado.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La instancia que realiza esta llamada.
user_data void * Puntero a los datos personalizados del usuario vinculados a esta estructura.
reason enumeración otc_video_reason Ofrece más detalles sobre por qué se ha desactivado el vídeo.

on_video_enabled(editor, datos_del_usuario, motivo)

Se ejecuta cuando se activa el vídeo del editor.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La instancia que realiza esta llamada.
user_data void * Puntero a los datos personalizados del usuario vinculados a esta estructura.
reason enumeración otc_video_reason Ofrece más detalles sobre por qué se ha activado el vídeo.

on_video_disable_warning(publisher, user_data)

Se invoca cuando el editor determina que el nivel de congestión de la red ha empeorado y que el vídeo se desactivará si la calidad sigue deteriorándose.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La instancia que realiza esta llamada.
user_data void * Puntero a los datos personalizados del usuario vinculados a esta estructura.

on_video_disable_warning_lifted(publisher, user_data)

Se invoca cuando el editor determina que el nivel de congestión de la red ha mejorado hasta el punto de que la desactivación del vídeo ya no supone un riesgo inmediato.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La instancia que realiza esta llamada.
user_data void * Puntero a los datos personalizados del usuario vinculados a esta estructura.

on_network_condition_changed(publisher, user_data, stats, reason)

Esta función de devolución de llamada se activa cada vez que se produce un cambio en el estado de calidad de la transmisión de vídeo del editor. Proporciona información sobre el evento, estadísticas actualizadas y un código de motivo que indica por qué se produjo el evento.

El reason Este parámetro indica la causa del evento y se tiene en cuenta siguiendo el siguiente orden de prioridad: deterioro del ancho de banda, deterioro de la CPU, otras causas de deterioro de la calidad, cambios en el códec, cambios en la resolución o en la capa.

Este evento se diferencia de on_video_disabled y on_video_enabled funciones de devolución de llamada, ya que notifica los cambios relevantes en la calidad del vídeo. on_video_disabled y `on_video_enabled solo indican que la pista de vídeo del suscriptor se ha activado o desactivado (por ejemplo, debido a una actualización de las propiedades de la transmisión o a un cambio a audio de reserva). Por el contrario, este evento proporciona información de diagnóstico sobre las causas de la degradación de la calidad —como limitaciones de CPU o de ancho de banda— y también se activa cuando el vídeo permanece activado.

Las aplicaciones pueden utilizar esta función de devolución de llamada para supervisar los cambios en la calidad y reaccionar en consecuencia, por ejemplo, ajustando elementos de la interfaz de usuario o activando alertas.

/** Esta función de devolución de llamada se activa cuando se detecta un cambio en las condiciones de red del editor.

El reason El parámetro indica la causa del evento y, actualmente, siempre es OTC_NETWORK_REASON_NETWORK_CONDITION_CHANGE.

Este evento se diferencia de on_video_disabled y on_video_enabled se diferencia de las demás funciones de devolución de llamada en que informa de cambios en el estado de la red, en lugar de cambios en el estado de la pista de vídeo del editor. Las aplicaciones pueden utilizar esta función de devolución de llamada para responder a problemas de red, como actualizar la interfaz de usuario, registrar datos de telemetría o activar un comportamiento adaptativo.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La instancia del editor que activa el evento.
user_data void * Puntero opcional a datos de usuario que se pasa al registrar la llamada de retorno.
stats const struct otc_publisher_media_link_stats * Un enlace a las estadísticas de los enlaces multimedia de la editorial.
reason enumeración otc_network_reason El motivo del cambio en el estado de la red.

on_media_link_stats(editor, datos_del_usuario, estadísticas_del_enlace_multimedia, número_de_estadísticas)

Se ejecuta periódicamente para generar informes sobre las estadísticas de enlaces multimedia del editor.

Las estadísticas de enlaces de medios ofrecen una visión global del estado de la red a nivel de transporte.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La instancia que realiza esta llamada.
user_data void * Puntero a los datos personalizados del usuario vinculados a esta estructura.
media_link_stats struct otc_publisher_media_link_stats [] Un puntero a la estructura de estadísticas de enlaces multimedia.
number_of_stats size_t