#include <session.h>
Description détaillée
Fonctions de rappel de session.
Cette structure regroupe des pointeurs vers des fonctions de rappel pour les événements liés à une session 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 session 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.
Documentation sur le terrain
on_archive_started
| void(* on_archive_started) (otc_session *session, void *données_utilisateur, const char *archive_id, const char *name) |
Appelée lorsqu'une archive de la session commence à être enregistrée. Voir la section Guide du développeur pour l'archivage.
Paramètres : | | | | --- | --- | | session | Un pointeur vers la structure otc_session. | | archive_id | L'identifiant de l'archive. | | name | Le nom de l'archive (si un nom a été fourni lors de sa création). |
on_archive_stopped
| void(* on_archive_stopped) (otc_session *session, void *données_utilisateur, const char *archive_id) |
Appelée lorsqu'un enregistrement de la session cesse d'être enregistré.
Paramètres : | | | | --- | --- | | session | Un pointeur vers la structure otc_session. | | user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. | | archive_id | L'identifiant de l'archive. |
on_connected
| void(* on_connected) (otc_session *session, void *données_utilisateur) |
Appelé lorsque le otc_session_connect Cette fonction permet de connecter correctement le client à une session OpenTok.
Paramètres : | | | | --- | --- | | session | Un pointeur vers la structure otc_session. | | user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. |
on_connection_created
| void(* on_connection_created) (otc_session *session, void *données_utilisateur, const otc_connection *connexion) |
Appelée lorsqu'une nouvelle connexion (provenant d'un autre client) est établie.
Paramètres
: | | |
| --- | --- |
| session | Un pointeur vers la structure otc_session. |
| user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. |
| connection | La otc_connection structure correspondant au client qui se connecte à la session. |
on_connection_dropped
| void(* on_connection_dropped) (otc_session *session, void *données_utilisateur, const otc_connection *connexion) |
Cette méthode est appelée lorsque la connexion d'un autre client à la session est interrompue.
Paramètres
: | | |
| --- | --- |
| session | Un pointeur vers la structure otc_session. |
| user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. |
| connection | La otc_connection structure correspondant à la déconnexion du client de la session. |
on_disconnected
| void(* on_disconnected) (otc_session *session, void *données_utilisateur) |
Appelée lorsque le client n'est plus connecté à la session OpenTok.
Paramètres : | | | | --- | --- | | session | Un pointeur vers la structure otc_session. | | user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. |
on_error
| void(* on_error) (otc_session *session, void *données_utilisateur, const char *error_string, enum otc_session_error_code erreur) |
Appelée en cas d'échec de la session.
Paramètres
: | | |
| --- | --- |
| session | Un pointeur vers la structure otc_session. |
| user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. |
| error_string | La chaîne d'erreur. |
| error | Le code d'erreur (de type otc_session_error_code). |
on_mute_forced
| void(* on_mute_forced) (otc_session *session, void *données_utilisateur, otc_on_mute_forced_info *mute_info) |
Appelé lorsqu'un modérateur coupe le son des flux de la session ou réactive le son dans la session.
Paramètres
: | | |
| --- | --- |
| session | Un pointeur vers la structure otc_session. |
| user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. |
| mute_info | Vérifiez le active propriété de cette structure. Elle est définie sur OTC_TRUE lorsqu'un modérateur a coupé le son lors de la session. Il est défini sur OTC_FALSE lorsqu'un modérateur désactive le mode « audio coupé » dans la session. |
on_reconnected
| void(* on_reconnected) (otc_session *session, void *données_utilisateur) |
Cette méthode est appelée lorsque le client local s'est reconnecté à la session OpenTok après une perte temporaire de sa connexion réseau.
Paramètres : | | | | --- | --- | | session | Un pointeur vers la structure otc_session. | | user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. |
on_reconnection_started
| void(* on_reconnection_started) (otc_session *session, void *données_utilisateur) |
Appelée lorsque le client local a perdu sa connexion à la session OpenTok et tente de se reconnecter.
Paramètres : | | | | --- | --- | | session | Un pointeur vers la structure otc_session. | | user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. |
on_signal_received
| void(* on_signal_received) (otc_session *session, void *données_utilisateur, const char *type, const char *signal, const otc_connection *connexion) |
Appelée lorsqu'un signal est reçu dans la session. Voir la Aperçu de la signalisation documentation.
Paramètres
: | | |
| --- | --- |
| session | Un pointeur vers la structure otc_session. |
| user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. |
| type | La chaîne de caractères indiquant le type du signal (si elle a été fournie lors de l'envoi du signal). |
| signal | La chaîne de caractères contenant les données du signal (si elle a été fournie lors de l'envoi du signal). |
| connection | La otc_connection représentant le client qui a envoyé le signal. |
on_stream_dropped
| void(* on_stream_dropped) (otc_session *session, void *données_utilisateur, const otc_stream *stream) |
Cette méthode est appelée lorsqu'un flux d'un autre client est déconnecté de cette session OpenTok.
Paramètres
: | | |
| --- | --- |
| session | Un pointeur vers la structure otc_session. |
| user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. |
| stream | Le otc_stream structure représentant le flux. |
on_stream_has_audio_changed
| void(* on_stream_has_audio_changed) (otc_session *session, void *données_utilisateur, const otc_stream *flux, otc_bool has_audio) |
Appelée lorsqu'un flux active ou désactive le son.
Paramètres
: | | |
| --- | --- |
| session | Un pointeur vers la structure otc_session. |
| user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. |
| stream | Le otc_stream structure représentant le nouveau flux. |
| has_audio | Indique si le flux contient désormais de l'audio (OTC_TRUE) ou non (OTC_FALSE). |
on_stream_has_captions_changed
| void(* on_stream_has_captions_changed) (otc_session *session, void *données_utilisateur, const otc_stream *flux, otc_bool has_captions) |
Appelée lorsqu'un flux active ou désactive les sous-titres.
Paramètres : | | | | --- | --- | | session | Un pointeur vers la structure otc_session. | | user_data | Un pointeur vers la structure user_data que vous avez définie pour la session. | | stream | Un pointeur vers la structure otc_stream représentant le flux. | | has_captions | Indique si le flux comporte actuellement des sous-titres (OTC_TRUE) ou non (OTC_FALSE). |
on_stream_has_video_changed
| void(* on_stream_has_video_changed) (otc_session *session, void *données_utilisateur, const otc_stream *flux, otc_bool has_video) |
Appelée lorsqu'un flux active ou désactive la vidéo.
Paramètres : | | | | --- | --- | | session | Un pointeur vers la structure otc_session. | | user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. | | stream | Indique si le flux contient actuellement de la vidéo (OTC_TRUE) ou non (OTC_FALSE). |
on_stream_received
| void(* on_stream_received) (otc_session *session, void *données_utilisateur, const otc_stream *stream) |
Appelée lorsqu'un nouveau flux apparaît dans cette session OpenTok. Appelez la méthode otc_session_subscribe fonction permettant de s'abonner au flux.
Paramètres
: | | |
| --- | --- |
| session | Un pointeur vers la structure otc_session. |
| user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. |
| stream | Le otc_stream structure représentant le nouveau flux. |
on_stream_video_dimensions_changed
| void(* on_stream_video_dimensions_changed) (otc_session *session, void *données_utilisateur, const otc_stream *stream, int largeur, int hauteur) |
Appelée lorsque les dimensions vidéo d'un flux de la session changent.
Paramètres : | | | | --- | --- | | session | Un pointeur vers la structure otc_session. | | user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. | | width | La nouvelle largeur du flux, en pixels. | | height | La nouvelle hauteur du flux, en pixels. |
on_stream_video_type_changed
| void(* on_stream_video_type_changed) (otc_session *session, void *données_utilisateur, const otc_stream *flux, énumération otc_stream_video_type type) |
Appelée lorsque le type de vidéo d'un flux de la session change.
Paramètres : | | | | --- | --- | | session | Un pointeur vers la structure otc_session. | | user_data | Un pointeur vers les données utilisateur (user_data) que vous avez définies pour la session. | | type | Le nouveau type de flux. |
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 |
Un pointeur vers les données que vous avez définies concernant la session.