publisher.h

Este archivo incluye la definición de tipo de un «publisher» 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_publisher_rtc_stats_report_cb

Incluye: base.h, config.h, stream.h, video_frame.h, camera_capture_resolution.h, media_transformer.h, video_capturer.h, media_utils.h

#define OTC_MAX_VIDEO_LAYERS

#define OTC_MAX_VIDEO_LAYERS 3

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.

typedef struct otc_publisher otc_publisher;

typedef otc_publisher_settings

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

typedef struct otc_publisher_settings otc_publisher_settings;

enumeración otc_publisher_error_code

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

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

Nombre Valor Descripción
OTC_PUBLISHER_INTERNAL_ERROR 2000 Error interno.
OTC_PUBLISHER_SESSION_DISCONNECTED 1010 La sesión en la que la editorial estaba publicando se ha desconectado.
OTC_PUBLISHER_TIMED_OUT 1541 Se ha producido un tiempo de espera al intentar publicar.
OTC_PUBLISHER_UNABLE_TO_PUBLISH 1500 Error al intentar publicar.
OTC_PUBLISHER_WEBRTC_ERROR 1610 Error de WebRTC.
OTC_PUBLISHER_CAPTIONS_CHANGE_RATE_LIMIT_ERROR 5010 El servidor ha rechazado una solicitud de modificación de subtítulos para el editor porque se han realizado demasiadas en un breve periodo de tiempo. Se puede volver a intentar la operación en unos segundos.
OTC_PUBLISHER_ENCRYPTION_INTERNAL_ERROR 6001 Error interno al cifrar un paquete
OTC_PUBLISHER_ENCRYPTION_UNSUPPORTED_CODEC 6005 Códec multimedia no compatible con el cifrado
OTC_PUBLISHER_ENCRYPTION_NOT_ENABLED 6007 Se ha establecido una clave de cifrado, pero la sesión no se ha configurado con cifrado de extremo a extremo.

enumeración 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.

Nombre Valor Descripción
OTC_PUBLISHER_VIDEO_TYPE_CAMERA 1 Transmisión de vídeo de la cámara.
OTC_PUBLISHER_VIDEO_TYPE_SCREEN 2 Captura de pantalla de una transmisión de vídeo.

enumeración otc_media_type

Tipo de medio.

Nombre Valor Descripción
OTC_MEDIA_TYPE_VIDEO 0
OTC_MEDIA_TYPE_AUDIO

enumeración otc_video_bitrate_preset

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.

Nombre Descripción
OTC_VIDEO_BITRATE_PRESET_DEFAULT Este es el modo predeterminado.
OTC_VIDEO_BITRATE_PRESET_BW_SAVER Aplica restricciones moderadas para reducir el consumo de ancho de banda, al tiempo que mantiene una calidad de vídeo razonable.
OTC_VIDEO_BITRATE_PRESET_EXTRA_BW_SAVER Aplica restricciones estrictas para minimizar el uso del ancho de banda.
OTC_VIDEO_BITRATE_PRESET_CUSTOM 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.

enumeración otc_degradation_preference

Para más información, consulta Preferencia de degradación.

Nombre Valor Descripción
OTC_DEGRADATION_PREFERENCE_NOT_SET -1 Valor por defecto. El motor de vídeo determinará la preferencia de degradación óptima.
OTC_DEGRADATION_PREFERENCE_MAINTAIN_FRAMERATE_AND_RESOLUTION 0 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 1 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 2 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 3 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.

Funciones

