OpenTok Publisher. Más...

#include "config.h" #include "stream.h" #include "video_frame.h" #include "audio_data.h" #include "camera_capture_resolution.h" #include "media_transformer.h" #include "video_capturer.h"

Descripción detallada

OpenTok Publisher.

Este archivo incluye la definición de tipo de un «publisher» de OpenTok, junto con varias declaraciones de funciones.

Documentación sobre `typedef`

otc_publisher

Definición del tipo de editor de OpenTok.

Un tipo que representa a un emisor de una transmisión de audio y vídeo en una sesión de OpenTok.

otc_configuración_del_editor

Definición del tipo de configuración de editor de OpenTok.

Documentación sobre tipos de enumeración

otc_código_de_error_del_editor

Lista de códigos de error para los editores de OpenTok.

Esta enumeración recoge varios códigos de error relacionados con un editor.

otc_publisher_video_type

Enumeración de los tipos de vídeo de los editores.

Esta lista recoge los distintos tipos de vídeo compatibles.

otc_video_bitrate_preset

Estrategias predefinidas para controlar la tasa de bits de vídeo en la transmisión de un editor.

Estos ajustes predefinidos permiten a los desarrolladores aplicar estrategias de ancho de banda sin tener que especificar manualmente las velocidades de bits. Los ajustes predefinidos son incompatibles con la configuración manual de la velocidad de bits.

Para más información, consulta Velocidad de bits máxima del editor.

Documentación de funciones

otc_publisher_delete()

Libera una instancia de editor, incluidos todos los recursos de hardware asociados a ella.

Parámetros : | | | | --- | --- | | editor | La instancia del editor que se va a eliminar. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_get_audio_fallback_enabled()

Indica si la función de audio alternativo del editor está activada o no. Consulta el otc_publisher_set_audio_fallback_enabled función.

Esta función está obsoleta.

Parámetros : | | | | --- | --- | | publisher | La instancia del editor. |

Devoluciones : Indica si la función de audio alternativo del editor está activada o no.

otc_publisher_get_max_video_bitrate()

Obtiene la tasa de bits máxima de vídeo establecida para la transmisión de vídeo de este editor.

Devuelve la tasa de bits máxima de vídeo configurada actualmente en bits por segundo (bps). Si no se ha establecido ninguna tasa de bits manualmente mediante otc_publisher_set_max_video_bitrate(), o si hay un preajuste activo (incluido el predeterminado), esta función devuelve 0.

Nota: Un valor de retorno de 0 indica que no se aplica ningún límite explícito de velocidad de bits y que, en su lugar, la transmisión utiliza un comportamiento basado en preajustes.

Parámetros : | | | | | --- | --- | --- | | [in] | publisher | La instancia del editor. |

Valores devueltos : La tasa de bits máxima actual del vídeo en bits por segundo, o 0 si no se ha configurado manualmente.

otc_publisher_get_name()

Obtiene el nombre de un editor determinado.

Parámetros : | | | | --- | --- | | publisher | La instancia del editor. |

Devuelve : El nombre.

otc_publisher_get_publish_audio()

Devuelve si el Publisher está reproduciendo audio o no.

Parámetros : | | | | --- | --- | | publisher | La instancia del editor. |

Devoluciones : Si la editorial publica material de audio o no.

otc_publisher_get_publish_captions()

Devuelve si el Publisher tiene subtítulos activos.

Parámetros : | | | | --- | --- | | publisher | La instancia del editor. |

Valores : Si el editor tiene los subtítulos activados o no.

otc_publisher_get_publish_video()

Indica si el editor está publicando un vídeo o no.

Parámetros : | | | | --- | --- | | publisher | La instancia del editor. |

Devoluciones : Si la editorial publica vídeos o no.

otc_publisher_get_publisher_id()

Obtiene un identificador único para un editor.

Parámetros : | | | | --- | --- | | publisher | La instancia del editor. |

Resultados : Un identificador único del editor. Si se produce un error, este valor es nulo.

otc_publisher_get_rtc_stats_report()

Obtiene el informe de estadísticas de RTC del editor. Se trata de una operación asíncrona. Crea un otc_publisher_rtc_stats_report_cb struct y pasarla a la otc_publisher_set_rtc_stats_report_cb función antes de llamar a esta función. Cuando las estadísticas estén disponibles, la otc_publisher_set_rtc_stats_report_cb Se invoca la función de devolución de llamada.

Véase también otc_publisher_callbacks.on_audio_stats, otc_publisher_callbacks.on_video_statsy otc_subscriber_get_rtc_stats_report.

