OpenTok Publisher. Más...
#include "base.h"
#include "config.h"
#include "stream.h"
#include "video_frame.h"
#include "camera_capture_resolution.h"
#include "media_transformer.h"
#include "video_capturer.h"
#include "media_utils.h"
| Estructuras de datos | |
| struct | otc_publisher_video_layer_stats |
| struct | otc_publisher_audio_stats |
| struct | otc_publisher_video_stats |
| struct | otc_publisher_media_link_stats |
| struct | otc_publisher_callbacks |
| struct | otc_publisher_rtc_stats |
| struct | otc_publisher_rtc_stats_report_cb |
| Macros | |
| #define | OTC_MAX_VIDEO_LAYERS 3 |
| Definiciones de tipos | |
| typedef struct otc_publisher | otc_publisher |
| typedef struct otc_configuración_del_editor | otc_configuración_del_editor |
| Funciones | |
| otc_publisher * | otc_publisher_new (const char *nombre, const struct otc_video_capturer_callbacks *capturer, const struct otc_publisher_callbacks *funciones de devolución de llamada) |
| otc_configuración_del_editor * | otc_publisher_settings_new () |
| otc_status | otc_publisher_settings_delete (otc_configuración_del_editor *configuración) |
| otc_status | otc_publisher_settings_set_name (otc_configuración_del_editor *configuración, const char *nombre) |
| otc_status | otc_publisher_settings_set_video_capturer (otc_configuración_del_editor *configuración, const struct otc_video_capturer_callbacks *capturador) |
| otc_status | otc_publisher_settings_set_audio_track (otc_configuración_del_editor *configuración, otc_bool (activado) |
| otc_status | otc_publisher_settings_set_video_track (otc_configuración_del_editor *configuración, otc_bool (activado) |
| otc_status | otc_publisher_settings_set_sender_stats_track (otc_configuración_del_editor *configuración, otc_bool (activado) |
| otc_status | otc_publisher_settings_set_stereo (otc_configuración_del_editor *configuración, otc_bool (activado) |
| otc_status | otc_publisher_settings_set_opus_dtx (otc_configuración_del_editor *configuración, otc_bool (activado) |
| otc_status | otc_publisher_settings_set_auto_gain_control (otc_configuración_del_editor *configuración, otc_bool (activado) |
| otc_status | otc_publisher_settings_set_noise_suppression (otc_configuración_del_editor *configuración, otc_bool (activado) |
| otc_status | otc_publisher_settings_set_echo_cancellation (otc_configuración_del_editor *configuración, otc_bool (activado) |
| otc_status | otc_publisher_settings_set_disable_audio_processing (otc_configuración_del_editor *configuración, otc_bool (desactivado) |
| otc_status | otc_publisher_settings_set_default_camera_capture_resolution (otc_configuración_del_editor *configuración, enumeración constante otc_camera_capture_resolution (resolución de captura de la cámara) |
| otc_status | otc_publisher_settings_set_scalable_screenshare (otc_configuración_del_editor *configuración, constante otc_bool (activado) |
| otc_status | otc_publisher_settings_set_allow_audio_capture_while_muted (otc_configuración_del_editor *configuración, constante otc_bool (activado) |
| otc_publisher * | otc_publisher_new_with_settings (const struct otc_publisher_callbacks *funciones de devolución de llamada, otc_configuración_del_editor *configuración) |
| otc_status | otc_publisher_delete (otc_publisher *editor) |
| otc_stream * | otc_publisher_get_stream (otc_publisher *editor) |
| otc_status | otc_publisher_set_publish_video (otc_publisher *editor, otc_bool publish_video) |
| otc_status | otc_publisher_set_publish_audio (otc_publisher *editor, otc_bool publish_audio) |
| otc_status | otc_publisher_set_publish_captions (otc_publisher *editor, otc_bool publish_captions) |
| otc_bool | otc_publisher_get_publish_video (const otc_publisher *editor) |
| otc_bool | otc_publisher_get_publish_audio (const otc_publisher *editor) |
| otc_bool | otc_publisher_get_publish_captions (const otc_publisher *editor) |
| otc_session * | otc_publisher_get_session (const otc_publisher *editor) |
| otc_status | otc_publisher_set_max_audio_bitrate (otc_publisher *editor, tasa de bits uint32_t) |
| otc_status | otc_publisher_set_rtc_stats_report_cb (otc_publisher *editor, const struct otc_publisher_rtc_stats_report_cb cb) |
| otc_status | otc_publisher_get_rtc_stats_report (const otc_publisher *editor) |
| const char * | otc_publisher_get_publisher_id (const otc_publisher *editor) |
| otc_status | otc_publisher_set_video_type (struct otc_publisher *editor, enumeración otc_publisher_video_type tipo_de_vídeo) |
| enum otc_publisher_video_type | otc_publisher_get_video_type (const struct otc_publisher *editor) |
| void * | otc_publisher_get_user_data (const struct otc_publisher *editor) |
| const char * | otc_publisher_get_name (const struct otc_publisher *editor) |
| otc_status | otc_publisher_set_video_transformers (otc_publisher *editor, otc_video_transformer **transformadores, uint8_t tamaño) |
| 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. Más... | |
| otc_status | otc_publisher_set_audio_transformers (otc_publisher *editor, otc_audio_transformer **transformadores, uint8_t tamaño) |
| Establece una matriz de transformadores de audio en el flujo de audio de este editor. Si se establece en null, se restablecen los transformadores. Más... | |
| otc_status | otc_publisher_set_target_scalability_mode (otc_publisher *publisher, const char *scalability_mode) |
| Establece el modo de escalabilidad de destino (SVC: codificación de vídeo escalable) para este editor. El modo de escalabilidad controla el número de capas espaciales (resolución) y temporales (frecuencia de fotogramas) que codifica WebRTC. El modo se aplica únicamente a la conexión entre pares enrutada (emisor ↔ SFU), independientemente de cuál de los tramos esté activo en ese momento. Más... | |
| const char * | otc_publisher_get_target_scalability_mode (otc_publisher *editor) |
Obtiene el modo de escalabilidad de destino que se ha establecido explícitamente mediante otc_publisher_set_target_scalability_mode. Devuelve el último valor pasado al método de configuración, o NULL si nunca se ha llamado a dicho método. Esto refleja la intención del usuario, no el modo realmente aplicado (que puede diferir debido a un recurso alternativo dependiente del códec). Más... |
|
| otc_status | otc_publisher_set_max_video_bitrate (otc_publisher *editor, int bitrate_bps) |
| Obtiene la tasa de bits máxima de vídeo establecida para la transmisión de vídeo de este editor. Más... | |
| int | otc_publisher_get_max_video_bitrate (const otc_publisher *editor) |
| Obtiene la tasa de bits máxima de vídeo establecida para la transmisión de vídeo de este editor. Más... | |
| otc_status | otc_publisher_set_video_bitrate_preset (otc_publisher *editor, enumeración otc_video_bitrate_preset (preajuste) |
| Establece un valor predefinido de velocidad de bits de vídeo para la transmisión de vídeo de este editor. Más... | |
| enum otc_video_bitrate_preset | otc_publisher_get_video_bitrate_preset (const otc_publisher *editor) |
| Obtiene el ajuste de velocidad de bits de vídeo actualmente activo para la retransmisión de este emisor. Más... | |
| otc_status | otc_publisher_set_degradation_preference (otc_publisher *editor, enumeración otc_preferencia_de_degradación (preferencia_de_degradación) |
| Establece la política preferida que seguirá el motor de vídeo a la hora de ajustar la frecuencia de fotogramas y la resolución en función de las limitaciones de ancho de banda y de la CPU. Consulta otc_degradation_preference para obtener una descripción de los valores posibles. Más... | |
| enum otc_preferencia_de_degradación | otc_publisher_get_degradation_preference (const otc_publisher *editor) |
| Obtiene la política preferida que seguirá el motor de vídeo a la hora de ajustar la frecuencia de fotogramas y la resolución en función de las limitaciones de ancho de banda y de la CPU. Consulta otc_degradation_preference para ver una descripción de los valores posibles. Más... | |
| otc_status | otc_publisher_settings_set_subscriber_audio_fallback_enabled (otc_configuración_del_editor *configuración, constante otc_bool (activado) |
| otc_status | otc_publisher_settings_set_publisher_audio_fallback_enabled (otc_configuración_del_editor *configuración, constante otc_bool (activado) |
| otc_status | otc_publisher_settings_set_preferred_video_codecs (otc_configuración_del_editor *configuración, constante otc_tipo_de_códec_de_vídeo *codecs, size_t num_codecs) |
| Establece los códecs de vídeo preferidos que se utilizarán para la retransmisión de este creador de contenido. Más... | |
| otc_status | otc_publisher_settings_set_preferred_video_codecs_automatic (otc_configuración_del_editor *configuración) |
| Habilita la priorización automática de códecs para la retransmisión de este emisor. Más... |
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
| typedef struct otc_publisher 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
| typedef struct otc_configuración_del_editor otc_configuración_del_editor |
Definición del tipo de configuración de editor de OpenTok.
Documentación sobre tipos de enumeración
otc_preferencia_de_degradación
Describe la política que el motor de vídeo intentará seguir a la hora de adaptar la frecuencia de fotogramas y la resolución a un ancho de banda y una CPU limitados. Se trata de una política de «mejor esfuerzo». No hay garantías respecto a la frecuencia de fotogramas y es posible que se omitan algunos fotogramas por otros motivos.
Para más información, consulta Preferencia de degradación.
| Encuestador | |
|---|---|
| OTC_DEGRADATION_PREFERENCE_NOT_SET | Valor por defecto. El motor de vídeo determinará la preferencia de degradación óptima. |
| OTC_DEGRADATION_PREFERENCE_MAINTAIN_FRAMERATE_AND_RESOLUTION | El motor de vídeo no reducirá la resolución e intentará mantener constante la frecuencia de fotogramas. En algunas versiones del estándar, esta opción se denomina «DISABLED», lo que significa que no se aplicará ningún tipo de reducción de calidad cuando los recursos sean limitados. |
| OTC_DEGRADATION_PREFERENCE_MAINTAIN_FRAMERATE | El motor de vídeo intentará mantener constante la frecuencia de fotogramas, pero podría reducir la resolución si fuera necesario. |
| OTC_DEGRADATION_PREFERENCE_MAINTAIN_RESOLUTION | El motor de vídeo no reducirá la resolución, pero podría reducir la frecuencia de fotogramas si fuera necesario. |
| OTC_DEGRADATION_PREFERENCE_BALANCED | El motor de vídeo intentará encontrar un equilibrio entre la reducción de la resolución y la frecuencia de fotogramas cuando sea necesario. |
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.
| Encuestador | |
|---|---|
| OTC_PUBLISHER_INTERNAL_ERROR | Error interno. |
| OTC_PUBLISHER_SESSION_DISCONNECTED | Se ha producido un error al intentar activar los subtítulos en una sesión a la que no estás conectado. |
| OTC_PUBLISHER_TIMED_OUT | Se ha producido un tiempo de espera al intentar publicar. |
| OTC_PUBLISHER_UNABLE_TO_PUBLISH | Error al intentar publicar. |
| OTC_PUBLISHER_WEBRTC_ERROR | Error de WebRTC. |
| OTC_PUBLISHER_ENCRYPTION_INTERNAL_ERROR | Error interno al cifrar un paquete |
| OTC_PUBLISHER_ENCRYPTION_UNSUPPORTED_CODEC | Códec multimedia no compatible con el cifrado |
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.
| Encuestador | |
|---|---|
| OTC_PUBLISHER_VIDEO_TYPE_CAMERA | Transmisión de vídeo de la cámara. |
| OTC_PUBLISHER_VIDEO_TYPE_SCREEN | Captura de pantalla de una transmisión de vídeo. |
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.
| Encuestador | |
|---|---|
| OTC_VIDEO_BITRATE_PRESET_DEFAULT | Configuración predeterminada. No se aplican restricciones adicionales. Este es el modo predeterminado. |
| OTC_VIDEO_BITRATE_PRESET_BW_SAVER | Configuración predefinida de ahorro de ancho de banda. Aplica restricciones moderadas para reducir el consumo de ancho de banda, manteniendo al mismo tiempo una calidad de vídeo razonable. |
| OTC_VIDEO_BITRATE_PRESET_EXTRA_BW_SAVER | Preajuste adicional de ahorro de ancho de banda. Aplica restricciones estrictas para minimizar el uso de ancho de banda. |
| OTC_VIDEO_BITRATE_PRESET_CUSTOM | Velocidad de bits personalizada. Representa una velocidad de bits configurada manualmente mediante otc_publisher_set_max_video_bitrate(). El getter del preset devuelve este valor únicamente con fines de seguimiento interno y no se puede pasar al setter del preset. |
Documentación de funciones
otc_publisher_delete()
| otc_status otc_publisher_delete | ( | otc_publisher * | editor | ) |
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_degradation_preference()
| enum otc_preferencia_de_degradación otc_publisher_get_degradation_preference | ( | const otc_publisher * | editor | ) |
Obtiene la política preferida que seguirá el motor de vídeo a la hora de ajustar la frecuencia de fotogramas y la resolución en función de las limitaciones de ancho de banda y de la CPU. Consulta otc_degradation_preference para obtener una descripción de los valores posibles.
Parámetros : | | | | | --- | --- | --- | | [in] | publisher | La instancia del editor. |
Devuelve : La preferencia de degradación actual.
otc_publisher_get_max_video_bitrate()
| int otc_publisher_get_max_video_bitrate | ( | const otc_publisher * | editor | ) |
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()
| const char * otc_publisher_get_name | ( | const struct otc_publisher * | editor | ) |
Obtiene el nombre de un editor determinado.
Parámetros : | | | | --- | --- | | publisher | La instancia del editor. |
Devuelve : El nombre.
otc_publisher_get_publish_audio()
| otc_bool otc_publisher_get_publish_audio | ( | const otc_publisher * | editor | ) |
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()
| otc_bool otc_publisher_get_publish_captions | ( | const otc_publisher * | editor | ) |
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()
| otc_bool otc_publisher_get_publish_video | ( | const otc_publisher * | editor | ) |
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()
| const char * otc_publisher_get_publisher_id | ( | const otc_publisher * | editor | ) |
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()
| otc_status otc_publisher_get_rtc_stats_report | ( | const otc_publisher * | editor | ) |
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()
| otc_session * otc_publisher_get_session | ( | const otc_publisher * | editor | ) |
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()
| otc_stream * otc_publisher_get_stream | ( | otc_publisher * | editor | ) |
Devuelve el flujo asociado al editor. No hay funciones de devolución de llamada en otc_publisher_callbacks se ejecutará como consecuencia de la llamada a este método (o posteriormente).
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_target_scalability_mode()
| const char * otc_publisher_get_target_scalability_mode | ( | otc_publisher * | editor | ) |
Obtiene el modo de escalabilidad de destino que se ha establecido explícitamente mediante otc_publisher_set_target_scalability_mode. Devuelve el último valor pasado al método setter, o NULL si nunca se ha llamado a dicho método. Esto refleja la intención del usuario, no el modo realmente aplicado (que puede diferir debido a un recurso alternativo dependiente del códec).
Esta es una función en fase beta.
Parámetros : | | | | --- | --- | | publisher | La instancia del editor. |
Valores devueltos : El modo de escalabilidad de destino establecido por el llamante, o NULL si no se ha establecido explícitamente.
otc_publisher_get_user_data()
| void * otc_publisher_get_user_data | ( | const struct otc_publisher * | editor | ) |
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()
| enum otc_video_bitrate_preset otc_publisher_get_video_bitrate_preset | ( | const otc_publisher * | editor | ) |
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()
| enum otc_publisher_video_type otc_publisher_get_video_type | ( | const struct otc_publisher * | editor | ) |
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()
| otc_publisher * otc_publisher_new | ( | const char * | nombre, |
| const struct otc_video_capturer_callbacks * | capturador, | ||
| const struct otc_publisher_callbacks * | funciones de devolución de llamada | ||
| ) |
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()
| otc_publisher * otc_publisher_new_with_settings | ( | const struct otc_publisher_callbacks * | funciones de devolución de llamada, |
| otc_configuración_del_editor * | ajustes | ||
| ) |
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_transformers()
| otc_status otc_publisher_set_audio_transformers | ( | otc_publisher * | editor, |
| otc_audio_transformer ** | transformadores, | ||
| uint8_t | tamaño | ||
| ) |
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_degradation_preference()
| otc_status otc_publisher_set_degradation_preference | ( | otc_publisher * | editor, |
| enum otc_preferencia_de_degradación | preferencia_de_degradación | ||
| ) |
Establece la política preferida que seguirá el motor de vídeo a la hora de ajustar la frecuencia de fotogramas y la resolución en función de las limitaciones de ancho de banda y de la CPU. Consulta otc_degradation_preference para obtener una descripción de los valores posibles.
Parámetros : | | | | | --- | --- | --- | | [in] | publisher | La instancia del editor. | | [in] | degradation_preference | La preferencia de degradación. |
Devuelve : OTC_SUCCESS o un error.
otc_publisher_set_max_audio_bitrate()
| otc_status otc_publisher_set_max_audio_bitrate | ( | otc_publisher * | editor, |
| uint32_t | tasa de bits | ||
| ) |
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()
| otc_status otc_publisher_set_max_video_bitrate | ( | otc_publisher * | editor, |
| int | velocidad de transmisión (bps) | ||
| ) |
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()
| otc_status otc_publisher_set_publish_audio | ( | otc_publisher * | editor, |
| otc_bool | 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()
| otc_status otc_publisher_set_publish_captions | ( | otc_publisher * | editor, |
| otc_bool | publicar_leyendas | ||
| ) |
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()
| otc_status otc_publisher_set_publish_video | ( | otc_publisher * | editor, |
| otc_bool | publicar_vídeo | ||
| ) |
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()
| otc_status otc_publisher_set_rtc_stats_report_cb | ( | otc_publisher * | editor, |
| const struct otc_publisher_rtc_stats_report_cb | 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_target_scalability_mode()
| otc_status otc_publisher_set_target_scalability_mode | ( | otc_publisher * | editor, |
| const char * | modo_de_escalabilidad | ||
| ) |
Establece el modo de escalabilidad de destino (SVC: codificación de vídeo escalable) para este editor. El modo de escalabilidad controla el número de capas espaciales (resolución) y temporales (frecuencia de fotogramas) que codifica WebRTC. El modo se aplica únicamente a la conexión entre pares enrutada (emisor ↔ SFU), independientemente de cuál de los tramos esté activo en ese momento.
Este método puede invocarse en cualquier momento; no es necesario que haya finalizado la negociación del tramo enrutado. El modo se aplicará una vez que se haya establecido el tramo enrutado.
Si se negocia un códec que no sea SVC (VP8, H.264) en el tramo enrutado, se utiliza el modo aplicable más cercano: las capas espaciales se fijan obligatoriamente en 1, conservando la dimensión temporal (por ejemplo, L2T2 → L1T2 cuando se negocia VP8).
Esta es una función en fase beta.
Errores:
- Devuelve OTC_ERROR si el modo solicitado no es un modo de escalabilidad válido (es decir, no es uno de los siguientes: L1T1, L1T2, L1T3, L2T1, L2T2, L2T3, L3T1, L3T2, L3T3).
Parámetros : | | | | --- | --- | | publisher | La instancia del editor. | | scalability_mode | El modo de escalabilidad de destino. |
Valores devueltos : OTC_SUCCESS si la operación se realiza correctamente; en caso contrario, un código de error.
otc_publisher_set_video_bitrate_preset()
| otc_status otc_publisher_set_video_bitrate_preset | ( | otc_publisher * | editor, |
| enum otc_video_bitrate_preset | preajustado | ||
| ) |
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()
| otc_status otc_publisher_set_video_transformers | ( | otc_publisher * | editor, |
| otc_video_transformer ** | transformadores, | ||
| uint8_t | tamaño | ||
| ) |
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()
| otc_status otc_publisher_set_video_type | ( | struct otc_publisher * | editor, |
| enum otc_publisher_video_type | tipo_de_vídeo | ||
| ) |
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()
| otc_status otc_publisher_settings_delete | ( | otc_configuración_del_editor * | ajustes | ) |
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()
| otc_configuración_del_editor * 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()
| otc_status otc_publisher_settings_set_allow_audio_capture_while_muted | ( | otc_configuración_del_editor * | ajustes, |
| const otc_bool | activado | ||
| ) |
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()
| otc_status otc_publisher_settings_set_audio_track | ( | otc_configuración_del_editor * | ajustes, |
| otc_bool | activado | ||
| ) |
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()
| otc_status otc_publisher_settings_set_auto_gain_control | ( | otc_configuración_del_editor * | ajustes, |
| otc_bool | activado | ||
| ) |
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()
| otc_status otc_publisher_settings_set_default_camera_capture_resolution | ( | otc_configuración_del_editor * | ajustes, |
| const enum otc_camera_capture_resolution | resolución_de_captura_de_la_cámara | ||
| ) |
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()
| otc_status otc_publisher_settings_set_disable_audio_processing | ( | otc_configuración_del_editor * | ajustes, |
| otc_bool | discapacitado | ||
| ) |
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()
| otc_status otc_publisher_settings_set_echo_cancellation | ( | otc_configuración_del_editor * | ajustes, |
| otc_bool | activado | ||
| ) |
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()
| otc_status otc_publisher_settings_set_name | ( | otc_configuración_del_editor * | ajustes, |
| const char * | nombre | ||
| ) |
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()
| otc_status otc_publisher_settings_set_noise_suppression | ( | otc_configuración_del_editor * | ajustes, |
| otc_bool | activado | ||
| ) |
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()
| otc_status otc_publisher_settings_set_opus_dtx | ( | otc_configuración_del_editor * | ajustes, |
| otc_bool | activado | ||
| ) |
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_preferred_video_codecs()
| otc_status otc_publisher_settings_set_preferred_video_codecs | ( | otc_configuración_del_editor * | ajustes, |
| const otc_tipo_de_códec_de_vídeo * | códecs, | ||
| size_t | número_de_códecs | ||
| ) |
Establece los códecs de vídeo preferidos que se utilizarán para la retransmisión de este creador de contenido.
Esta función permite especificar una lista explícita y ordenada de códecs de vídeo a los que se dará prioridad durante la negociación. Los códecs indicados aparecerán en primer lugar en la oferta SDP (en el orden indicado), aunque también se podrán incluir otros códecs compatibles con una prioridad menor.
Esto no limita la negociación únicamente a estos códecs.
Si se pasa una lista vacía, se producirá un error OT_INVALID_PARAMETER. Si no se llama a esta función, el SDK recurre al comportamiento predeterminado definido en la configuración del proyecto del Dashboard.
Parámetros : | | | | | --- | --- | --- | | [in,out] | settings | La instancia de configuración del editor que se va a modificar. | | [in] | codecs | Una matriz de códecs de vídeo a los que dar prioridad (no debe estar vacía). | | [in] | num_codecs | El número de elementos de la matriz de códecs. |
Valores devueltos : OTC_SUCCESS si la operación se realiza correctamente; OT_INVALID_PARAMETER si la lista está vacía o no es válida.
otc_publisher_settings_set_preferred_video_codecs_automatic()
| otc_status otc_publisher_settings_set_preferred_video_codecs_automatic | ( | otc_configuración_del_editor * | ajustes | ) |
Habilita la priorización automática de códecs para la transmisión de este emisor.
En el modo automático, el SDK determina el orden de prioridad de códecs más adecuado, anulando la configuración predeterminada del proyecto establecida en el panel de control.
Esto ofrece una forma sencilla de delegar la elección del códec al SDK sin necesidad de especificar una lista manualmente.
Parámetros : | | | | | --- | --- | --- | | [in,out] | configuración | La instancia de configuración del editor que se va a modificar. |
Valores devueltos : OTC_SUCCESS si la operación se realiza correctamente; en caso contrario, un código de error.
otc_publisher_settings_set_publisher_audio_fallback_enabled()
| otc_status otc_publisher_settings_set_publisher_audio_fallback_enabled | ( | otc_configuración_del_editor * | ajustes, |
| const otc_bool | activado | ||
| ) |
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()
| otc_status otc_publisher_settings_set_scalable_screenshare | ( | otc_configuración_del_editor * | ajustes, |
| const otc_bool | activado | ||
| ) |
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_sender_stats_track()
| otc_status otc_publisher_settings_set_sender_stats_track | ( | otc_configuración_del_editor * | ajustes, |
| otc_bool | activado | ||
| ) |
Permite crear un canal de estadísticas del remitente para un editor mediante otc_publisher_new_with_settings. Actualmente, esta función solo admite llamadas con más de dos participantes. Por defecto, el canal de estadísticas del remitente está desactivado.
Parámetros
: | | |
| --- | --- |
| settings | La instancia de otc_publisher_settings a la que se aplicará el cambio. |
| enabled | Activa o desactiva la creación de un canal de estadísticas del remitente para un editor mediante 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_stereo()
| otc_status otc_publisher_settings_set_stereo | ( | otc_configuración_del_editor * | ajustes, |
| otc_bool | activado | ||
| ) |
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()
| otc_status otc_publisher_settings_set_subscriber_audio_fallback_enabled | ( | otc_configuración_del_editor * | ajustes, |
| const otc_bool | activado | ||
| ) |
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 Vonage Video Media Router. Con la función de recambio de audio activada (por defecto), cuando el Vonage Video 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.
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()
| otc_status otc_publisher_settings_set_video_capturer | ( | otc_configuración_del_editor * | ajustes, |
| const struct otc_video_capturer_callbacks * | capturador | ||
| ) |
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()
| otc_status otc_publisher_settings_set_video_track | ( | otc_configuración_del_editor * | ajustes, |
| otc_bool | activado | ||
| ) |
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.