Nombre Descripción
otc_publisher_new(name, capturer, callbacks) → {otc_publisher *} Crea un nuevo otc_publisher instancia.
otc_publisher_settings_new() → {otc_publisher_settings *} Crea un nuevo otc_configuración_del_editor instancia.
otc_publisher_settings_delete(settings) → {otc_status} Elimina un otc_configuración_del_editor instancia.
otc_publisher_settings_set_name(settings, name) → {otc_status} Establece el nombre deseado para un editor que se va a crear con otc_publisher_new_with_settings.
otc_publisher_settings_set_video_capturer(settings, capturer) → {otc_status} Establece que el capturador de vídeo de un editor se cree con otc_publisher_new_with_settings.
otc_publisher_settings_set_audio_track(settings, enabled) → {otc_status} Permite crear una pista de audio para un editor mediante otc_publisher_new_with_settings.
otc_publisher_settings_set_video_track(settings, enabled) → {otc_status} Permite crear una pista de vídeo para un editor mediante otc_publisher_new_with_settings.
otc_publisher_settings_set_sender_stats_track(settings, enabled) → {otc_status} Permite crear un canal de estadísticas del remitente para un editor mediante otc_publisher_new_with_settings.
otc_publisher_settings_set_stereo(settings, enabled) → {otc_status} Permite crear audio estéreo para un editor mediante otc_publisher_new_with_settings.
otc_publisher_settings_set_opus_dtx(settings, enabled) → {otc_status} Permite Opus DTX para crear un editor con otc_publisher_new_with_settings.
otc_publisher_settings_set_auto_gain_control(settings, enabled) → {otc_status} Permite crear un control automático de ganancia de audio para un editor mediante otc_publisher_new_with_settings.
otc_publisher_settings_set_noise_suppression(settings, enabled) → {otc_status} Permite la supresión de ruido para que se pueda crear un editor con otc_publisher_new_with_settings.
otc_publisher_settings_set_echo_cancellation(settings, enabled) → {otc_status} Permite la cancelación del eco acústico para que se pueda construir un emisor con otc_publisher_new_with_settings.
otc_publisher_settings_set_disable_audio_processing(settings, disabled) → {otc_status} 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.
otc_publisher_settings_set_default_camera_capture_resolution(settings, camera_capture_resolution) → {otc_status} Establece la resolución de captura de la cámara para los programas de grabación de vídeo predeterminados.
otc_publisher_settings_set_scalable_screenshare(settings, enabled) → {otc_status} 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.
otc_publisher_settings_set_allow_audio_capture_while_muted(settings, enabled) → {otc_status} 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.
otc_publisher_new_with_settings(callbacks, settings) → {otc_publisher *} Crea un nuevo otc_publisher instancia.
otc_publisher_delete(publisher) → {otc_status} Libera una instancia de editor, incluidos todos los recursos de hardware asociados a ella.
otc_publisher_get_stream(publisher) → {otc_stream *} Devuelve el flujo asociado al editor.
otc_publisher_set_publish_video(publisher, publish_video) → {otc_status} Si publicar o no el vídeo.
otc_publisher_set_publish_audio(publisher, publish_audio) → {otc_status} Si se debe publicar el audio o no.
otc_publisher_set_publish_captions(publisher, publish_captions) → {otc_status} Si se deben activar o no los subtítulos.
otc_publisher_get_publish_video(publisher) → {otc_bool} Indica si el editor está publicando un vídeo o no.
otc_publisher_get_publish_audio(publisher) → {otc_bool} Devuelve si el Publisher está reproduciendo audio o no.
otc_publisher_get_publish_captions(publisher) → {otc_bool} Devuelve si el Publisher tiene subtítulos activos.
otc_publisher_set_captions_input_language(publisher, language) → {otc_status} Establece el idioma de entrada preferido para los subtítulos de un editor determinado.
otc_publisher_get_captions_input_language(publisher) → {const char *} Obtiene el idioma de entrada de los subtítulos configurado para un editor determinado.
otc_publisher_get_session(publisher) → {otc_session *} Devuelve el otc_session asociada a esta instancia de editor.
otc_publisher_set_max_audio_bitrate(publisher, bitrate) → {otc_status} Establece la tasa de bits máxima de audio para el editor.
otc_publisher_set_rtc_stats_report_cb(publisher, cb) → {otc_status} Establece la función de devolución de llamada del informe de estadísticas de RTC del editor.
otc_publisher_get_rtc_stats_report(publisher) → {otc_status} Obtiene el informe de estadísticas de RTC correspondiente al editor.
otc_publisher_get_publisher_id(publisher) → {const char *} Obtiene un identificador único para un editor.
otc_publisher_set_video_type(publisher, video_type) → {otc_status} Establece el tipo de vídeo del editor.
otc_publisher_get_video_type(publisher) → {enum otc_publisher_video_type} Obtiene el tipo de vídeo del editor.
otc_publisher_get_user_data(publisher) → {void *} Obtiene los datos de usuario de un editor determinado.
otc_publisher_get_name(publisher) → {const char *} Obtiene el nombre de un editor determinado.
otc_publisher_set_video_transformers(publisher, transformers, size) → {otc_status} La matriz puede estar compuesta por transformadores de vídeo de Vonage proporcionados por ml-library y/o por transformadores personalizados.
otc_publisher_set_audio_transformers(publisher, transformers, size) → {otc_status} La matriz puede estar compuesta por transformadores de audio de Vonage proporcionados por ml-library y/o por transformadores personalizados.
otc_publisher_set_target_scalability_mode(publisher, scalability_mode) → {otc_status} Este método puede invocarse en cualquier momento; no es necesario que haya finalizado la negociación de la etapa enrutada.
otc_publisher_get_target_scalability_mode(publisher) → {const char *} Esta es una función en fase beta.
otc_publisher_set_max_video_bitrate(publisher, bitrate_bps) → {otc_status} Devuelve la tasa de bits máxima actual del vídeo en bits por segundo (bps).
otc_publisher_get_max_video_bitrate(publisher) → {int} Devuelve la tasa de bits máxima de vídeo configurada actualmente en bits por segundo (bps).
otc_publisher_set_video_bitrate_preset(publisher, preset) → {otc_status} Aplica una estrategia predefinida de velocidad de bits de vídeo para controlar el comportamiento del codificador.
otc_publisher_get_video_bitrate_preset(publisher) → {enum otc_video_bitrate_preset} 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.
otc_publisher_set_degradation_preference(publisher, degradation_preference) → {otc_status}
otc_publisher_get_degradation_preference(publisher) → {enum otc_degradation_preference}
otc_publisher_settings_set_subscriber_audio_fallback_enabled(settings, enabled) → {otc_status} Activa o desactiva la función de audio de reserva para los suscriptores (para los suscriptores de la transmisión publicada). La función de audio de reserva para los suscriptores está disponible en las sesiones que utilizan el Vonage Video Media Router.
otc_publisher_settings_set_publisher_audio_fallback_enabled(settings, enabled) → {otc_status} Activa o desactiva la función de audio de reserva del editor.
otc_publisher_settings_set_preferred_video_codecs(settings, codecs, num_codecs) → {otc_status} Esta función permite especificar una lista explícita y ordenada de códecs de vídeo a los que se debe dar prioridad durante la negociación.
otc_publisher_settings_set_preferred_video_codecs_automatic(settings) → {otc_status} 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.

