Funciones básicas. Más...

#include "config.h"
Estructuras de datos
struct otc_on_mute_forced_info
struct otc_transport_stats
Definiciones de tipos
typedef int otc_bool
typedef int otc_status
typedef void(* otc_logger_callback) (const char *mensaje)
Enumeraciones
enum otc_video_reason {   OTC_VIDEO_REASON_NONE = 0, OTC_VIDEO_REASON_PUBLISH_VIDEO = 1 , OTC_VIDEO_REASON_SUBSCRIBE_TO_VIDEO = 2, OTC_VIDEO_REASON_QUALITY = 3 ,   OTC_VIDEO_REASON_CODEC_NOT_SUPPORTED = 4, OTC_VIDEO_REASON_QUALITY_DEGRADATION_BANDWIDTH = 5 , OTC_VIDEO_REASON_QUALITY_DEGRADATION_CPU , OTC_VIDEO_REASON_QUALITY_DEGRADATION_OTHER = 7 ,   OTC_VIDEO_REASON_CODEC_CHANGE = 8, OTC_VIDEO_REASON_RESOLUTION_CHANGE = 9 , OTC_VIDEO_REASON_VIDEO_INTERRUPTION = 10 , OTC_VIDEO_REASON_SENDER_QUALITY_RESTRICTION = 11 }
enum otc_motivo_red {   OTC_NETWORK_REASON_NONE = 0, OTC_NETWORK_REASON_UNKNOWN = 1 , OTC_NETWORK_REASON_BANDWIDTH = 2, OTC_NETWORK_REASON_PACKET_LOSS = 3 ,   OTC_NETWORK_REASON_NETWORK_CONDITION_CHANGE = 4 }
enum otc_constant { OTC_SUCCESS = 0, OTC_FALSE = 0, OTC_TRUE = !OTC_FALSE }
enum otc_error_code {   OTC_INVALID_PARAM = 1 , OTC_FATAL = 2, OTC_INVALID_VIDEO_FORMAT = 3 , OTC_CONNECTION_DROPPED = 1022 ,   OTC_UNABLE_TO_FORCE_DISCONNECT = 1520, OTC_UNABLE_TO_FORCE_MUTE = 1540, OTC_CONNECTION_TIMED_OUT = 1542, OTC_UNKNOWN_PUBLISHER_INSTANCE = 2003,   OTC_UNKNOWN_SUBSCRIBER_INSTANCE = 2004, OTC_VIDEO_CAPTURE_FAILED = 3000, OTC_CAMERA_FAILED = 3010 , OTC_VIDEO_RENDER_FAILED = 4000 ,   OT_UNABLE_TO_ACCESS_MEDIA_ENGINE = 5000 }
enum otc_log_level {   OTC_LOG_LEVEL_DISABLED = 0, OTC_LOG_LEVEL_ERROR = 1 , OTC_LOG_LEVEL_WARN = 2, OTC_LOG_LEVEL_INFO = 3 ,   OTC_LOG_LEVEL_DEBUG = 4, OTC_LOG_LEVEL_TRACE = 5 , OTC_LOG_LEVEL_FATAL = OTC_LOG_LEVEL_ERROR, OTC_LOG_LEVEL_MSG = OTC_LOG_LEVEL_DEBUG,   OTC_LOG_LEVEL_ALL = OTC_LOG_LEVEL_TRACE }
enum otc_network_condition {   OTC_NETWORK_CONDITION_UNKNOWN = 0, OTC_NETWORK_CONDITION_CRITICAL = 1 , OTC_NETWORK_CONDITION_WARNING = 2, OTC_NETWORK_CONDITION_FAIR = 3 ,   OTC_NETWORK_CONDITION_GOOD = 4, OTC_NETWORK_CONDITION_EXCELLENT = 5 }
Puntuación estimada del estado de la red para un transporte. Más...
enum otc_red_degradación_origen { OTC_NETWORK_DEGRADATION_SOURCE_NONE = 0, OTC_NETWORK_DEGRADATION_SOURCE_BOTH_OR_UNCLEAR , OTC_NETWORK_DEGRADATION_SOURCE_LOCAL , OTC_NETWORK_DEGRADATION_SOURCE_REMOTE }
Funciones
otc_status otc_init (void *reserved)
otc_status otc_destroy ()
nulo otc_log_set_logger_callback (otc_logger_callback (función de devolución de llamada)
nulo otc_log_enable (enum otc_log_level nivel_de_registro)
enum otc_log_level otc_get_log_level ()

Descripción detallada

Funciones básicas.

Este archivo incluye funciones que se utilizan para inicializar y desactivar el motor de la biblioteca, así como otras funciones para habilitar el registro en la consola.

Documentación sobre `typedef`

otc_bool
typedef int otc_bool

Definición de tipo para valores booleanos.

Tipo útil para variables que representan valores booleanos (verdadero y falso).

otc_logger_callback
typedef void(* otc_logger_callback) (const char *message)

Definición de tipo para un puntero a la función que se utiliza como callback de registro personalizado para que el SDK registre los mensajes.

Parámetros : | | | | --- | --- | | mensaje | Un puntero al mensaje que se está registrando. |

Véase también : otc_log_set_logger_callback

otc_status
typedef int otc_status

Definición de tipo para los estados.

Este es el tipo más habitual de valor de retorno de las funciones de esta biblioteca. Este tipo incluye valores de las enumeraciones de códigos de error.

Véase también : otc_constant : otc_error_code : otc_session_error_code : otc_código_de_error_del_editor : otc_código_de_error_de_suscriptor

Documentación sobre tipos de enumeración

otc_constant

Esta enumeración incluye las constantes más utilizadas.

Encuestador
OTC_SUCCESS Constante que representa el éxito.
OTC_FALSE Constante que representa el valor «falso».
OTC_TRUE Constante que representa el valor «verdadero».

otc_error_code

Esta enumeración incluye códigos de error.

Encuestador
OTC_INVALID_PARAM Código de error de argumento de función no válido. Un argumento utilizado en una llamada a una función no es válido.
OTC_FATAL Código de error grave. Error genérico.
OTC_INVALID_VIDEO_FORMAT Formato de vídeo no válido. Se produce cuando el capturador está configurado con un formato de vídeo no válido.
OTC_CONNECTION_DROPPED Código de error de pérdida de conexión. Se ha interrumpido la conexión con el servidor de mensajería de OpenTok. Comprueba la conexión a la red.
OTC_UNABLE_TO_FORCE_DISCONNECT Código de error de desconexión forzada. No se ha podido realizar la llamada correctamente otc_session_force_disconnect, quizá debido a que faltan permisos.
OTC_UNABLE_TO_FORCE_MUTE Código de error de silenciamiento forzado. No se ha podido realizar la llamada correctamente otc_session_force_mute_all o otc_session_force_mute_stream, quizá debido a que faltan permisos.
OTC_CONNECTION_TIMED_OUT Código de error de tiempo de espera de conexión. Se ha agotado el tiempo de espera al realizar una acción de conexión.
OTC_UNKNOWN_PUBLISHER_INSTANCE Código de error de instancia de Publisher desconocido. Se ha utilizado una instancia de Publisher desconocida como argumento de una función.
OTC_UNKNOWN_SUBSCRIBER_INSTANCE Código de error de instancia de suscriptor desconocido. Se ha utilizado una instancia de suscriptor desconocida como argumento de una función.
OTC_VIDEO_CAPTURE_FAILED Código de error de captura de vídeo. Se ha producido un error con el dispositivo de captura de vídeo.
OTC_CAMERA_FAILED Código de error al capturar vídeo de la cámara. Se ha producido un error al capturar vídeo de la cámara.
OTC_VIDEO_RENDER_FAILED Código de error de renderización de vídeo. Se ha producido un error al renderizar el vídeo.
OT_UNABLE_TO_ACCESS_MEDIA_ENGINE Código de error de acceso al motor multimedia. Se ha producido un error al intentar obtener la lista de códecs de vídeo compatibles.

otc_log_level

Enumeración de niveles de registro.

Esta enumeración recoge los distintos niveles de registro admitidos.

Encuestador
OTC_LOG_LEVEL_DISABLED Valor de enumeración «Sin mensajes».
OTC_LOG_LEVEL_ERROR Mensajes de nivel de error.
OTC_LOG_LEVEL_WARN Mensajes de nivel de alerta.
OTC_LOG_LEVEL_INFO Mensajes de nivel «Info».
OTC_LOG_LEVEL_DEBUG Mensajes de nivel de depuración.
OTC_LOG_LEVEL_TRACE Mensajes de nivel de seguimiento (los más detallados).
OTC_LOG_LEVEL_FATAL OBSOLETO.
OTC_LOG_LEVEL_MSG OBSOLETO.
OTC_LOG_LEVEL_ALL OBSOLETO.

otc_network_condition

Puntuación estimada del estado de la red para un transporte.

Esta enumeración representa el estado general de la conexión de red para un transporte determinado (local o remoto). Normalmente se calcula a partir de métricas como la pérdida de paquetes y el ancho de banda disponible estimado. Los valores más altos indican mejores condiciones de red.

OTC_NETWORK_CONDITION_WARNING y OTC_NETWORK_CONDITION_CRITICAL indican un deterioro de las condiciones de la red que puede activar las funciones de llamada de respaldo de audio. Si el respaldo de audio está activado, el SDK lo notificará a través de las funciones de llamada correspondientes y, en el estado CRITICAL, se desactiva el vídeo para preservar la estabilidad de la llamada.

Encuestador
OTC_NETWORK_CONDITION_UNKNOWN No se ha podido determinar el estado de la red
OTC_NETWORK_CONDITION_CRITICAL Problemas graves de red; se activa el sistema de audio alternativo si está habilitado
OTC_NETWORK_CONDITION_WARNING Las condiciones de la red son deficientes; la calidad del vídeo se ve muy afectada y puede activarse una advertencia de desactivación del vídeo si está habilitada la opción de audio alternativo.
OTC_NETWORK_CONDITION_FAIR Condiciones de red moderadas; la calidad del vídeo puede verse limitada por el servidor multimedia o por el usuario con el que se está conectando
OTC_NETWORK_CONDITION_GOOD Las condiciones de la red son buenas; pueden producirse pequeños problemas temporales
OTC_NETWORK_CONDITION_EXCELLENT Las condiciones de la red son excelentes; la calidad del vídeo es óptima y el ancho de banda estimado permite alcanzar la tasa de bits máxima para la resolución actual.

otc_red_degradación_origen

Indica el origen de la degradación de la calidad del vídeo o de la red en la sesión.

Esta enumeración identifica qué parte de la llamada es responsable de los problemas de red observados que afectan a la calidad del vídeo. Complementa las métricas de estado de la red por protocolo de transporte.

Encuestador
OTC_NETWORK_DEGRADATION_SOURCE_NONE No se ha detectado ninguna pérdida de calidad; la calidad del vídeo es buena.
OTC_NETWORK_DEGRADATION_SOURCE_BOTH_OR_UNCLEAR Se ha detectado una degradación, pero no se puede determinar de qué lado se debe.
OTC_NETWORK_DEGRADATION_SOURCE_LOCAL La red local o la red de transporte es la causa del deterioro.
OTC_NETWORK_DEGRADATION_SOURCE_REMOTE La red remota o el transporte son la causa del deterioro del servicio.

otc_motivo_red

Enumeración que describe los motivos que afectan al estado de la red.

Estos valores indican el factor principal que influye en la evaluación del estado actual de la red, como las limitaciones de ancho de banda o la pérdida de paquetes.

Encuestador
OTC_NETWORK_REASON_NONE No hay ninguna razón destacable.
OTC_NETWORK_REASON_UNKNOWN Motivo desconocido.
OTC_NETWORK_REASON_BANDWIDTH La puntuación del estado de la red se ve afectada por el ancho de banda.
OTC_NETWORK_REASON_PACKET_LOSS La puntuación del estado de la red se ve afectada por la pérdida de paquetes.
OTC_NETWORK_REASON_NETWORK_CONDITION_CHANGE Indica que el estado de la red del participante local o remoto ha cambiado. Se activa cuando se detecta un cambio significativo en la red del participante local o remoto.

otc_video_reason

Enumeración de los motivos por los que se puede iniciar, detener, reanudar, etc., un vídeo.

Encuestador
OTC_VIDEO_REASON_NONE No se ha producido ninguna pérdida de calidad ni ningún incidente notable en el vídeo. Motivo predeterminado o desconocido.
OTC_VIDEO_REASON_PUBLISH_VIDEO El cliente que emitía la transmisión ha dejado de transmitir el vídeo.
OTC_VIDEO_REASON_SUBSCRIBE_TO_VIDEO El cliente local ha dejado de estar suscrito al servicio de vídeo.
OTC_VIDEO_REASON_QUALITY El problema con el vídeo se debió a un cambio en la calidad de la transmisión de vídeo.
OTC_VIDEO_REASON_CODEC_NOT_SUPPORTED El problema con el vídeo se produjo porque el vídeo de la transmisión del suscriptor se desactivó, ya que la transmisión utiliza un códec de vídeo que no es compatible con el dispositivo.
OTC_VIDEO_REASON_QUALITY_DEGRADATION_BANDWIDTH Deterioro de la calidad debido a un ancho de banda de red insuficiente.
OTC_VIDEO_REASON_QUALITY_DEGRADATION_CPU Deterioro de la calidad provocado por las limitaciones de la CPU del dispositivo cliente.
OTC_VIDEO_REASON_QUALITY_DEGRADATION_OTHER Deterioro de la calidad provocado por otras causas
OTC_VIDEO_REASON_CODEC_CHANGE Ha cambiado el códec de vídeo
OTC_VIDEO_REASON_RESOLUTION_CHANGE Cambio en la resolución del vídeo o en el número de capas. Esto puede deberse a limitaciones en la tasa de bits, a la adaptación del codificador, a cambios en la fuente de la cámara (por ejemplo, al cambiar de cámara o modificar la resolución de entrada) o a cambios en la configuración, y no siempre implica una pérdida de calidad.
OTC_VIDEO_REASON_VIDEO_INTERRUPTION Incidente de interrupción del vídeo
OTC_VIDEO_REASON_SENDER_QUALITY_RESTRICTION Calidad de vídeo limitada por el remitente

Documentación de funciones

otc_destroy()
otc_status otc_destroy ( )

Destruye el motor de la biblioteca. Debes llamar a esta función cuando hayas terminado de ejecutar el código que utiliza la biblioteca.

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

otc_get_log_level()
enum otc_log_level otc_get_log_level ( )

Obtiene el nivel de registro de la consola actual.

Valores devueltos : El nivel de registro establecido.

otc_init()
otc_status otc_init ( void * reservado )

Inicializa la biblioteca. Debes llamar a esta función antes de ejecutar cualquier otro código que utilice la biblioteca.

Parámetros : | | | | --- | --- | | reservado | Un puntero `void` a un área de memoria que contiene recursos reservados utilizados para la implementación interna. Debe establecerse en NULL. |

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

otc_log_enable()
void otc_log_enable ( enum otc_log_level nivel_de_registro )

Habilita el registro de mensajes del SDK para un nivel de registro determinado.

Parámetros : | | | | --- | --- | | log_level | El nivel de registro deseado. |

Véase también : otc_log_set_logger_callback : otc_get_log_level

otc_log_set_logger_callback()
void otc_log_set_logger_callback ( otc_logger_callback llamada de retorno )

Establece el puntero de función en una función de devolución de llamada de registro personalizada para que el SDK registre los mensajes. Si no se establece una función de devolución de llamada de registro, el SDK registrará los mensajes en la consola.

Parámetros : | | | | --- | --- | | callback | Un puntero a la función de devolución de llamada. |

Véase también : otc_log_enable