Parámetros : | | | | --- | --- | | editor | El editor. |

otc_publisher_get_session()

Devuelve el otc_session asociada a esta instancia de editor.

Parámetros : | | | | --- | --- | | publisher | La instancia del editor. |

Devoluciones : El otc_session asociado a esta instancia. Si se produce un error, este valor es nulo.

otc_publisher_get_stream()

Devuelve el flujo asociado al editor.

Parámetros : | | | | --- | --- | | publisher | La instancia del editor de la que se va a obtener el flujo. |

Devuelve : El flujo asociado al editor. Si se produce un error, este valor es nulo.

otc_publisher_get_user_data()

Obtiene los datos de usuario de un editor determinado.

Parámetros : | | | | --- | --- | | publisher | La instancia del editor. |

Devuelve : Un puntero a los datos de usuario en memoria.

otc_publisher_get_video_bitrate_preset()

Obtiene el ajuste de velocidad de bits de vídeo actualmente activo para la retransmisión de este emisor.

Si se había configurado previamente una tasa de bits personalizada mediante otc_publisher_set_max_video_bitrate(), este método devuelve OTC_VIDEO_BITRATE_PRESET_CUSTOM.

Parámetros : | | | | | --- | --- | --- | | [in] | publisher | La instancia del editor. |

Retornos : El preajuste de velocidad de bits activo.

otc_publisher_get_video_type()

Obtiene el tipo de vídeo del editor. Consulta la otc_publisher_set_video_type función.

Parámetros : | | | | --- | --- | | publisher | La instancia del editor. |

Resultados : El tipo de vídeo del editor.

otc_publisher_new()

Crea una nueva instancia de otc_publisher.

Parámetros : | | | | --- | --- | | nombre | El nombre del editor. Otros clientes pueden obtener los nombres de las transmisiones de la sesión. | | capturador | Utiliza este parámetro si deseas proporcionar un capturador de vídeo personalizado. Si se establece en nulo, el editor utiliza un capturador de vídeo predeterminado que emplea la cámara del sistema. | | callbacks | Un puntero a la estructura que contiene los punteros a las funciones de devolución de llamada del editor. |

Devuelve : Una nueva instancia de `otc_publisher`. Si se produce un error, el valor es `null`.

otc_publisher_new_with_settings()

Crea una nueva instancia de otc_publisher.

Parámetros : | | | | --- | --- | | callbacks | Un puntero a la estructura que contiene los punteros a las funciones de devolución de llamada del editor. | | settings | La estructura de configuración que contiene los ajustes deseados para el editor. |

Devuelve : Una nueva instancia de `otc_publisher`. Si se produce un error, el valor es `null`.

otc_publisher_set_audio_fallback_enabled()

Activa o desactiva la función de recambio de audio del abonado.

La función de recambio de audio está disponible en las sesiones que utilizan el OpenTok Media Router. Cuando la función de recambio de audio está activada (configuración predeterminada), si el OpenTok Media Router detecta que la calidad de una transmisión se ha degradado significativamente para un suscriptor concreto de dicha transmisión, desactiva el vídeo para ese suscriptor con el fin de preservar la calidad del audio.

Para desactivar la función de audio de reserva, llama al otc_publisher_set_audio_fallback_enabled función (y pasarle OTC_FALSE) antes de llamar a la otc_session_publish función.

Esta función está obsoleta. Véase otc_publisher_settings_set_subscriber_audio_fallback_enabled.

Parámetros : | | | | --- | --- | | editor | El editor al que afectará. | | habilitado | Si queremos habilitar la función de audio alternativo o no. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_set_audio_transformers()

Establece una matriz de transformadores de audio en el flujo de audio de este editor. Si se establece en null, se restablecen los transformadores.

La matriz puede estar compuesta por transformadores de audio de Vonage proporcionados por ml-library y/o por transformadores personalizados. Los transformadores contienen un puntero a una función de llamada de retorno que se invoca en cada trama de audio.

Nota: Esta función solo es aplicable al SDK de macOS de la Video API de Vonage. No funciona en el SDK de Linux de la Video API de Vonage.

Parámetros : | | | | | --- | --- | --- | | [in] | publisher | La instancia del editor. | | [in] | transformadores | Matriz de punteros opacos a otc_audio_transformer en el orden en que se aplicarán al flujo. | | [in] | tamaño | Tamaño de la matriz. |

Resultados : devuelve un error si se produce un error; en caso contrario, devuelve OTC_SUCCESS.