otc_publisher_new(nombre, capturador, callbacks) → {otc_publisher *}

Crea un nuevo otc_publisher instancia.

Parámetros:
Nombre Tipo Descripción
name const char * El nombre del editor. Otros clientes pueden obtener los nombres de las transmisiones en la sesión.
capturer const struct otc_video_capturer_callbacks * 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 utiliza la cámara del sistema.
callbacks const struct otc_publisher_callbacks * Un puntero a la estructura que contiene los punteros a las funciones de devolución de llamada del editor.
Devoluciones:

Una nueva otc_publisher instancia. Si se produce un error, este valor es nulo.

otc_publisher_settings_new() → {otc_publisher_settings *}

Crea un nuevo otc_configuración_del_editor instancia.

Devoluciones:

Una nueva otc_configuración_del_editor instancia

otc_publisher_settings_delete(settings) → {otc_status}

Elimina un otc_configuración_del_editor instancia.

Parámetros:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se va a eliminar.
Devoluciones:

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(settings, name) → {otc_status}

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

Parámetros:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
name const char * El nombre del editor. Otros clientes pueden obtener los nombres de las transmisiones en la sesión.
Devoluciones:

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(settings, capturer) → {otc_status}

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

Parámetros:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
capturer const struct otc_video_capturer_callbacks * El capturador de vídeo.
Devoluciones:

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

