Funções básicas. Mais...

#include "config.h"
Estruturas de Dados
struct otc_on_mute_forced_info
Definições de tipos
typedef int otc_bool
typedef int otc_status
typedef void(* otc_logger_callback) (const char *mensagem)
Enumerações
enum otc_video_reason { OTC_VIDEO_REASON_PUBLISH_VIDEO , OTC_VIDEO_REASON_SUBSCRIBE_TO_VIDEO , OTC_VIDEO_REASON_QUALITY = 3, OTC_VIDEO_REASON_CODEC_NOT_SUPPORTED = 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 = 3.000, OTC_CAMERA_FAILED = 3010 , OTC_VIDEO_RENDER_FAILED = 4.000,   OT_UNABLE_TO_ACCESS_MEDIA_ENGINE = 5.000 }
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_FATAL = OTC_LOG_LEVEL_ERROR, OTC_LOG_LEVEL_MSG = OTC_LOG_LEVEL_DEBUG, OTC_LOG_LEVEL_TRACE = OTC_LOG_LEVEL_DEBUG,   OTC_LOG_LEVEL_ALL = OTC_LOG_LEVEL_DEBUG }
Funções
otc_status otc_init (void *reservado)
otc_status otc_destroy ()
nulo otc_log_set_logger_callback (otc_logger_callback (chamada de retorno)
nulo otc_log_enable (enum otc_log_level log_level)
enum otc_log_level otc_get_log_level ()

Descrição detalhada

Funções básicas.

Este arquivo inclui funções utilizadas para inicializar e desativar o mecanismo da biblioteca, bem como outras funções para habilitar o registro de log no console.

Documentação sobre `typedef`

otc_bool
typedef int otc_bool

Definição de tipo para valores booleanos.

Tipo útil para variáveis que representam valores booleanos (verdadeiro e falso).

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

Definição de tipo para um ponteiro de função que aponta para a função utilizada como callback de registro personalizado para obter as mensagens registradas pelo SDK.

Parâmetros : | | | | --- | --- | | mensagem | Um ponteiro para a mensagem que está sendo registrada. |

Veja também : otc_log_set_logger_callback

otc_status
typedef int otc_status

Definição de tipo para status.

Este é o tipo mais comum de valor de retorno para funções nesta biblioteca. Esse tipo inclui valores das enumerações de códigos de erro.

Veja também : otc_constant : otc_error_code : otc_session_error_code : otc_publisher_error_code : otc_subscriber_error_code

Documentação sobre tipos de enumeração

otc_constant

Essa enumeração inclui constantes comumente utilizadas.

Recenseador
OTC_SUCCESS Constante que representa o sucesso.
OTC_FALSE Constante que representa o valor falso.
OTC_TRUE Constante que representa “verdadeiro”.

otc_error_code

Essa enumeração inclui códigos de erro.

Recenseador
OTC_INVALID_PARAM Código de erro de argumento inválido na função. Um argumento utilizado na chamada de função não é válido.
OTC_FATAL Código de erro fatal. Erro genérico.
OTC_INVALID_VIDEO_FORMAT Formato de vídeo inválido Gerado quando o capturador está configurado com um formato de vídeo inválido
OTC_CONNECTION_DROPPED Código de erro de conexão interrompida. A conexão com o servidor de mensagens do OpenTok foi interrompida. Verifique a conexão de rede.
OTC_UNABLE_TO_FORCE_DISCONNECT Código de erro de desconexão forçada. Não foi possível realizar a chamada com sucesso otc_session_force_disconnect, talvez por falta de permissões.
OTC_UNABLE_TO_FORCE_MUTE Código de erro de silenciamento forçado. Não foi possível realizar a chamada com sucesso otc_session_force_mute_all ou otc_session_force_mute_stream, talvez por falta de permissões.
OTC_CONNECTION_TIMED_OUT Código de erro de tempo limite de conexão. Ocorreu tempo limite durante a execução de uma ação de conexão.
OTC_UNKNOWN_PUBLISHER_INSTANCE Código de erro de instância desconhecida do Publisher. Uma instância desconhecida do Publisher foi usada como argumento de função.
OTC_UNKNOWN_SUBSCRIBER_INSTANCE Código de erro de instância de assinante desconhecida. Uma instância de assinante desconhecida foi usada como argumento de função.
OTC_VIDEO_CAPTURE_FAILED Código de erro de captura de vídeo. Ocorreu um erro com o capturador de vídeo.
OTC_CAMERA_FAILED Código de erro na captura de vídeo da câmera. Ocorreu um erro durante a captura de vídeo da câmera.
OTC_VIDEO_RENDER_FAILED Código de erro na renderização do vídeo. Ocorreu um erro durante a renderização do vídeo.
OT_UNABLE_TO_ACCESS_MEDIA_ENGINE Código de erro de acesso ao mecanismo de mídia. Ocorreu um erro ao tentar obter a lista de codecs de vídeo compatíveis.

otc_log_level

Enumeração dos níveis de log.

Esta enumeração representa os diferentes níveis de registro suportados.

Recenseador
OTC_LOG_LEVEL_DISABLED Valor da enumeração “Sem mensagens”.
OTC_LOG_LEVEL_ERROR Mensagens de nível de erro.
OTC_LOG_LEVEL_WARN Mensagens de nível de alerta.
OTC_LOG_LEVEL_INFO Mensagens de nível de informação.
OTC_LOG_LEVEL_DEBUG Mensagens de nível de depuração.
OTC_LOG_LEVEL_FATAL OBsoleto.
OTC_LOG_LEVEL_MSG OBsoleto.
OTC_LOG_LEVEL_TRACE OBsoleto.
OTC_LOG_LEVEL_ALL OBsoleto.

otc_video_reason

Enumeração dos motivos pelos quais um vídeo pode ser iniciado, interrompido, retomado etc.

Recenseador
OTC_VIDEO_REASON_PUBLISH_VIDEO O cliente responsável pela transmissão interrompeu a transmissão do vídeo.
OTC_VIDEO_REASON_SUBSCRIBE_TO_VIDEO O cliente local cancelou a assinatura do serviço de vídeo.
OTC_VIDEO_REASON_QUALITY O problema com o vídeo foi causado por uma alteração na qualidade do stream de vídeo.
OTC_VIDEO_REASON_CODEC_NOT_SUPPORTED O problema com o vídeo ocorreu porque o vídeo na transmissão do assinante foi desativado, já que a transmissão utiliza um codec de vídeo que não é compatível com o dispositivo.

Documentação da função

otc_destroy()
otc_status otc_destroy ( )

Destrui o mecanismo da biblioteca. Você deve chamar essa função ao concluir a execução do código que utiliza a biblioteca.

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_get_log_level()
enum otc_log_level otc_get_log_level ( )

Obtém o nível atual de registro do console.

Retorna : O nível de log definido.

otc_init()
otc_status otc_init ( void * reservado )

Inicializa a biblioteca. É necessário chamar essa função antes da execução de qualquer outro código que utilize a biblioteca.

Parâmetros : | | | | --- | --- | | reservado | Um ponteiro `void` para uma área de memória que contém recursos reservados utilizados para a implementação interna. Deve ser definido como NULL. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_log_enable()
void otc_log_enable ( enum otc_log_level nível_de_registro )

Habilita o registro de mensagens do SDK para um determinado nível de log.

Parâmetros : | | | | --- | --- | | log_level | O nível de registro desejado. |

Veja também : otc_log_set_logger_callback : otc_get_log_level

otc_log_set_logger_callback()
void otc_log_set_logger_callback ( otc_logger_callback chamada de retorno )

Define o ponteiro de função para uma função de retorno de chamada de registro personalizada, a fim de obter as mensagens registradas pelo SDK. Se você não definir uma função de retorno de chamada de registro, o SDK registrará as mensagens no console.

Parâmetros : | | | | --- | --- | | callback | Um ponteiro para a função de retorno de chamada. |

Veja também : otc_log_enable