#include <subscriber.h>
Description détaillée
Fonctions de rappel des abonnés.
Cette structure regroupe des pointeurs vers des fonctions pouvant être appelées lors d'événements liés à un abonné 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.
Documentation sur le terrain
on_audio_data
| void(* on_audio_data) (abonné_otc *abonné, void *données_utilisateur, struct constante otc_audio_data *données_audio) |
Appelée périodiquement pour transmettre les données audio de l'abonné. Les propriétés audio reçues peuvent évoluer de manière dynamique. Ces changements peuvent être dus à la négociation du codec audio, aux conditions du réseau, etc. Il incombe aux consommateurs des données audio de gérer ces changements en fonction du cas d'utilisation mis en œuvre (par exemple, le rééchantillonnage audio).
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. | | audio_data | Les données audio. |
on_audio_disabled
| void(* on_audio_disabled) (abonné_otc *abonné, void *données_utilisateur) |
Appelée lorsque le son de l'abonné est désactivé.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. |
on_audio_enabled
| void(* on_audio_enabled) (abonné_otc *abonné, void *données_utilisateur) |
Appelée lorsque le son de l'abonné est activé.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. |
on_audio_level_updated
| void(* on_audio_level_updated) (abonné_otc *abonné, void *données_utilisateur, float niveau_audio) |
Appelée périodiquement pour communiquer le niveau audio de l'abonné.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. | | audio_level | Valeur du niveau audio, comprise entre 0 et 1,0. |
on_audio_stats
| void(* on_audio_stats) (abonné_otc *abonné, void *données_utilisateur, struct statistiques_audio_abonnés_otc (audio_stats) |
Appelée périodiquement pour transmettre les statistiques audio relatives à l'abonné.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. | | audio_stats | Pointeur vers la structure des statistiques audio. |
texte_de_la_légende
| void(* on_caption_text) (abonné_otc *abonné, void *données_utilisateur, const char *text, otc_bool is_final) |
Appelée lorsque le texte des sous-titres du flux de l'abonné est disponible.
Paramètres : | | | | --- | --- | | subscriber | L'instance de l'abonné. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. | | text | Pointeur vers le texte de la légende. | | is_final | Indique si une légende est terminée. |
on_connected
| void(* on_connected) (abonné_otc *abonné, void *données_utilisateur, const otc_stream *stream) |
Appelée lorsque l'instance s'est connectée avec succès au flux et commence la lecture du contenu multimédia.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. | | stream | Le flux de l'abonné. L'instance ne survit pas à l'exécution de la fonction de rappel. Veillez à en faire une copie si cette instance doit être réutilisée ultérieurement. |
on_disconnected
| void(* on_disconnected) (abonné_otc *abonné, void *données_utilisateur) |
Appelée lorsque le flux de l'abonné a été interrompu.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. |
on_error
| void(* on_error) (abonné_otc *abonné, void *données_utilisateur, const char *error_string, enum otc_code_erreur_abonné erreur) |
Appelée en cas d'échec de l'abonné.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. | | error_string | Chaîne de caractères contenant le message d'erreur. | | error | Valeur de l'énumération du code d'erreur. |
on_reconnected
| void(* on_reconnected) (abonné_otc *abonné, void *données_utilisateur) |
Appelée lorsque le flux de l'abonné a repris.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. |
on_render_frame
| void(* on_render_frame) (abonné_otc *abonné, void *données_utilisateur, const otc_video_frame *image) |
Appelée lorsqu'une nouvelle image vidéo destinée à l'abonné est prête à être affichée.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. | | frame | L'image vidéo. |
on_video_data_received
| void(* on_video_data_received) (abonné_otc *abonné, void *données_utilisateur) |
Appelée lorsqu'un abonné reçoit des données vidéo pour la première fois.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. |
on_video_disable_warning
| void(* on_video_disable_warning) (abonné_otc *abonné, void *données_utilisateur) |
Cette méthode est appelée lorsque le routeur multimédia OpenTok détecte une dégradation de la qualité du flux et que la vidéo sera désactivée si cette dégradation se poursuit.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. |
on_video_disable_warning_lifted
| void(* on_video_disable_warning_lifted) (abonné_otc *abonné, void *données_utilisateur) |
Appelée lorsque le routeur multimédia OpenTok constate que la qualité du flux s'est suffisamment améliorée pour que la désactivation de la vidéo ne présente plus de risque immédiat.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. |
on_video_disabled
| void(* on_video_disabled) (abonné_otc *abonné, void *données_utilisateur, énumération otc_video_reason raison) |
Appelée lorsque la vidéo de l'abonné est désactivée.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. | | reason | Fournit plus de détails sur la raison pour laquelle la vidéo a été désactivée. |
on_video_enabled
| void(* on_video_enabled) (abonné_otc *abonné, void *données_utilisateur, énumération otc_video_reason raison) |
Appelée lorsque la vidéo de l'abonné est activée.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. | | reason | Fournit plus de détails sur la raison pour laquelle la vidéo a été activée. |
on_video_stats
| void(* on_video_stats) (abonné_otc *abonné, void *données_utilisateur, struct otc_subscriber_video_stats (statistiques_vidéo) |
Appelée périodiquement pour transmettre les statistiques vidéo relatives à l'abonné.
Paramètres : | | | | --- | --- | | subscriber | L'instance qui effectue cet appel. | | user_data | Pointeur vers les données personnalisées de l'utilisateur associées à cette structure. | | video_stats | Pointeur vers la structure des statistiques vidéo. |
réservé
| void* réservé |
Un pointeur nul vers une zone de mémoire contenant des ressources réservées utilisées pour la mise en œuvre interne.
données_utilisateur
| void* données_utilisateur |
Cet élément de la structure peut pointer vers des données relatives à l'abonné dont le développeur pourrait avoir besoin.