otc_publisher_set_max_audio_bitrate()

Establece la tasa de bits máxima de audio para el editor.

Parámetros : | | | | --- | --- | | editor | El editor al que afecta. | | velocidad de bits | La velocidad de bits deseada en kbps. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_set_max_video_bitrate()

Obtiene la tasa de bits máxima de vídeo establecida para la transmisión de vídeo de este editor.

Devuelve la tasa de bits máxima actual del vídeo en bits por segundo (bps). Si no se ha establecido explícitamente ninguna tasa de bits mediante otc_publisher_set_max_video_bitrate(), o si hay un ajuste preestablecido de velocidad de bits activo (incluido el ajuste predeterminado), esta función devuelve 0.

Nota: Un valor de retorno de 0 indica que no hay ningún límite de velocidad de bits establecido manualmente y que la transmisión funciona con una configuración preestablecida.

Parámetros : | | | | | --- | --- | --- | | [in] | publisher | La instancia del editor. |

Valores de retorno : La tasa de bits máxima actual del vídeo en bits por segundo, o 0 si no se ha establecido o si se utiliza un valor preestablecido.

otc_publisher_set_publish_audio()

Si se debe publicar el audio o no. Por defecto, las retransmisiones publican tanto el audio como el vídeo.

Parámetros : | | | | --- | --- | | publisher | El editor al que afecta. | | publish_audio | Si se publica audio o no. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_set_publish_captions()

Si se desea activar o no los subtítulos. Por defecto, está desactivado.

Parámetros : | | | | --- | --- | | publisher | El editor al que afecta. | | publish_captions | Si se deben activar los subtítulos o no. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_set_publish_video()

Si se debe publicar vídeo o no. Por defecto, las transmisiones publican tanto el audio como el vídeo.

Parámetros : | | | | --- | --- | | publisher | El editor al que afecta. | | publish_video | Si se va a publicar el vídeo o no. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_set_rtc_stats_report_cb()

Establece la función de devolución de llamada del informe de estadísticas de RTC del editor.

Parámetros : | | | | --- | --- | | publisher | La instancia del editor. | | cb | El otc_publisher_rtc_stats_report_cb estructura que incluye la función de devolución de llamada para el informe de estadísticas del RTC. |

Véase también : otc_publisher_get_rtc_stats_report.

otc_publisher_set_video_bitrate_preset()

Establece un valor predefinido de velocidad de bits de vídeo para la transmisión de vídeo de este editor.

Aplica una estrategia predefinida de velocidad de bits de vídeo para controlar el comportamiento del codificador. Estos ajustes predefinidos tienen por objeto equilibrar la calidad del vídeo con el uso del ancho de banda, en función de las necesidades de la aplicación.

Nota: El ajuste preestablecido OTC_VIDEO_BITRATE_PRESET_CUSTOM no se puede configurar directamente. Al llamar a otc_publisher_set_max_video_bitrate() anulará el ajuste preestablecido y hará que el método getter del ajuste preestablecido devuelva OTC_VIDEO_BITRATE_PRESET_CUSTOM.

Parámetros : | | | | | --- | --- | --- | | [in] | publisher | La instancia del editor. | | [in] | preset | Un valor de otc_video_bitrate_preset para presentar la solicitud. |

Resultados : devuelve un error si se produce un error; en caso contrario, devuelve OTC_SUCCESS.

otc_publisher_set_video_transformers()

Establece una matriz de transformadores de vídeo para el flujo de vídeo de este editor. Si se establece en null, se restablecen los transformadores.

La matriz puede estar compuesta por transformadores de vídeo de Vonage proporcionados por ml-library y/o por transformadores personalizados. Los transformadores contienen un puntero a una función de devolución de llamada que se invoca en cada fotograma de vídeo.

Nota: Esta función solo es aplicable al SDK de macOS de la Video API de Vonage. No funciona en el SDK de Linux de la Video API de Vonage.

Parámetros : | | | | | --- | --- | --- | | [in] | publisher | La instancia del editor. | | [in] | transformadores | Matriz de punteros opacos a otc_video_transformer en el orden en que se aplicarán al flujo. | | [in] | tamaño | Tamaño de la matriz. |

Resultados : devuelve un error si se produce un error; en caso contrario, devuelve OTC_SUCCESS.

otc_publisher_set_video_type()

