otc_publisher_callbacks

Fonctions de rappel de l'éditeur.

Cette structure est un ensemble de pointeurs vers des fonctions de rappel pouvant être appelées en réponse à des événements liés à un éditeur OpenTok.

Tous les rappels ne seront pas effectués sur l'application ou le thread principal, mais sur un thread interne. L'application doit renvoyer le rappel le plus rapidement possible afin d'éviter de bloquer le thread interne.

Données transmises à une fonction de rappel (autre que publisher et user_data) seront libérées une fois la fonction de rappel appelée. Faites une copie des données si vous souhaitez les conserver.

Propriétés

Nom Type Description
user_data void * Un pointeur vers les données que vous avez définies concernant l'éditeur.
reserved void * Un pointeur nul vers une zone de mémoire contenant des ressources réservées utilisées pour la mise en œuvre interne.

Rappels

Nom Description
on_stream_created(publisher, user_data, stream) Appelée lors de la création du flux de l'éditeur.
on_stream_destroyed(publisher, user_data, stream) Appelée lorsque le flux de l'éditeur est détruit.
on_render_frame(publisher, user_data, frame) Appelée lorsqu'une nouvelle image est prête à être affichée par l'éditeur.
on_audio_level_updated(publisher, user_data, audio_level) Appelée périodiquement pour signaler le niveau audio de l'éditeur.
on_publisher_mute_forced(publisher, user_data) Appelé lorsqu'un modérateur a contraint cet éditeur à couper le son.
on_audio_stats(publisher, user_data, audio_stats, number_of_stats) Appelée périodiquement pour transmettre les statistiques audio à l'éditeur.
on_video_stats(publisher, user_data, video_stats, number_of_stats) Appelée périodiquement pour transmettre les statistiques vidéo à l'éditeur.
on_error(publisher, user_data, error_string, error_code) Appelée en cas d'échec de l'éditeur.
on_video_disabled(publisher, user_data, reason) Appelée lorsque la vidéo de l'éditeur est désactivée.
on_video_enabled(publisher, user_data, reason) Appelée lorsque la vidéo de l'éditeur est activée.
on_video_disable_warning(publisher, user_data) Cette méthode est appelée lorsque l'éditeur constate que le niveau de congestion du réseau s'est aggravé et que la vidéo sera désactivée si la qualité continue de se dégrader.
on_video_disable_warning_lifted(publisher, user_data) Cette méthode est appelée lorsque l'éditeur constate que le niveau de congestion du réseau s'est amélioré au point que la vidéo en cours de désactivation ne présente plus de risque immédiat.
on_network_condition_changed(publisher, user_data, stats, reason) Cette fonction de rappel est appelée chaque fois qu'un changement intervient dans l'état de qualité du flux vidéo de l'éditeur.
on_media_link_stats(publisher, user_data, media_link_stats, number_of_stats) Appelée périodiquement pour transmettre les statistiques relatives aux liens multimédias à l'éditeur.

on_stream_created(éditeur, données_utilisateur, flux)

Appelée lors de la création du flux de l'éditeur.

Paramètres :
Nom Type Description
publisher otc_publisher * Une référence à l'éditeur.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour l'éditeur.
stream const otc_stream * Un pointeur vers le flux.

on_stream_destroyed(éditeur, données_utilisateur, flux)

Appelée lorsque le flux de l'éditeur est détruit.

Paramètres :
Nom Type Description
publisher otc_publisher * Une référence à l'éditeur.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour l'éditeur.
stream const otc_stream * Un pointeur vers le flux.

on_render_frame(éditeur, données_utilisateur, image)

