base.h
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.
Structures de données : otc_on_mute_forced_info, otc_transport_stats
Comprend : config.h
typedef 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).
typedef int otc_bool;
typedef 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.
typedef int otc_status;
typedef otc_logger_callback
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.
typedef void(*) otc_logger_callback(const char *message)(const char *message);
é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.
| Nom | Valeur | Description |
|---|---|---|
OTC_VIDEO_REASON_NONE |
0 |
Aucune dégradation de la qualité ni événement vidéo notable. Raison par défaut ou inconnue. |
OTC_VIDEO_REASON_PUBLISH_VIDEO |
1 |
Le client qui diffusait le flux a cessé de diffuser la vidéo. |
OTC_VIDEO_REASON_SUBSCRIBE_TO_VIDEO |
2 |
Le client local a résilié son abonnement à la vidéo. |
OTC_VIDEO_REASON_QUALITY |
3 |
Ce problème vidéo a été provoqué par une modification de la qualité du flux vidéo. |
OTC_VIDEO_REASON_CODEC_NOT_SUPPORTED |
4 |
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. |
OTC_VIDEO_REASON_QUALITY_DEGRADATION_BANDWIDTH |
5 |
Dégradation de la qualité due à une bande passante réseau insuffisante. |
OTC_VIDEO_REASON_QUALITY_DEGRADATION_CPU |
6 |
Dégradation de la qualité due aux limitations du processeur de l'appareil client. |
OTC_VIDEO_REASON_QUALITY_DEGRADATION_OTHER |
7 |
Dégradation de la qualité due à d'autres causes |
OTC_VIDEO_REASON_CODEC_CHANGE |
8 |
Le codec vidéo a changé |
OTC_VIDEO_REASON_RESOLUTION_CHANGE |
9 |
Modification de la résolution vidéo ou du nombre de couches. Ce phénomène peut être dû à des contraintes de débit binaire, à l'adaptation de l'encodeur, à des changements au niveau de la source de la caméra (par exemple, changement de caméra ou modification de la résolution d'entrée) ou à des modifications de configuration, et n'implique pas nécessairement une dégradation de la qualité. |
OTC_VIDEO_REASON_VIDEO_INTERRUPTION |
10 |
Événement d'interruption vidéo |
OTC_VIDEO_REASON_SENDER_QUALITY_RESTRICTION |
11 |
Qualité vidéo limitée par l'expéditeur |
énumération otc_network_reason
Énumération décrivant les causes ayant une incidence sur l'état du réseau.
Ces valeurs indiquent le principal facteur influant sur l'évaluation de l'état actuel du réseau, tel que les contraintes de bande passante ou la perte de paquets.
| Nom | Valeur | Description |
|---|---|---|
OTC_NETWORK_REASON_NONE |
0 |
Aucune raison particulière. |
OTC_NETWORK_REASON_UNKNOWN |
1 |
Raison inconnue. |
OTC_NETWORK_REASON_BANDWIDTH |
2 |
La note d'état du réseau dépend de la bande passante. |
OTC_NETWORK_REASON_PACKET_LOSS |
3 |
L'indice d'état du réseau est influencé par la perte de paquets. |
OTC_NETWORK_REASON_NETWORK_CONDITION_CHANGE |
4 |
Indique que l'état du réseau d'un participant local ou distant a changé. Ce message est déclenché lorsqu'un changement significatif est détecté sur le réseau d'un participant local ou distant. |
OTC_NETWORK_REASON_NO_SUBSCRIBERS |
5 |
Le débit de l'éditeur est limité en raison de l'absence d'abonnés actifs. Dans ce cas, le routeur multimédia peut réduire ou suspendre la transmission en amont afin d'optimiser l'utilisation des ressources. |
OTC_NETWORK_REASON_DOWNSTREAM_CONSTRAINT |
6 |
Le débit binaire de l'éditeur est limité par les conditions du récepteur en aval. Cela se produit généralement lorsque la diffusion simultanée vers les clients est désactivée, ce qui entraîne la détermination des contraintes de l'éditeur à partir des retours RTCP des abonnés, transmis via le routeur multimédia. |
énumération otc_constant
Cette liste comprend les constantes couramment utilisées.
| Nom | Valeur | Description |
|---|---|---|
OTC_SUCCESS |
0 |
Constante qui symbolise la réussite. |
OTC_FALSE |
0 |
Constante représentant la valeur « faux ». |
OTC_TRUE |
!OTC_FALSE |
Constante représentant la valeur « vrai ». |
énumération otc_error_code
Cette liste comprend les codes d'erreur.
| Nom | Valeur | Description |
|---|---|---|
OTC_INVALID_PARAM |
1 |
Code d'erreur : argument de fonction non valide. Un argument utilisé dans un appel de fonction n'est pas valide. |
OTC_FATAL |
2 |
Code d'erreur fatale. Erreur générique. |
OTC_INVALID_VIDEO_FORMAT |
3 |
Format vidéo non valide : cette erreur survient lorsque le dispositif de capture est configuré avec un format vidéo non valide. |
OTC_CONNECTION_DROPPED |
1022 |
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 |
1520 |
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 |
1540 |
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 |
1542 |
Code d'erreur de délai d'attente de connexion. Dépassement du délai d'attente lors d'une tentative de connexion. |
OTC_UNKNOWN_PUBLISHER_INSTANCE |
2003 |
Code d'erreur d'instance Publisher inconnu. Une instance Publisher inconnue a été utilisée comme argument de fonction. |
OTC_UNKNOWN_SUBSCRIBER_INSTANCE |
2004 |
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 |
3000 |
Code d'erreur de capture vidéo. Une erreur s'est produite au niveau de la carte de capture vidéo. |
OTC_CAMERA_FAILED |
3010 |
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 |
4000 |
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 |
5000 |
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. |
énumération otc_log_level
Énumération des niveaux de journalisation.
Cette liste répertorie les différents niveaux de journalisation pris en charge.
| Nom | Valeur | Description |
|---|---|---|
OTC_LOG_LEVEL_DISABLED |
0 |
Valeur d'énumération « Aucun message ». |
OTC_LOG_LEVEL_ERROR |
1 |
Messages indiquant le niveau d'erreur. |
OTC_LOG_LEVEL_WARN |
2 |
Messages de niveau d'alerte. |
OTC_LOG_LEVEL_INFO |
3 |
Messages de niveau « Info ». |
OTC_LOG_LEVEL_DEBUG |
4 |
Messages de niveau débogage. |
OTC_LOG_LEVEL_TRACE |
5 |
Messages de niveau « trace » (les plus détaillés). |
OTC_LOG_LEVEL_FATAL |
OTC_LOG_LEVEL_ERROR |
OBSOLÈTE. |
OTC_LOG_LEVEL_MSG |
OTC_LOG_LEVEL_DEBUG |
OBSOLÈTE. |
OTC_LOG_LEVEL_ALL |
OTC_LOG_LEVEL_TRACE |
OBSOLÈTE. |
énumération otc_network_condition
Cette énumération représente l'état général de la connexion réseau pour un transport donné (local ou distant). Elle est généralement calculée à partir d'indicateurs tels que la perte de paquets et la bande passante disponible estimée. Plus les valeurs sont élevées, meilleures sont les conditions réseau.
Les codes OTC_NETWORK_CONDITION_WARNING et OTC_NETWORK_CONDITION_CRITICAL indiquent une dégradation des conditions réseau susceptible de déclencher des callbacks de basculement audio. Si le basculement audio est activé, le SDK enverra une notification via les callbacks correspondants ; dans l'état CRITICAL, la vidéo est désactivée afin de préserver la stabilité de l'appel.
| Nom | Valeur | Description |
|---|---|---|
OTC_NETWORK_CONDITION_UNKNOWN |
0 |
Impossible de déterminer l'état du réseau |
OTC_NETWORK_CONDITION_CRITICAL |
1 |
Problèmes réseau graves ; la solution de secours audio est activée si elle est configurée |
OTC_NETWORK_CONDITION_WARNING |
2 |
Conditions réseau médiocres ; la qualité vidéo en est fortement affectée et un avertissement de désactivation de la vidéo peut s'afficher si le repli audio est activé |
OTC_NETWORK_CONDITION_FAIR |
3 |
Conditions réseau moyennes ; la qualité vidéo peut être limitée par le serveur multimédia ou par un autre utilisateur |
OTC_NETWORK_CONDITION_GOOD |
4 |
Les conditions de connexion sont bonnes ; des problèmes mineurs et temporaires peuvent survenir. |
OTC_NETWORK_CONDITION_EXCELLENT |
5 |
Les conditions réseau sont excellentes ; la qualité vidéo est optimale et la bande passante estimée permet de prendre en charge le débit binaire maximal pour la résolution actuelle. |
énumération otc_quality_restriction
Énumération décrivant les motifs de restriction de la qualité de l'expéditeur.
Ces valeurs indiquent les ajustements de qualité du serveur multimédia (changements spatiaux/temporels) détectés au cours d'une session.
| Nom | Valeur | Description |
|---|---|---|
OTC_QUALITY_RESTRICTION_UNKNOWN |
0 |
Raison inconnue. |
OTC_QUALITY_RESTRICTION_NONE |
1 |
Aucun événement notable. |
OTC_QUALITY_RESTRICTION_SPATIAL |
2 |
L'expéditeur a réduit la résolution spatiale des abonnés. |
OTC_QUALITY_RESTRICTION_TEMPORAL |
3 |
L'expéditeur a réduit la qualité temporelle de l'abonné. |
OTC_QUALITY_RESTRICTION_SPATIAL_AND_TEMPORAL |
4 |
L'expéditeur a réduit la qualité tant spatiale que temporelle. |
énumération otc_network_degradation_source
Indique la source de la dégradation de la qualité vidéo ou du réseau au cours de la session.
Cette énumération permet d'identifier quelle partie de l'appel est à l'origine des problèmes réseau constatés qui affectent la qualité vidéo. Elle vient compléter les indicateurs d'état du réseau par mode de transport.
| Nom | Valeur | Description |
|---|---|---|
OTC_NETWORK_DEGRADATION_SOURCE_NONE |
0 |
Aucune dégradation n'a été détectée ; la qualité vidéo est bonne. |
OTC_NETWORK_DEGRADATION_SOURCE_BOTH_OR_UNCLEAR |
Une dégradation a été détectée, mais il est impossible d'en déterminer la cause. | |
OTC_NETWORK_DEGRADATION_SOURCE_LOCAL |
Le réseau local ou le réseau de transport est à l'origine de la dégradation. | |
OTC_NETWORK_DEGRADATION_SOURCE_REMOTE |
Le réseau ou le transport à distance est à l'origine de la dégradation. |
Fonctions
| Nom | Description |
|---|---|
otc_init(reserved) → {otc_status} |
Initialise la bibliothèque. |
otc_destroy() → {otc_status} |
Détruit le moteur de la bibliothèque. |
otc_log_set_logger_callback(callback) |
Définit le pointeur de fonction vers une fonction de rappel de journalisation personnalisée afin de récupérer les messages enregistrés par le SDK. |
otc_log_enable(log_level) |
Active la journalisation des messages du SDK pour un niveau de journalisation donné. |
otc_get_log_level() → {enum otc_log_level} |
Récupère le niveau de journalisation actuel de la console. |
otc_init(réservé) → {otc_status}
Initialise la bibliothèque. Vous devez appeler cette fonction avant l'exécution de tout autre code utilisant la bibliothèque.
Paramètres :
| Nom | Type | Description |
|---|---|---|
reserved |
void * | Pointeur nul vers une zone de mémoire contenant des ressources réservées utilisées pour la mise en œuvre interne. Il doit être défini sur NULL. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_destroy() → {otc_status}
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.
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_log_set_logger_callback(callback)
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 :
| Nom | Type | Description |
|---|---|---|
callback |
otc_logger_callback | Un pointeur vers la fonction de rappel. |
Voir : : - otc_log_enable
otc_log_enable(log_level)
Active la journalisation des messages du SDK pour un niveau de journalisation donné.
Paramètres :
| Nom | Type | Description |
|---|---|---|
log_level |
énumération otc_log_level | Le niveau de journalisation souhaité. |
Voir : : - otc_log_set_logger_callback - otc_get_log_level
otc_get_log_level() → {enum otc_log_level}
Récupère le niveau de journalisation actuel de la console.
Retours :
Le niveau de journalisation défini.