otc_publisher_settings_set_audio_track(settings, enabled) → {otc_status}

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

Parámetros:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
enabled otc_bool Activar/desactivar la presencia de una pista de audio para que se cree un editor con otc_publisher_new_with_settings.
Devoluciones:

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(settings, enabled) → {otc_status}

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

Parámetros:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
enabled otc_bool Activar/desactivar la existencia de una pista de vídeo para que se cree un editor con otc_publisher_new_with_settings.
Devoluciones:

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(settings, enabled) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
enabled otc_bool Activar o desactivar la creación de un canal de estadísticas del remitente para un editor mediante otc_publisher_new_with_settings.
Devoluciones:

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(settings, enabled) → {otc_status}

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

Parámetros:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
enabled otc_bool Activar/desactivar la compatibilidad con audio estéreo para que un editor se pueda crear con otc_publisher_new_with_settings.
Devoluciones:

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(settings, enabled) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
enabled otc_bool Si se desea habilitar (true) o deshabilitar (false, valor por defecto) la compatibilidad con Opus DTX.
Devoluciones:

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(settings, enabled) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
enabled otc_bool Si se desea activar (true, valor predeterminado) o desactivar (false) el control automático de ganancia.
Devoluciones:

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(settings, enabled) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
enabled otc_bool Si se desea activar (true, valor predeterminado) o desactivar (false) la supresión de ruido.
Devoluciones:

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(settings, enabled) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
enabled otc_bool Si se desea habilitar (true, valor por defecto) o deshabilitar (false) la función de cancelación de eco acústico.
Devoluciones:

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(settings, disabled) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
disabled otc_bool
Devoluciones:

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(settings, camera_capture_resolution) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
camera_capture_resolution const enum otc_camera_capture_resolution La resolución de captura de la cámara para los programas de grabación de vídeo predeterminados.
Devoluciones:

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(settings, enabled) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * El otc_configuración_del_editor instancia que se verá afectada.
enabled const otc_bool Activar o desactivar el uso de vídeo escalable para las transmisiones de pantalla compartida.
Devoluciones:

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

otc_publisher_settings_set_allow_audio_capture_while_muted(settings, enabled) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * Puntero al objeto de configuración de la sesión.
enabled const otc_bool
Devoluciones:

otc_status Devuelve el estado de la operación.

otc_publisher_new_with_settings(callbacks, settings) → {otc_publisher *}

Crea un nuevo otc_publisher instancia.

Parámetros:
Nombre Tipo Descripción
callbacks const struct otc_publisher_callbacks * Un puntero a la estructura que contiene los punteros a las funciones de devolución de llamada del editor.
settings otc_publisher_settings * La estructura de configuración que contiene los ajustes deseados para el editor.
Devoluciones:

Una nueva otc_publisher instancia. Si se produce un error, este valor es nulo.

otc_publisher_delete(publisher) → {otc_status}

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

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La instancia de editor que se va a eliminar.
Devoluciones:

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

otc_publisher_get_stream(publisher) → {otc_stream *}

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:
Nombre Tipo Descripción
publisher otc_publisher * La instancia del editor de la que se va a obtener el flujo.
Devoluciones:

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

otc_publisher_set_publish_video(publisher, publish_video) → {otc_status}

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

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La editorial afectada.
publish_video otc_bool Si publicar o no el vídeo.
Devoluciones:

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

