Fonctions de base. En savoir plus...

#include "config.h"
Structures de données
struct otc_on_mute_forced_info
Définitions de types
typedef int otc_bool
typedef int otc_status
typedef void(* otc_logger_callback) (const char *message)
Énumérations
énumération 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 }
énumération otc_constant { OTC_SUCCESS = 0 , OTC_FALSE = 0 , OTC_TRUE = !OTC_FALSE }
énumération otc_code_erreur {   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 }
énumération 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 }
Fonctions
otc_status otc_init (void *réservé)
otc_status otc_destroy ()
void otc_log_set_logger_callback (otc_logger_callback (rappel)
void otc_log_enable (énumération otc_log_level log_level)
énumération otc_log_level otc_get_log_level ()

Description détaillée

Fonctions de base.

Ce fichier contient des fonctions permettant d'initialiser et de détruire le moteur de la bibliothèque, ainsi que d'autres fonctions permettant d'activer la journalisation sur la console.

Documentation sur `typedef`

otc_bool
typedef int otc_bool

Définition de type pour les valeurs booléennes.

Type utile pour les variables représentant des valeurs booléennes (vrai et faux).

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

Définition de type pour un pointeur vers la fonction utilisée comme callback de journalisation personnalisée permettant d'enregistrer les messages générés par le SDK.

Paramètres : | | | | --- | --- | | message | Un pointeur vers le message en cours d'enregistrement. |

Voir aussi : otc_log_set_logger_callback

otc_status
typedef int otc_status

Définition de type pour les statuts.

Il s'agit du type de valeur de retour le plus courant pour les fonctions de cette bibliothèque. Ce type inclut les valeurs issues des énumérations de codes d'erreur.

Voir aussi : otc_constant : otc_code_erreur : otc_session_error_code : otc_publisher_error_code : otc_code_erreur_abonné

Documentation sur les types d'énumération

otc_constant
énumération otc_constant

Cette liste comprend les constantes couramment utilisées.

Recenseur
OTC_SUCCESS Constante qui symbolise la réussite.
OTC_FALSE Constante représentant la valeur « faux ».
OTC_TRUE Constante représentant la valeur « vrai ».

otc_code_erreur
énumération otc_code_erreur

Cette liste comprend les codes d'erreur.

Recenseur
OTC_INVALID_PARAM Code d'erreur : argument de fonction non valide. Un argument utilisé dans un appel de fonction n'est pas valide.
OTC_FATAL Code d'erreur fatale. Erreur générique.
OTC_INVALID_VIDEO_FORMAT Format vidéo non valide Généré lorsque le dispositif de capture est configuré avec un format vidéo non valide
OTC_CONNECTION_DROPPED Code d'erreur « Connexion interrompue ». La connexion au serveur de messagerie OpenTok a été interrompue. Vérifiez votre connexion réseau.
OTC_UNABLE_TO_FORCE_DISCONNECT Code d'erreur de déconnexion forcée. Impossible d'effectuer l'appel otc_session_force_disconnect, peut-être en raison d'autorisations manquantes.
OTC_UNABLE_TO_FORCE_MUTE Code d'erreur « Force mute ». Impossible d'effectuer l'appel otc_session_force_mute_all ou otc_session_force_mute_stream, peut-être en raison d'autorisations manquantes.
OTC_CONNECTION_TIMED_OUT Code d'erreur de délai d'attente de connexion. Délai d'attente dépassé lors d'une tentative de connexion.
OTC_UNKNOWN_PUBLISHER_INSTANCE Code d'erreur d'instance Publisher inconnu. Une instance Publisher inconnue a été utilisée comme argument de fonction.
OTC_UNKNOWN_SUBSCRIBER_INSTANCE Code d'erreur d'instance d'abonné inconnue. Une instance d'abonné inconnue a été utilisée comme argument de fonction.
OTC_VIDEO_CAPTURE_FAILED Code d'erreur de capture vidéo. Une erreur s'est produite au niveau de la carte de capture vidéo.
OTC_CAMERA_FAILED Code d'erreur lors de l'acquisition de la vidéo de la caméra. Une erreur s'est produite lors de l'acquisition de la vidéo de la caméra.
OTC_VIDEO_RENDER_FAILED Code d'erreur de rendu vidéo. Une erreur s'est produite lors du rendu de la vidéo.
OT_UNABLE_TO_ACCESS_MEDIA_ENGINE Code d'erreur d'accès au moteur multimédia. Une erreur s'est produite lors de la tentative de récupération de la liste des codecs vidéo pris en charge.

otc_log_level
énumération otc_log_level

Énumération des niveaux de journalisation.

Cette liste répertorie les différents niveaux de journalisation pris en charge.

Recenseur
OTC_LOG_LEVEL_DISABLED Valeur d'énumération « Aucun message ».
OTC_LOG_LEVEL_ERROR Messages indiquant le niveau d'erreur.
OTC_LOG_LEVEL_WARN Messages de niveau d'alerte.
OTC_LOG_LEVEL_INFO Messages de niveau « Info ».
OTC_LOG_LEVEL_DEBUG Messages de niveau débogage.
OTC_LOG_LEVEL_FATAL OBSOLÈTE.
OTC_LOG_LEVEL_MSG OBSOLÈTE.
OTC_LOG_LEVEL_TRACE OBSOLÈTE.
OTC_LOG_LEVEL_ALL OBSOLÈTE.

otc_video_reason
énumération otc_video_reason

Énumération des motifs pouvant entraîner le démarrage, l'arrêt, la reprise, etc. d'une vidéo.

Recenseur
OTC_VIDEO_REASON_PUBLISH_VIDEO Le client qui diffusait le flux a cessé de diffuser la vidéo.
OTC_VIDEO_REASON_SUBSCRIBE_TO_VIDEO Le client local a résilié son abonnement à la vidéo.
OTC_VIDEO_REASON_QUALITY Ce problème vidéo a été provoqué par une modification de la qualité du flux vidéo.
OTC_VIDEO_REASON_CODEC_NOT_SUPPORTED Ce problème vidéo s'est produit lorsque la vidéo du flux de l'abonné a été désactivée, car ce flux utilise un codec vidéo non pris en charge par l'appareil.

Documentation des fonctions

otc_destroy()
otc_status otc_destroy ( )

Détruit le moteur de la bibliothèque. Vous devez appeler cette fonction lorsque vous avez fini d'exécuter le code qui utilise la bibliothèque.

Valeurs de retour : Valeur de retour indiquant soit une erreur, soit une réussite.

otc_get_log_level()
énumération otc_log_level otc_get_log_level ( )

Récupère le niveau de journalisation actuel de la console.

Valeurs renvoyées : Le niveau de journalisation défini.

otc_init()
otc_status otc_init ( void * réservé )

Initialise la bibliothèque. Vous devez appeler cette fonction avant l'exécution de tout autre code utilisant la bibliothèque.

Paramètres : | | | | --- | --- | | réservé | Pointeur de type void vers une zone de mémoire contenant des ressources réservées utilisées pour la mise en œuvre interne. Cette valeur doit être définie sur NULL. |

Valeurs de retour : Valeur de retour indiquant soit une erreur, soit une réussite.

otc_log_enable()
void otc_log_enable ( énumération otc_log_level niveau_journal )

Active la journalisation des messages du SDK pour un niveau de journalisation donné.

Paramètres : | | | | --- | --- | | log_level | Le niveau de journalisation souhaité. |

Voir aussi : otc_log_set_logger_callback : otc_get_log_level

otc_log_set_logger_callback()
void otc_log_set_logger_callback ( otc_logger_callback rappel )

Définit le pointeur de fonction vers une fonction de rappel de journalisation personnalisée afin de récupérer les messages consignés par le SDK. Si vous ne définissez pas de fonction de rappel de journalisation, le SDK consignera les messages dans la console.

Paramètres : | | | | --- | --- | | callback | Un pointeur vers la fonction de rappel. |

Voir aussi : otc_log_enable