Establece el tipo de vídeo del editor. De forma predeterminada, los vídeos tienen el tipo de vídeo establecido en OTC_PUBLISHER_VIDEO_TYPE_CAMERA (lo que indica que la fuente del vídeo es una cámara). Establece este valor en OTC_PUBLISHER_VIDEO_TYPE_SCREEN para indicar que la fuente del vídeo es el uso compartido de pantalla. Otros clientes pueden detectar el tipo de vídeo de las transmisiones de la sesión (para determinar el tipo de fuente de vídeo).

Parámetros : | | | | --- | --- | | publisher | El editor al que afecta. | | video_type | El tipo de vídeo del editor. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_delete()

Elimina una instancia de «otc_publisher_settings».

Parámetros : | | | | --- | --- | | settings | La instancia «otc_publisher_settings» que se va a eliminar. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_new()

Crea una nueva instancia de `otc_publisher_settings`.

Devuelve : Una nueva instancia de `otc_publisher_settings`

otc_publisher_settings_set_allow_audio_capture_while_muted()

En otc_publisher_settings_set_allow_audio_capture_while_muted se establece en false, el micrófono se apagará automáticamente cuando todos los participantes hayan silenciado su audio. El micrófono se volverá a encender automáticamente cuando al menos un participante active su audio. Si se configura en true, el micrófono permanecerá siempre activado, incluso cuando todos los emisores hayan silenciado su audio. Ten en cuenta que, cuando el micrófono esté desactivado, las funciones de devolución de llamada como `audio_level` o `audio_data` ya no se invocarán para los emisores. El valor por defecto es true. Véase otc_session_new_with_settings.

Parámetros : | | | | --- | --- | | settings | Puntero al objeto de configuración de la sesión. | | enable | Indicador booleano para desactivar (OTC_FALSE, el valor por defecto) o activar (OTC_TRUE) este indicador. |

Valores devueltos : otc_status Devuelve el estado de la operación.

otc_publisher_settings_set_audio_track()

Permite crear una pista de audio para un editor mediante otc_publisher_new_with_settings.

Parámetros : | | | | --- | --- | | settings | La instancia «otc_publisher_settings» a la que se aplicará el cambio. | | enabled | Activa o desactiva la creación de una pista de audio para un editor otc_publisher_new_with_settings. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_auto_gain_control()

Permite crear un control automático de ganancia de audio para un editor mediante otc_publisher_new_with_settings.

No funciona en el SDK para Linux de la Video API de Vonage.

Parámetros : | | | | --- | --- | | settings | La instancia de otc_publisher_settings a la que se aplicará el cambio. | | enabled | Si se debe habilitar (true, valor por defecto) o deshabilitar (false) el control automático de ganancia. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_default_camera_capture_resolution()

Establece la resolución de captura de la cámara para los programas de grabación de vídeo predeterminados.

Los dispositivos de captura de vídeo personalizados no deben respetar la resolución de captura establecida por otc_publisher_settings_set_default_camera_capture_resolution, esto solo se utiliza para los capturadores de vídeo predeterminados.

Parámetros : | | | | --- | --- | | camera_capture_resolution | La resolución de captura de la cámara para los capturadores de vídeo predeterminados. | | settings | La instancia de otc_publisher_settings a la que se aplicará el cambio. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_disable_audio_processing()

En otc_publisher_settings_set_disable_audio_processing se establece en true, se ignorarán los ajustes individuales de cancelación de eco acústico, control automático de ganancia y supresión de ruido, y el audio no se procesará en absoluto. El valor por defecto es false. Véase otc_publisher_new_with_settings.

Parámetros : | | | | --- | --- | | settings | La instancia «otc_publisher_settings» a la que se aplicará el cambio. | | enabled | Indica si se debe habilitar (true) o deshabilitar (false, valor por defecto) la compatibilidad con el procesamiento de audio. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_echo_cancellation()

Permite la cancelación del eco acústico para que se pueda construir un emisor con otc_publisher_new_with_settings.

Nota: Esta función solo es aplicable al SDK de macOS de la Video API de Vonage. No funciona en el SDK de Linux de la Video API de Vonage.

Parámetros : | | | | --- | --- | | settings | La instancia «otc_publisher_settings» a la que se aplicará el cambio. | | enabled | Si se debe habilitar (true, valor por defecto) o deshabilitar (false) la compatibilidad con la cancelación de eco acústico. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_name()

Establece el nombre deseado para un editor que se va a crear con otc_publisher_new_with_settings.

Parámetros : | | | | --- | --- | | settings | La instancia de otc_publisher_settings a la que se aplicará el cambio. | | name | El nombre del editor. Otros clientes pueden obtener los nombres de los flujos de la sesión. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_noise_suppression()