Appelée lorsqu'une nouvelle image est prête à être affichée par l'éditeur. Ne pas appeler n'importe quelle fonction de l'API OpenTok (à l'exception de celles figurant dans video_frame.h) dans le même thread que celui qui déclenche ce callback. Si vous devez appeler une fonction de l'API OpenTok (par exemple, des fonctions dans publisher.h ou subscriber.h), reporter son exécution sur un autre thread.

Paramètres :
Nom Type Description
publisher otc_publisher * Une référence à l'éditeur.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour l'éditeur.
frame const otc_video_frame * Un pointeur vers la nouvelle image vidéo.

on_audio_level_updated(éditeur, données_utilisateur, niveau_audio)

Appelée périodiquement pour signaler le niveau audio de l'éditeur.

Paramètres :
Nom Type Description
publisher otc_publisher * Une référence à l'éditeur.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour l'éditeur.
audio_level flotter La valeur du niveau audio, comprise entre 0 et 1,0.

on_publisher_mute_forced(publisher, user_data)

Appelé lorsqu'un modérateur a contraint cet éditeur à couper le son.

Paramètres :
Nom Type Description
publisher otc_publisher * Une référence à l'éditeur.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour l'éditeur.

on_audio_stats(éditeur, données_utilisateur, statistiques_audio, nombre_de_statistiques)

Appelée périodiquement pour transmettre les statistiques audio à l'éditeur.

Paramètres :
Nom Type Description
publisher otc_publisher * Une référence à l'éditeur.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour l'éditeur.
audio_stats struct otc_publisher_audio_stats [] Un ensemble de statistiques audio relatives aux éditeurs.
number_of_stats size_t Le nombre d'éléments de statistiques audio dans le tableau.

on_video_stats(éditeur, données_utilisateur, statistiques_vidéo, nombre_de_statistiques)

Appelée périodiquement pour transmettre les statistiques vidéo à l'éditeur.

Paramètres :
Nom Type Description
publisher otc_publisher * Une référence à l'éditeur.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour l'éditeur.
video_stats struct otc_publisher_video_stats [] Un aperçu des statistiques vidéo des éditeurs.
number_of_stats size_t Le nombre d'éléments de statistiques vidéo dans le tableau.

on_error(éditeur, données_utilisateur, chaîne_d'erreur, code_d'erreur)

Appelée en cas d'échec de l'éditeur.

La plupart des erreurs sont fatales : le diffuseur est automatiquement supprimé et ne peut plus être utilisé. Certaines erreurs ne sont pas fatales et permettent de continuer à utiliser le diffuseur ; lorsqu'une erreur n'est pas fatale, cela est indiqué dans la description de l'erreur.

Paramètres :
Nom Type Description
publisher otc_publisher * Une référence à l'éditeur.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour l'éditeur.
error_string const char * Une chaîne de caractères contenant le message d'erreur.
error_code énumération otc_publisher_error_code Une valeur d'énumération de code d'erreur.

on_video_disabled(éditeur, données_utilisateur, motif)

Appelée lorsque la vidéo de l'éditeur est désactivée.

Paramètres :
Nom Type Description
publisher otc_publisher * L'instance qui effectue cet appel.
user_data void * Pointeur vers les données personnalisées de l'utilisateur associées à cette structure.
reason énumération otc_video_reason Fournit plus de détails sur les raisons pour lesquelles la vidéo a été désactivée.

on_video_enabled(éditeur, données_utilisateur, motif)

Appelée lorsque la vidéo de l'éditeur est activée.

Paramètres :
Nom Type Description
publisher otc_publisher * L'instance qui effectue cet appel.
user_data void * Pointeur vers les données personnalisées de l'utilisateur associées à cette structure.
reason énumération otc_video_reason Fournit plus de détails sur les raisons pour lesquelles la vidéo a été activée.

on_video_disable_warning(éditeur, données_utilisateur)

Cette méthode est appelée lorsque l'éditeur constate que le niveau de congestion du réseau s'est aggravé et que la vidéo sera désactivée si la qualité continue de se dégrader.

Paramètres :
Nom Type Description
publisher otc_publisher * L'instance qui effectue cet appel.
user_data void * Pointeur vers les données personnalisées de l'utilisateur associées à cette structure.

on_video_disable_warning_lifted(éditeur, données_utilisateur)

Cette méthode est appelée lorsque l'éditeur constate que le niveau de congestion du réseau s'est amélioré au point que la vidéo en cours de désactivation ne présente plus de risque immédiat.

Paramètres :
Nom Type Description
publisher otc_publisher * L'instance qui effectue cet appel.
user_data void * Pointeur vers les données personnalisées de l'utilisateur associées à cette structure.

on_network_condition_changed(éditeur, données_utilisateur, statistiques, motif)

Cette fonction de rappel est appelée chaque fois qu'un changement intervient dans l'état de qualité du flux vidéo de l'éditeur. Elle fournit des informations sur l'événement, des statistiques mises à jour ainsi qu'un code de motif indiquant la raison pour laquelle l'événement s'est produit.

Les reason Ce paramètre indique la cause de l'événement et est pris en compte selon l'ordre de priorité suivant : dégradation de la bande passante, dégradation des performances du processeur, autres causes de dégradation de la qualité, changements de codec, changements de résolution ou de couche.

Cet événement diffère de on_video_disabled et on_video_enabled des « callbacks » dans la mesure où il signale les changements ayant une incidence sur la qualité vidéo. on_video_disabled et `on_video_enabled` indiquent uniquement que la piste vidéo de l'abonné a été activée ou désactivée (par exemple, à la suite d'une mise à jour des propriétés du flux ou d'un basculement vers l'audio). En revanche, cet événement fournit des informations de diagnostic sur les causes de la dégradation de la qualité — telles que les limitations du processeur ou de la bande passante — et est également déclenché lorsque la vidéo reste activée.

Les applications peuvent utiliser ce callback pour surveiller les changements de qualité et réagir en conséquence, par exemple en ajustant des éléments de l'interface utilisateur ou en déclenchant des alertes.

/** Cette fonction de rappel est appelée lorsqu'un changement d'état réseau est détecté pour l'éditeur.

Les reason Ce paramètre indique la cause de l'événement et prend actuellement toujours la valeur OTC_NETWORK_REASON_NETWORK_CONDITION_CHANGE.

Cet événement diffère de on_video_disabled et on_video_enabled Ces callbacks se distinguent en ce qu'ils signalent les changements d'état du réseau plutôt que ceux de la piste vidéo de l'éditeur. Les applications peuvent utiliser ce callback pour réagir aux problèmes réseau, par exemple en mettant à jour l'interface utilisateur, en enregistrant des données de télémétrie ou en déclenchant un comportement adaptatif.

Paramètres :
Nom Type Description
publisher otc_publisher * L'instance de l'éditeur à l'origine de l'événement.
user_data void * Pointeur de données utilisateur facultatif transmis lors de l'enregistrement de la fonction de rappel.
stats const struct otc_publisher_media_link_stats * Un lien vers les statistiques relatives aux médias de l'éditeur.
reason énumération otc_network_reason La raison du changement d'état du réseau.

on_media_link_stats(éditeur, données_utilisateur, statistiques_liens_médias, nombre_de_statistiques)

Appelée périodiquement pour transmettre les statistiques relatives aux liens multimédias à l'éditeur.

Les statistiques relatives aux liaisons de support offrent une vue d'ensemble des conditions du réseau au niveau du transport.

Paramètres :
Nom Type Description
publisher otc_publisher * L'instance qui effectue cet appel.
user_data void * Pointeur vers les données personnalisées de l'utilisateur associées à cette structure.
media_link_stats struct otc_publisher_media_link_stats [] Un pointeur vers la structure « stats » du lien multimédia.
number_of_stats size_t