Referencia del SDK de OpenTok para Linux
El SDK de OpenTok para Linux incluye los siguientes archivos de cabecera y estructuras de datos:
| Nombre | Descripción |
|---|---|
| audio_data.h | Este archivo contiene la definición del tipo de datos de audio. Estructuras de datos: otc_audio_data. Incluye: stddef.h, config.h |
| audio_device.h | Este archivo incluye la definición de tipo de un dispositivo de audio, junto con las estructuras y funciones que se utilizan con él. Utiliza un dispositivo de audio para definir un capturador de audio personalizado para todos los editores y un reproductor de audio personalizado para todos los editores y suscriptores. Si no utilizas un dispositivo de audio personalizado, la aplicación |
| audio_module_input_device.h | Dispositivo de entrada del módulo de audio. Incluye: stdlib.h, config.h, base.h |
| audio_module_output_device.h | Dispositivo de salida del módulo de audio. Incluye: stdlib.h, config.h, base.h |
| base.h | Este archivo incluye funciones que se utilizan para inicializar y desactivar el motor de la biblioteca, así como otras funciones para habilitar el registro en la consola. Estructuras de datos: otc_on_mute_forced_info, otc_transport_stats. Incluye: config.h |
| camera_capture_resolution.h | Este archivo incluye la definición de los tipos de resolución de captura de las cámaras en los dispositivos de captura de vídeo predeterminados. |
| connection.h | Este archivo incluye la definición del tipo de una estructura de conexión, que representa a un cliente conectado a una sesión de OpenTok, junto con varias declaraciones de funciones relacionadas con las conexiones de los clientes. Incluye: config.h, base.h |
| media_transformer.h | Este archivo incluye funciones para trabajar con transformadores multimedia personalizados y con los transformadores de la biblioteca Vonage Media Processor. Para obtener más información, consulta esta guía para desarrolladores. Nota: Esta funcionalidad solo es aplicable al SDK para macOS de la Video API. No funciona en el SDK para Linux de la Video API. Inclu |
| media_utils.h | Este archivo incluye la función otc_media_utils_get_supported_codecs(otc_media_utils_codecs** supported_codecs), que puedes utilizar para averiguar qué códecs de vídeo son compatibles con el dispositivo. Estructuras de datos: otc_media_utils_codecs. Incluye: base.h, config.h |
| otc_audio_data | Esta estructura representa los datos de audio PCM del suscriptor, que se envían periódicamente mediante la función de devolución de llamada `otc_subscriber_callbacks.on_audio_data`. |
| otc_audio_device_callbacks | Esta estructura incluye un conjunto de punteros a funciones de devolución de llamada que se utilizan con un dispositivo de audio. El SDK invoca estas funciones cuando se producen eventos relacionados con el dispositivo de audio. Las devoluciones de llamada no se realizarán en el hilo de la aplicación ni en el hilo principal, sino en un hilo interno. La aplicación debe devolver |
| otc_audio_device_settings | Esta estructura representa los ajustes asociados a un dispositivo de audio. |
| otc_custom_ice_config | Configuración del servidor ICE. Esta estructura representa la configuración del servidor ICE para una sesión determinada. Forma parte de la función TURN configurable. |
| otc_media_utils_codecs | Estructura que representa los códecs compatibles para la codificación y descodificación de vídeo. Definición del tipo «códecs multimedia». Tipo que indica qué códecs de vídeo son compatibles con el dispositivo. |
| otc_on_mute_forced_info | Se deben proporcionar detalles adicionales sobre la definición del tipo en la función `otc_session_callbacks.on_mute_forced`. |
| otc_publisher_audio_stats | Estadísticas de audio del editor. Esta estructura representa las estadísticas de audio del editor. La estructura `otc_publisher_callbacks` incluye un puntero a la función `on_audio_stats`, que se invoca periódicamente para comunicar las estadísticas de audio. |
| 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 activarse en respuesta a eventos relacionados con un editor de OpenTok. Ninguna de estas devoluciones de llamada se realizará en la aplicación ni en el hilo principal, sino en un hilo interno. La aplicación debe devolver la cal |
| otc_publisher_media_link_stats | Estadísticas de enlaces multimedia del editor. Esta estructura representa las estadísticas de enlaces multimedia del editor y ofrece una visión unificada de las condiciones de la red a nivel de transporte. Dado que el vídeo y el audio comparten el mismo transporte subyacente, esta estructura agrupa las estadísticas de transporte locales en un único objeto. |
| otc_publisher_rtc_stats | Representa las estadísticas de RTC de una transmisión multimedia publicada por el editor. |
| otc_publisher_rtc_stats_report_cb | Define la estructura para configurar la llamada de retorno del informe de estadísticas del RTC del editor. |
| otc_publisher_video_layer_stats | Representa las estadísticas de una única capa de vídeo publicada. En una configuración de emisión simultánea, cada entrada corresponde a una codificación de vídeo independiente (por ejemplo, flujos de baja, media y alta resolución enviados en paralelo). En el caso de la SVC (codificación de vídeo escalable), el editor suele enviar una única codificación de vídeo, |
| otc_publisher_video_stats | Estadísticas de vídeo del editor. Esta estructura representa las estadísticas de vídeo del editor. La estructura `otc_publisher_callbacks` incluye un puntero a la función `on_video_stats`, que se invoca periódicamente para comunicar las estadísticas de vídeo. |
| otc_session_callbacks | Funciones de devolución de llamada de la 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 estas devoluciones de llamada 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 respuesta de la devolución de llamada lo antes posible para evitar |
| otc_session_capabilities | Capacidades de la sesión. Esta estructura representa las capacidades de un cliente en una sesión determinada. |
| otc_signal_options | Opciones de señal de sesión. Esta estructura representa las opciones asociadas a una señal de OpenTok. Véanse otc_session_send_signal_with_options y otc_session_send_signal_to_connection_with_options. |
| otc_subscriber_audio_stats | Esta estructura representa las estadísticas de audio de los suscriptores, que se envían periódicamente mediante la función de devolución de llamada `otc_subscriber_callbacks.on_audio_stats`. |
| otc_subscriber_callbacks | Funciones de devolución de llamada del suscriptor. Esta estructura es un conjunto de punteros a funciones que pueden invocarse para eventos relacionados con un suscriptor de OpenTok. Ninguna de las devoluciones de llamada se realizará en el hilo de la aplicación o en el hilo principal, sino en un hilo interno. La aplicación debe devolver la respuesta a la devolución de llamada lo antes posible |
| otc_subscriber_media_link_stats | Esta estructura representa las estadísticas del enlace multimedia de un abonado y ofrece una visión unificada de las condiciones de la red a nivel de transporte para dicho abonado. Dado que el audio y el vídeo comparten el mismo transporte subyacente, esta estructura agrupa el transporte local, el transporte del editor remoto y la degradación de la red. |
| otc_subscriber_rtc_stats_report_cb | Define la estructura para configurar la llamada de respuesta del informe de estadísticas del RTC del suscriptor. |
| otc_subscriber_video_stats | Esta estructura representa las estadísticas de vídeo del suscriptor, que se envían periódicamente mediante la función de devolución de llamada `otc_subscriber_callbacks.on_video_stats`. Los datos que se pasan a una función de devolución de llamada (excepto `subscriber` y `user_data`) se liberarán una vez que se haya invocado la función de devolución de llamada. Haz una copia de los datos si necesitas conservarlos. |
| otc_transport_stats | Proporciona estadísticas de transporte a nivel de red. La estructura `otc_transport_stats` muestra métricas relacionadas con la capa de transporte de red subyacente de una conexión WebRTC. Estas estadísticas reflejan condiciones actuales, como el ancho de banda disponible estimado, y pueden utilizarse para supervisar o depurar el rendimiento de la red. |
| otc_video_capturer_callbacks | Funciones de devolución de llamada del dispositivo de audio. Esta estructura es un conjunto de punteros a funciones de devolución de llamada para eventos relacionados con un capturador de vídeo. Ninguna de estas devoluciones de llamada 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 devolución de llamada lo antes posible para... |
| configuración_del_capturador_de_vídeo_otc | Configuración del capturador de vídeo. Esta estructura representa los parámetros asociados a un capturador de vídeo. |
| otc_video_frame_planar_memory_callbacks | Define una estructura que contiene funciones de devolución de llamada para una estructura de envoltura de memoria del plano de fotogramas de vídeo. |
| publisher.h | Este archivo incluye la definición de tipo de un emisor de OpenTok, junto con varias declaraciones de funciones. Estructuras de datos: otc_publisher_video_layer_stats, otc_publisher_audio_stats, otc_publisher_video_stats, otc_publisher_media_link_stats, otc_publisher_callbacks, otc_publisher_rtc_stats, otc_publ |
| session.h | Este archivo incluye la definición de tipo de una sesión de OpenTok, junto con varias declaraciones de funciones útiles a la hora de gestionar una sesión. Estructuras de datos: otc_session_capabilities, otc_custom_ice_config, otc_signal_options, otc_session_callbacks. Incluye: capabilities.h, config.h, publisher.h, subs |
| stream.h | Este archivo contiene la definición del tipo de un flujo de audio y vídeo, junto con varias declaraciones de funciones útiles para su gestión. Incluye: config.h, connection.h |
| subscriber.h | Este archivo incluye la definición de tipo de un suscriptor de OpenTok, junto con varias declaraciones de funciones. Estructuras de datos: otc_subscriber_audio_stats, otc_subscriber_video_stats, otc_subscriber_media_link_stats, otc_subscriber_rtc_stats_report_cb, otc_subscriber_callbacks Incluye: audio_data.h, ba |
| video_capturer.h | Este archivo incluye la definición del tipo de un capturador de vídeo, junto con varias declaraciones de funciones útiles a la hora de trabajar con él. Estructuras de datos: otc_video_capturer_settings, otc_video_capturer_callbacks. Archivos incluidos: config.h, video_frame.h |
| video_frame.h | Este archivo incluye la definición del tipo de un fotograma de vídeo, junto con varias declaraciones de funciones útiles para trabajar con ellos. Estructuras de datos: otc_video_frame_planar_memory_callbacks. Incluye: unistd.h, base.h, config.h |