Permite la supresión de ruido para que se pueda crear un editor con otc_publisher_new_with_settings.

Nota: Esta función solo es aplicable al SDK de macOS de la Video API de Vonage. No funciona en el SDK de Linux de la Video API de Vonage.

Parámetros : | | | | --- | --- | | settings | La instancia de otc_publisher_settings a la que se aplicará el cambio. | | enabled | Si se debe habilitar (true, valor por defecto) o deshabilitar (false) la supresión de ruido. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_opus_dtx()

Permite Opus DTX para crear un editor con otc_publisher_new_with_settings. Al activar Opus DTX se puede reducir el consumo de ancho de banda en las transmisiones que presentan largos periodos de silencio.

Parámetros : | | | | --- | --- | | settings | La instancia de otc_publisher_settings a la que se aplicará el cambio. | | enabled | Si se desea habilitar (true) o deshabilitar (false, valor por defecto) la compatibilidad con Opus DTX. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_publisher_audio_fallback_enabled()

Activa o desactiva la función de audio de reserva del editor.

Cuando la función de recambio de audio del editor está activada, si el editor detecta que la calidad de una transmisión se ha degradado significativamente, desactiva la transmisión de vídeo para preservar la calidad del audio y sigue enviando la transmisión de audio. El capturador correspondiente a este editor no se desactivará, y los fotogramas capturados seguirán viéndose en el lado del editor.

La configuración predeterminada es OTC_FALSE (la función de recambio de audio está desactivada). Cuando se utiliza el tipo de vídeo de pantalla en una sesión que emplea el servidor multimedia de OpenTok, la configuración de recambio de audio del emisor se establece en OTC_FALSE de forma predeterminada, para que el vídeo no se interrumpa en los suscriptores.

Parámetros : | | | | --- | --- | | configuración | La configuración del editor a la que se aplicará el cambio. | | habilitado | Si queremos habilitar o no la función de audio alternativo. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_scalable_screenshare()

Permitir el uso de vídeo escalable vídeo escalable para una editorial que cuenta con el otc_publisher_video_type ajustado a OTC_PUBLISHER_VIDEO_TYPE_SCREEN con otc_publisher_new_with_settings.

Parámetros : | | | | --- | --- | | settings | La instancia «otc_publisher_settings» a la que se aplicará el cambio. | | enabled | Activa o desactiva el uso de vídeo escalable para las transmisiones de pantalla compartida. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_stereo()

Permite crear audio estéreo para un editor mediante otc_publisher_new_with_settings.

Parámetros : | | | | --- | --- | | settings | La instancia de otc_publisher_settings a la que se aplicará el cambio. | | enabled | Activa o desactiva la compatibilidad con audio estéreo para un editor que se vaya a crear con otc_publisher_new_with_settings. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_subscriber_audio_fallback_enabled()

Activa o desactiva la función de alternativa de audio para los suscriptores (para los suscriptores de la transmisión publicada)

La función de recambio de audio para suscriptores está disponible en las sesiones que utilizan el OpenTok Media Router. Con la función de recambio de audio activada (por defecto), cuando el OpenTok Media Router detecta que la calidad de una transmisión se ha degradado significativamente para un suscriptor concreto de dicha transmisión, desactiva el vídeo de ese suscriptor con el fin de preservar la calidad del audio.

La configuración predeterminada es OTC_TRUE (la función de recambio de audio está activada). Cuando se utiliza el tipo de vídeo en pantalla, la configuración de recambio de audio del suscriptor se establece en OTC_FALSE de forma predeterminada, para que el vídeo no se interrumpa en los suscriptores.

Parámetros : | | | | --- | --- | | configuración | La configuración del editor a la que se aplicará el cambio. | | habilitado | Si queremos habilitar o no la función de audio alternativo. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_video_capturer()

Establece que el capturador de vídeo de un editor se cree con otc_publisher_new_with_settings.

Parámetros : | | | | --- | --- | | settings | La instancia de otc_publisher_settings a la que se aplicará el cambio. | | capturer | El capturador de vídeo. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_publisher_settings_set_video_track()

Permite crear una pista de vídeo para un editor mediante otc_publisher_new_with_settings.

Parámetros : | | | | --- | --- | | settings | La instancia «otc_publisher_settings» a la que se aplicará el cambio. | | enabled | Activa o desactiva la creación de una pista de vídeo para un editor con otc_publisher_new_with_settings. |

Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.