otc_publisher_set_publish_audio(publisher, publish_audio) → {otc_status}

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

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La editorial afectada.
publish_audio otc_bool Si se debe publicar el audio o no.
Devoluciones:

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(publisher, publish_captions) → {otc_status}

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

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La editorial afectada.
publish_captions otc_bool Si se deben activar o no los subtítulos.
Devoluciones:

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

otc_publisher_get_publish_video(publisher) → {otc_bool}

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

Parámetros:
Nombre Tipo Descripción
publisher const otc_publisher * La instancia del editor.
Devoluciones:

Independientemente de si el editor publica vídeos o no.

otc_publisher_get_publish_audio(publisher) → {otc_bool}

Devuelve si el Publisher está reproduciendo audio o no.

Parámetros:
Nombre Tipo Descripción
publisher const otc_publisher * La instancia del editor.
Devoluciones:

Si la editorial publica contenido de audio o no.

otc_publisher_get_publish_captions(publisher) → {otc_bool}

Devuelve si el Publisher tiene subtítulos activos.

Parámetros:
Nombre Tipo Descripción
publisher const otc_publisher * La instancia del editor.
Devoluciones:

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

otc_publisher_set_captions_input_language(publisher, language) → {otc_status}

Establece el idioma de entrada preferido para los subtítulos de un editor determinado.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La instancia del editor.
language const char * Un código de idioma compatible o «NULL» para mantener la selección predeterminada.
Devoluciones:

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

otc_publisher_get_captions_input_language(publisher) → {const char *}

Obtiene el idioma de entrada de los subtítulos configurado para un editor determinado.

Parámetros:
Nombre Tipo Descripción
publisher const otc_publisher * La instancia del editor.
Devoluciones:

El idioma de entrada configurado. Puede ser NULL si no se ha establecido.

otc_publisher_get_session(publisher) → {otc_session *}

Devuelve el otc_session asociada a esta instancia de editor.

Parámetros:
Nombre Tipo Descripción
publisher const otc_publisher * La instancia del editor.
Devoluciones:

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

otc_publisher_set_max_audio_bitrate(publisher, bitrate) → {otc_status}

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

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La editorial afectada.
bitrate uint32_t La velocidad de transmisión deseada en kbps.
Devoluciones:

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(publisher, cb) → {otc_status}

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

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La instancia del editor.
cb const struct otc_publisher_rtc_stats_report_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: : - otc_publisher_get_rtc_stats_report.

Devoluciones:

otc_status

otc_publisher_get_rtc_stats_report(publisher) → {otc_status}

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:
Nombre Tipo Descripción
publisher otc_publisher * La editorial.
Devoluciones:

otc_status

otc_publisher_get_publisher_id(publisher) → {const char *}

Obtiene un identificador único para un editor.

Parámetros:
Nombre Tipo Descripción
publisher const otc_publisher * La instancia del editor.
Devoluciones:

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

otc_publisher_set_video_type(publisher, video_type) → {otc_status}

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:
Nombre Tipo Descripción
publisher struct otc_publisher * La editorial afectada.
video_type enumeración otc_publisher_video_type El tipo de vídeo para el editor.
Devoluciones:

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

otc_publisher_get_video_type(publisher) → {enum otc_publisher_video_type}

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

Parámetros:
Nombre Tipo Descripción
publisher const struct otc_publisher * La instancia del editor.
Devoluciones:

El tipo de vídeo del editor.

otc_publisher_get_user_data(publisher) → {void *}

Obtiene los datos de usuario de un editor determinado.

Parámetros:
Nombre Tipo Descripción
publisher const struct otc_publisher * La instancia del editor.
Devoluciones:

Un puntero a los datos del usuario en memoria.

otc_publisher_get_name(publisher) → {const char *}

Obtiene el nombre de un editor determinado.

Parámetros:
Nombre Tipo Descripción
publisher const struct otc_publisher * La instancia del editor.
Devoluciones:

El nombre.

otc_publisher_set_video_transformers(publisher, transformers, size) → {otc_status}

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:
Nombre Tipo Descripción
publisher otc_publisher * La instancia del editor.
transformers otc_video_transformer * * Matriz de punteros opacos otc_video_transformer en el orden en que se aplicará a la secuencia.
size uint8_t tamaño del array.
Devoluciones:

un error en caso de que se produzca un error; en caso contrario, OTC_SUCCESS.

otc_publisher_set_audio_transformers(publisher, transformers, size) → {otc_status}

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:
Nombre Tipo Descripción
publisher otc_publisher * La instancia del editor.
transformers otc_audio_transformer * * Matriz de punteros opacos otc_audio_transformer en el orden en que se aplicará a la secuencia.
size uint8_t tamaño del array.
Devoluciones:

un error en caso de que se produzca un error; en caso contrario, OTC_SUCCESS.

otc_publisher_set_target_scalability_mode(publisher, scalability_mode) → {otc_status}

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:
Nombre Tipo Descripción
publisher otc_publisher * La instancia del editor.
scalability_mode const char * El modo de escalabilidad deseado.
Devoluciones:

OTC_SUCCESS si la operación se realiza correctamente; en caso contrario, un código de error.

otc_publisher_get_target_scalability_mode(publisher) → {const char *}

Esta es una función en fase beta.

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La instancia del editor.
Devoluciones:

El modo de escalabilidad de destino establecido por el llamante, o NULL si no se ha establecido explícitamente.

otc_publisher_set_max_video_bitrate(publisher, bitrate_bps) → {otc_status}

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:
Nombre Tipo Descripción
publisher otc_publisher * La instancia del editor.
bitrate_bps int
Devoluciones:

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 una configuración preestablecida.

otc_publisher_get_max_video_bitrate(publisher) → {int}

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:
Nombre Tipo Descripción
publisher const otc_publisher * La instancia del editor.
Devoluciones:

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

otc_publisher_set_video_bitrate_preset(publisher, preset) → {otc_status}

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:
Nombre Tipo Descripción
publisher otc_publisher * La instancia del editor.
preset enumeración otc_video_bitrate_preset Un valor de otc_video_bitrate_preset para presentar la solicitud.
Devoluciones:

un error en caso de que se produzca un error; en caso contrario, OTC_SUCCESS.

otc_publisher_get_video_bitrate_preset(publisher) → {enum otc_video_bitrate_preset}

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:
Nombre Tipo Descripción
publisher const otc_publisher * La instancia del editor.
Devoluciones:

El ajuste preestablecido de la tasa de bits activa.

otc_publisher_set_degradation_preference(publisher, degradation_preference) → {otc_status}

Parámetros:
Nombre Tipo Descripción
publisher otc_publisher * La instancia del editor.
degradation_preference enumeración otc_degradation_preference La preferencia de degradación.
Devoluciones:

OTC_SUCCESS o un error.

otc_publisher_get_degradation_preference(publisher) → {enum otc_degradation_preference}

Parámetros:
Nombre Tipo Descripción
publisher const otc_publisher * La instancia del editor.
Devoluciones:

La preferencia de degradación actual.

otc_publisher_settings_set_subscriber_audio_fallback_enabled(settings, enabled) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * Los ajustes del editor que se verán afectados.
enabled const otc_bool Si queremos activar o no la función de audio alternativo.
Devoluciones:

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(settings, enabled) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * Los ajustes del editor que se verán afectados.
enabled const otc_bool Si queremos activar o no la función de audio alternativo.
Devoluciones:

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(settings, codecs, num_codecs) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * La instancia de configuración del editor que se va a modificar.
codecs const otc_video_codec_type * Una lista de códecs de vídeo a los que dar prioridad (no debe estar vacía).
num_codecs size_t El número de elementos de la matriz «codecs».
Devoluciones:

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(settings) → {otc_status}

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:
Nombre Tipo Descripción
settings otc_publisher_settings * La instancia de configuración del editor que se va a modificar.
Devoluciones:

OTC_SUCCESS si la operación se realiza correctamente; en caso contrario, un código de error.