Session OpenTok. En savoir plus...

#include "capabilities.h" #include "config.h" #include "publisher.h" #include "subscriber.h" #include "stream.h"
Structures de données
struct otc_session_capabilities
struct otc_custom_ice_config
struct otc_signal_options
struct otc_session_callbacks
Macros
#define LONGUEUR_MINIMALE_DU_SECRET_DE_CHIFFREMENT   8
#define LONGUEUR_MAXIMALE_DU_SECRET_DE_CHIFFREMENT   256
Définitions de types
typedef struct otc_session otc_session
typedef struct otc_session_settings otc_session_settings
Énumérations
énumération otc_session_error_code {   OTC_SESSION_AUTHORIZATION_FAILURE , OTC_SESSION_BLOCKED_COUNTRY , OTC_SESSION_CONNECTION_DROPPED , OTC_SESSION_CONNECTION_FAILED ,   OTC_SESSION_CONNECTION_LIMIT_EXCEEDED , OTC_SESSION_CONNECTION_REFUSED , OTC_SESSION_CONNECTION_TIMED_OUT , OTC_SESSION_FORCE_UNPUBLISH_OR_INVALID_STREAM = 1535 ,   OTC_SESSION_ILLEGAL_STATE , OTC_SESSION_INTERNAL_ERROR , OTC_SESSION_INVALID_SESSION , OTC_SESSION_INVALID_SIGNAL_TYPE ,   OTC_SESSION_NOT_CONNECTED , OTC_SESSION_NO_MESSAGING_SERVER , OTC_SESSION_NULL_OR_INVALID_PARAMETER , OTC_SESSION_PUBLISHER_NOT_FOUND ,   OTC_SESSION_SIGNAL_DATA_TOO_LONG , OTC_SESSION_SIGNAL_TYPE_TOO_LONG , OTC_SESSION_UNABLE_TO_SEND_SIGNAL , OTC_SESSION_STATE_FAILED = 1020 ,   OTC_SESSION_SUBSCRIBER_NOT_FOUND , OTC_SESSION_UNEXPECTED_GET_SESSION_INFO_REPONSE , OTC_SESSION_ENCRYPTION_SECRET_MISSING , OTC_SESSION_INVALID_ENCRYPTION_SECRET }
Fonctions
otc_session * otc_session_new (const char *apikey, const char *session_id, const struct otc_session_callbacks *rappels)
otc_session_settings * otc_session_settings_new (void)
otc_status otc_session_settings_set_connection_events_suppressed (otc_session_settings *paramètres, otc_bool supprimer)
otc_status otc_session_settings_set_custom_ice_config (otc_session_settings *paramètres, structure constante otc_custom_ice_config *custom_ice_config)
otc_status otc_session_settings_set_proxy_url (otc_session_settings *paramètres, const char *proxy_url)
otc_status otc_session_settings_set_ip_whitelist (otc_session_settings *paramètres, otc_bool (liste blanche IP)
otc_status otc_session_settings_set_single_peer_connection (otc_session_settings *paramètres, otc_bool activer)
Active ou désactive la connexion à pair unique (SPC) pour une session. En savoir plus...
otc_status otc_session_settings_set_session_migration (otc_session_settings *paramètres, otc_bool activer)
Active ou désactive la migration de session pour une session. En savoir plus...
otc_status otc_session_settings_delete (otc_session_settings *paramètres)
otc_session * otc_session_new_with_settings (const char *apikey, const char *session_id, const struct otc_session_callbacks *rappels, otc_session_settings *paramètres)
otc_status otc_session_delete (otc_session *session)
otc_status otc_session_connect (otc_session *session, const char *token)
otc_status otc_session_disconnect (otc_session *session)
otc_status otc_session_publish (otc_session *session, otc_publisher *éditeur)
otc_status otc_session_unpublish (otc_session *session, otc_publisher *éditeur)
otc_status otc_session_subscribe (otc_session *session, abonné_otc *abonné)
otc_status otc_session_unsubscribe (otc_session *session, abonné_otc *abonné)
otc_status otc_session_send_signal (otc_session *session, const char *type, const char *signal)
otc_status otc_session_force_mute_all (otc_session *session, const char **excluded_streams_ids, const int excluded_streams_len)
otc_status otc_session_disable_force_mute (otc_session *session)
otc_status otc_session_force_mute_stream (const otc_session *session, const char *stream_id_to_mute)
otc_status otc_session_force_disconnect (const otc_session *session, const otc_connection *connexion)
otc_status otc_session_send_signal_to_connection (otc_session *session, const char *type, const char *signal, const otc_connection *connexion)
otc_status otc_session_send_signal_with_options (otc_session *session, const char *type, const char *signal, struct otc_signal_options signal_options)
otc_status otc_session_send_signal_to_connection_with_options (otc_session *session, const char *type, const char *signal, const otc_connection *connexion, structure otc_signal_options signal_options)
otc_status otc_session_report_issue (struct otc_session *session, const char *description_du_problème, char **identifiant_du_problème)
char * otc_session_get_id (const otc_session *session)
otc_connection * otc_session_get_connection (const otc_session *session)
struct otc_session_capabilities otc_session_get_capabilities (const otc_session *session)
void * otc_session_get_user_data (const otc_session *session)
otc_status otc_session_set_encryption_secret (otc_session *session, const char *secret)
Définit la clé de chiffrement de bout en bout qui sera utilisée par tous les éditeurs et abonnés au cours de la session. En savoir plus...

Description détaillée

Session OpenTok.

Ce fichier contient la définition de type d'une session OpenTok ainsi que plusieurs déclarations de fonctions utiles pour la gestion d'une session.

Documentation sur `typedef`

otc_session
typedef struct otc_session otc_session

Définition du type de session OpenTok.

otc_session_settings

Définition du type de paramètres de session OpenTok.

Documentation sur les types d'énumération

otc_session_error_code
énumération otc_session_error_code

Liste des codes d'erreur pour les sessions OpenTok.

Cette énumération regroupe plusieurs codes d'erreur associés à une session.

Recenseur
OTC_SESSION_AUTHORIZATION_FAILURE Une clé API ou un jeton non valide a été fourni.
OTC_SESSION_BLOCKED_COUNTRY Impossible de se connecter à la session. Violation des conditions d'utilisation : conformité en matière d'exportation.
OTC_SESSION_CONNECTION_DROPPED La connexion au serveur de messagerie OpenTok a été interrompue.
OTC_SESSION_CONNECTION_FAILED La connexion à la session a échoué.
OTC_SESSION_CONNECTION_LIMIT_EXCEEDED Le client a tenté de se connecter à une session qui a dépassé la limite de connexions simultanées.
OTC_SESSION_CONNECTION_REFUSED Impossible d'ouvrir une connexion vers le serveur de messagerie. Vérifiez que les ports sortants 443 et 8080 sont accessibles.
OTC_SESSION_CONNECTION_TIMED_OUT Le délai d'attente de connexion a expiré lors de la tentative de connexion à la session
OTC_SESSION_FORCE_UNPUBLISH_OR_INVALID_STREAM Flux non valide.
OTC_SESSION_ILLEGAL_STATE Une méthode a été appelée à un moment non autorisé ou inapproprié pour cette session. Par exemple, une tentative de connexion à une session déjà établie entraînera l'affichage de cette erreur.
OTC_SESSION_INTERNAL_ERROR Échec de la distribution des threads, mémoire insuffisante, erreur d'analyse, etc.
OTC_SESSION_INVALID_SESSION L'identifiant de session fourni n'est pas valide.
OTC_SESSION_INVALID_SIGNAL_TYPE Vous avez tenté d'envoyer un signal dont le type n'est pas valide.
OTC_SESSION_NOT_CONNECTED La session n'est pas connectée, et l'action demandée nécessite une connexion de session active.
OTC_SESSION_NO_MESSAGING_SERVER Aucun serveur de messagerie n'est disponible pour cette session.
OTC_SESSION_NULL_OR_INVALID_PARAMETER Un paramètre transmis est nul ou non valide.
OTC_SESSION_PUBLISHER_NOT_FOUND L'éditeur est inconnu de cette session. Cela résulte généralement d'une tentative de désactivation d'un éditeur qui n'est pas associé à la session.
OTC_SESSION_SIGNAL_DATA_TOO_LONG Vous avez tenté d'envoyer un signal contenant une chaîne de données dont la longueur dépasse la longueur maximale (8 Ko).
OTC_SESSION_SIGNAL_TYPE_TOO_LONG Vous avez tenté d'envoyer un signal dont la chaîne de type dépasse la longueur maximale autorisée.
OTC_SESSION_UNABLE_TO_SEND_SIGNAL Impossible d'envoyer correctement le signal, peut-être en raison d'autorisations manquantes (par exemple, un jeton réservé à l'éditeur).
OTC_SESSION_STATE_FAILED Le délai de connexion a expiré lors de la tentative de récupération de l'état de la session.
OTC_SESSION_SUBSCRIBER_NOT_FOUND L'abonné n'est pas reconnu par cette session. Cela est généralement dû à une tentative de désabonnement d'un abonné qui n'est pas associé à la session.
OTC_SESSION_UNEXPECTED_GET_SESSION_INFO_REPONSE Réponse inattendue.
OTC_SESSION_ENCRYPTION_SECRET_MISSING Tentative de connexion à une session chiffrée de bout en bout sans clé de chiffrement.
OTC_SESSION_INVALID_ENCRYPTION_SECRET Tentative de connexion à une session chiffrée de bout en bout sans clé de chiffrement.

Documentation des fonctions

otc_session_connect()
otc_status otc_session_connect ( otc_session * session,
const char * jeton
)

Connecte le client à une session OpenTok.

Paramètres : | | | | --- | --- | | session | La otc_session Structure représentant la session OpenTok à laquelle se connecter. | | token | Le jeton client permettant de se connecter à la session. Voir Aperçu de la création de jetons. |

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

otc_session_delete()
otc_status otc_session_delete ( otc_session * session )

Libère les ressources associées à la session.

Paramètres : | | | | --- | --- | | session | La otc_session par exemple. |

otc_session_disable_force_mute()
otc_status otc_session_disable_force_mute ( otc_session * session )

Désactive l'état de sourdine actif de la session. Une fois cette méthode appelée, les nouveaux flux publiés sur la session ne seront plus en sourdine.

Après avoir appelé le otc_session_force_mute_all() fonction (ou lorsqu'un modérateur d'un autre client lance une commande pour couper le son de tous les flux), tous les flux publiés après cette commande de modération sont diffusés avec le son coupé. Appelez la otc_session_disable_force_mute fonction permettant de désactiver la mise en sourdine d'une session (afin que les nouveaux flux publiés ne soient pas automatiquement mis en sourdine).

L'appel de cette fonction provoque la otc_session_callback.on_mute_forced() fonction de rappel à appeler pour chaque client connecté à la session, avec le active de la propriété otc_on_mute_forced_info structure transmise à la fonction définie comme suit : OTC_FALSE.

Appeler le otc_session_get_capabilities fonction permettant de vérifier si le client peut appeler cette fonction sans problème. Elle est réservée aux clients qui se sont connectés à l'aide d'un jeton auquel a été attribué le rôle de modérateur (voir la Présentation de la création de jetons.

Paramètres : | | | | --- | --- | | session | La otc_session structure représentant la session OpenTok. |

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

otc_session_disconnect()
otc_status otc_session_disconnect ( otc_session * session )

Déconnecte le client de cette session. Tous les abonnés et éditeurs du client seront également déconnectés de la session. Il est recommandé, avant d'appeler cette fonction, d'appeler la fonction otc_session_unpublish fonction pour tous les éditeurs et attendre que le otc_publisher_callbacks#on_stream_destroyed callback. Cela garantit la suppression complète des éditeurs, en particulier si des problèmes de connectivité réseau empêchent leur suppression en raison de la fonctionnalité de reconnexion, qui peut maintenir les flux des éditeurs actifs en vue d'une éventuelle reconnexion.

Paramètres : | | | | --- | --- | | session | La otc_session structure représentant la session OpenTok dont il faut se déconnecter. |

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

otc_session_force_disconnect()
otc_status otc_session_force_disconnect ( const otc_session * session,
const otc_connection * connexion
)

Force un client à se déconnecter de la session.

Bien que vous puissiez utiliser cette fonction pour mettre fin à votre propre connexion, l'appel de otc_session_disconnect est plus simple. Une erreur est renvoyée si le rôle du client ne dispose pas des autorisations nécessaires pour forcer la déconnexion d'autres utilisateurs. Vous définissez le rôle d'un client lors de la création du jeton utilisateur. Lorsqu'une connexion est interrompue à l'aide de cette fonction, otc_session_callbacks#on_connection_dropped et otc_publisher_callbacks#on_stream_destroyed Les fonctions de rappel sont déclenchées de la même manière que si la connexion s'était terminée d'elle-même à l'aide de otc_session_disconnect.

Paramètres : | | | | --- | --- | | session | La session otc_session à laquelle appartient la connexion | | connection | La connexion à déconnecter |

Retour : Une erreur en cas d'erreur ; sinon, OTC_SUCCESS

otc_session_force_mute_all()
otc_status otc_session_force_mute_all ( otc_session * session,
const char ** excluded_streams_ids,
const int longueur_des_flux_exclus
)

Oblige tous les diffuseurs de la session (à l'exception de ceux qui diffusent des flux exclus) à couper le son.

De même, tous les flux publiés après l'appel à la fonction otc_session_force_mute_all sont publiées avec le son coupé. Vous pouvez supprimer l'état de sourdine d'une session en appelant la fonction otc_session_disable_force_mute fonction. Une fois que vous avez appelé la otc_session_disable_force_mute les nouveaux flux publiés dans la session n'auront plus le son coupé.

L'appel de cette fonction provoque la otc_session_callback.on_mute_forced() fonction de rappel à appeler pour chaque client connecté à la session, avec le active de la propriété otc_on_mute_forced_info structure transmise à la fonction définie comme suit : OTC_TRUE. Par ailleurs, le otc_publisher_callbacks.on_publisher_mute_forced() La fonction de rappel est appelée pour chaque client publiant un flux mis en sourdine.

Appeler le otc_session_get_capabilities fonction permettant de vérifier si le client peut appeler cette fonction sans problème. Elle est réservée aux clients qui se sont connectés à l'aide d'un jeton auquel a été attribué le rôle de modérateur (voir la (voir la Présentation de la création de jetons.

Paramètres : | | | | --- | --- | | session | La otc_session Structure représentant la session OpenTok. | | excluded_streams_ids | Pointeur vers un tableau de chaînes de caractères contenant les identifiants des flux à mettre en sourdine. Définissez cette valeur sur `nullptr` pour mettre en sourdine tous les flux de la session (y compris ceux publiés par le client local). | | excluded_streams_len | La longueur du tableau des flux exclus. |

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

otc_session_force_mute_stream()
otc_status otc_session_force_mute_stream ( const otc_session * session,
const char * stream_id_to_mute
)

Force l'éditeur d'un flux spécifié à couper le son.

L'appel de cette fonction provoque la otc_publisher_callbacks.on_publisher_mute_forced() fonction de rappel à appeler chez le client qui publie le flux mis en sourdine.

Appeler le otc_session_get_capabilities fonction permettant de vérifier si le client peut appeler cette fonction sans problème. Elle est réservée aux clients qui se sont connectés à l'aide d'un jeton auquel a été attribué le rôle de modérateur (voir la (voir la Présentation de la création de jetons.

Paramètres : | | | | --- | --- | | session | La otc_session Structure représentant la session OpenTok. | | stream_id_to_mute | Chaîne de caractères correspondant à l'identifiant du flux à mettre en sourdine. |

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

otc_session_get_capabilities()
struct otc_session_capabilities otc_session_get_capabilities ( const otc_session * session )

Récupère les capacités du client connecté à la session. Toutes les otc_session_capabilities les membres ne sont pas définis jusqu'à ce que otc_session_callbacks.on_connected a été appelée.

Paramètres : | | | | --- | --- | | session | La otc_session structure représentant la session OpenTok. |

Retours : Le otc_session_capabilities instance.

otc_session_get_connection()
otc_connection * otc_session_get_connection ( const otc_session * session )

Récupère l'objet de connexion associé à cette session.

Paramètres : | | | | --- | --- | | session | La otc_session structure représentant la session OpenTok. |

Retours : Le otc_connection instance.

otc_session_get_id()
char * otc_session_get_id ( const otc_session * session )

Récupère l'identifiant unique de cette session.

otc_session_get_user_data()
void * otc_session_get_user_data ( const otc_session * session )

Récupère les données utilisateur associées à la session. Voir otc_session_callbacks.user_data.

Paramètres : | | | | --- | --- | | session | La otc_session structure représentant la session OpenTok. |

Retourne : Un pointeur vers les données utilisateur.

otc_session_new()
otc_session * otc_session_new ( const char * apikey,
const char * session_id,
const struct otc_session_callbacks * rappels
)

Crée un nouveau otc_session instance de structure. Transmettez-la à la otc_session_connect fonction permettant de se connecter à la session OpenTok.

Voir aussi otc_session_new_with_settings pour initialiser une structure `otc_session` avec des options avancées.

Paramètres : | | | | --- | --- | | apikey | La clé API du projet OpenTok. Voir Accédez à la page de votre compte Video API Vonage. |

Important : Si vous utilisez la Video API avec une application Vonage (et non un projet OpenTok), indiquez l'identifiant de l'application (et non une clé API OpenTok) pour ce paramètre.

Paramètres : | | | | --- | --- | | session_id | L'identifiant de session. | | callbacks | Les otc_session_callbacks structure contenant des fonctions de rappel pour les événements liés à la session. |

Retourne : La structure `otc_session`, qui représente la session OpenTok.

otc_session_new_with_settings()
otc_session * otc_session_new_with_settings ( const char * apikey,
const char * session_id,
const struct otc_session_callbacks * rappels,
otc_session_settings * paramètres
)

Crée une nouvelle session OpenTok avec des paramètres avancés. Ceux-ci comprennent notamment les paramètres permettant de désactiver les événements de connexion, la configuration de serveurs TURN personnalisés, la fonctionnalité de proxy IP et la fonctionnalité de liste blanche d'adresses IP.

Paramètres : | | | | --- | --- | | apikey | La clé API du projet OpenTok. Voir Accédez à la page de votre compte Video API Vonage. | | session_id | L'identifiant de session. | | callbacks | Les otc_session_callbacks structure contenant des fonctions de rappel pour les événements liés à la session. | | paramètres | Le otc_session_settings struct Contenant les paramètres avancés de la session. |

Retours : Le struct, qui représente la session OpenTok.

Voir aussi : otc_session_new.

otc_session_publish()
otc_status otc_session_publish ( otc_session * session,
otc_publisher * éditeur
)

Lance la diffusion en continu d'un éditeur vers la session.

Paramètres : | | | | --- | --- | | session | La otc_session structure représentant la session OpenTok vers laquelle effectuer la publication. | | publisher | Le otc_publisher structure représentant l'éditeur. |

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

otc_session_report_issue()
otc_status otc_session_report_issue ( struct otc_session * session,
const char * description_du_problème,
char ** identifiant_du_numéro
)

Signalez un problème rencontré avec votre application. Vous pouvez utiliser l'identifiant du problème avec le Inspecteur ou lorsque vous abordez un problème avec l'équipe d'assistance de la Video API Vonage.

Paramètres : | | | | --- | --- | | session | La otc_session Structure représentant la session OpenTok. | | issue_description | Une chaîne de caractères décrivant le problème. | | issue_id | Un pointeur vers une chaîne de caractères qui servira d'identifiant unique pour le problème signalé. |

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

otc_session_send_signal()
otc_status otc_session_send_signal ( otc_session * session,
const char * type,
const char * signal
)

Envoie un signal à tous les clients connectés à la session. Voir otc_session_send_signal_with_options, otc_session_send_signal_to_connectionet otc_session_send_signal_to_connection_with_options. Voir également le Aperçu de la signalisation.

Paramètres : | | | | --- | --- | | session | La otc_session Structure représentant la session OpenTok. | | type | Valeur de type (chaîne de caractères) facultative du signal. | | signal | Valeur de données (chaîne de caractères) facultative du signal. |

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

otc_session_send_signal_to_connection()
otc_status otc_session_send_signal_to_connection ( otc_session * session,
const char * type,
const char * signal,
const otc_connection * connexion
)

Envoie un signal à un client spécifique connecté à la session. Voir otc_session_send_signal_to_connection_with_options, otc_session_send_signalet otc_session_send_signal_with_options. Voir également le Aperçu de la signalisation.

Paramètres : | | | | --- | --- | | session | La otc_session Structure représentant la session OpenTok. | | type | Valeur de type (chaîne de caractères) facultative du signal. | | signal | Valeur de données (chaîne de caractères) facultative du signal. | | connection | La otc_connection structure correspondant au client destiné à recevoir le signal. |

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

otc_session_send_signal_to_connection_with_options()
otc_status otc_session_send_signal_to_connection_with_options ( otc_session * session,
const char * type,
const char * signal,
const otc_connection * connexion,
struct otc_signal_options options_de_signal
)

Envoie un signal à un client spécifique, avec les options indiquées. Voir otc_session_send_signal, otc_session_send_signal_to_connectionet otc_session_send_signal_with_options. Voir également le Aperçu de la signalisation.

Paramètres : | | | | --- | --- | | session | La otc_session Structure représentant la session OpenTok. | | type | Valeur de type (chaîne de caractères) facultative du signal. | | signal | Valeur de données (chaîne de caractères) facultative du signal. | | connection | La otc_connection structure correspondant au client destiné à recevoir le signal. | | signal_options | Le otc_signal_options structure contenant les options du signal. |

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

otc_session_send_signal_with_options()
otc_status otc_session_send_signal_with_options ( otc_session * session,
const char * type,
const char * signal,
struct otc_signal_options options_de_signal
)

Envoie un signal à tous les clients connectés à la session, avec les options spécifiées. Voir otc_session_send_signal, otc_session_send_signal_to_connectionet otc_session_send_signal_to_connection_with_options. Voir également le Aperçu de la signalisation.

Paramètres : | | | | --- | --- | | session | La otc_session Structure représentant la session OpenTok. | | type | Valeur de type (chaîne de caractères) facultative pour le signal. | | signal | Valeur de données (chaîne de caractères) facultative pour le signal. | | signal_options | Les otc_signal_options structure contenant les options du signal. |

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

otc_session_set_encryption_secret()
otc_status otc_session_set_encryption_secret ( otc_session * session,
const char * secret
)

Définit la clé de chiffrement de bout en bout qui sera utilisée par tous les émetteurs et abonnés au cours de la session.

Voir le Guide du développeur sur le chiffrement de bout en bout.

Paramètres : | | | | | --- | --- | --- | | | session | La otc_session Structure représentant la session OpenTok. | | [in] | secret | Valeur du secret de chiffrement. |

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

otc_session_settings_delete()
otc_status otc_session_settings_delete ( otc_session_settings * paramètres )

Supprime un otc_session_settings instance.

otc_session_settings_new()
otc_session_settings * otc_session_settings_new ( void )

Crée un nouveau otc_session_settings par exemple, utilisée pour définir des paramètres de session avancés. Appelez les fonctions suivantes pour configurer ces paramètres avant d'appeler la fonction otc_session_new_with_settings fonction permettant de créer une session avec ces paramètres :

  • otc_session_settings_set_connection_events_suppressed — Masquer les événements de connexion.
  • otc_session_settings_set_custom_ice_config &mdash Utiliser des serveurs TURN personnalisés.
  • otc_session_settings_set_proxy_url — Configurer la fonctionnalité de proxy IP.
  • otc_session_settings_set_ip_whitelist — Activez la fonctionnalité de liste blanche d'adresses IP.
  • otc_session_settings_set_single_peer_connection — Activez la fonctionnalité « Connexion à un seul pair ».
  • otc_session_settings_set_session_migration — Activez la fonctionnalité de migration de session.

otc_session_settings_set_connection_events_suppressed()
otc_status otc_session_settings_set_connection_events_suppressed ( otc_session_settings * paramètres,
otc_bool supprimer
)

Empêcher les événements de connexion, afin de prendre en charge les sessions vidéo interactives de grande envergure. Cela permet d'éviter otc_session_callbacks.on_connection_created et otc_session_callbacks.on_connection_dropped les fonctions de rappel ne soient pas déclenchées lorsque d'autres clients se connectent à la session ou s'en déconnectent. (Par ailleurs, le serveur OpenTok n'envoie pas ces événements au client.) Pour plus d'informations, consultez Suppression des événements de connexion dans les guides destinés aux développeurs d'OpenTok.

otc_session_settings_set_custom_ice_config()
otc_status otc_session_settings_set_custom_ice_config ( otc_session_settings * paramètres,
const struct otc_custom_ice_config * custom_ice_config
)

Permet de personnaliser la configuration du serveur ICE. Cette fonctionnalité fait partie de la fonction TURN configurable.

otc_session_settings_set_ip_whitelist()
otc_status otc_session_settings_set_ip_whitelist ( otc_session_settings * paramètres,
otc_bool liste_blanche_ip
)

Passez la valeur « OTC_TRUE » pour que le client utilise la liste blanche d'adresses IP. Cette fonctionnalité est disponible en option.

otc_session_settings_set_proxy_url()
otc_status otc_session_settings_set_proxy_url ( otc_session_settings * paramètres,
const char * proxy_url
)

Définit l'URL du proxy IP. Voir la section Guide du développeur IP Proxy.

otc_session_settings_set_session_migration()
otc_status otc_session_settings_set_session_migration ( otc_session_settings * paramètres,
otc_bool activer
)

Active ou désactive la migration de session pour une session.

Active la fonctionnalité de migration de session, permettant au client de rester connecté lors de la rotation des serveurs. La valeur par défaut est false (la migration de session n'est pas activée). Pour plus d'informations, consultez Rotation des serveurs et migration des sessions.

Paramètres : | | | | --- | --- | | settings | Pointeur vers l'objet des paramètres de session. | | enable | Indicateur booléen permettant d'activer (OTC_TRUE) ou de désactiver (OTC_FALSE) la migration de session. |

Retour : otc_status Renvoie le statut de l'opération.

otc_session_settings_set_single_peer_connection()
otc_status otc_session_settings_set_single_peer_connection ( otc_session_settings * paramètres,
otc_bool activer
)

Active ou désactive la connexion à pair unique (SPC) pour une session.

La connexion unique entre pairs (SPC) est une fonctionnalité qui regroupe toutes les connexions des abonnés en une seule connexion entre pairs. L'activation de la SPC présente plusieurs avantages, notamment une réduction de la consommation des ressources du système d'exploitation, un meilleur contrôle du débit et, dans le cas des appareils mobiles natifs, la prise en charge de sessions plus volumineuses.

La fonction SPC est désactivée par défaut. Lorsqu'elle est désactivée, la session utilise le protocole MPC (Multiple Peer Connection), dans le cadre duquel une connexion distincte est établie entre chaque point d'extrémité.

Paramètres : | | | | --- | --- | | settings | Pointeur vers l'objet des paramètres de session. | | enable | Indicateur booléen permettant d'activer (OTC_TRUE) ou de désactiver (OTC_FALSE) le SPC. |

Retour : otc_status Renvoie le statut de l'opération.

otc_session_subscribe()
otc_status otc_session_subscribe ( otc_session * session,
abonné_otc * abonné
)

Lance l'abonnement (réception d'un flux) au flux audio-vidéo d'un abonné dans cette session.

Paramètres : | | | | --- | --- | | session | La otc_session structure représentant la session OpenTok contenant le flux de l'abonné. | | abonné | Le otc_subscriber structure représentant l'abonné. |

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

otc_session_unpublish()
otc_status otc_session_unpublish ( otc_session * session,
otc_publisher * éditeur
)

Provoque la fermeture d'un éditeur au cours d'une session (ce qui entraîne l'arrêt de son flux).

Paramètres : | | | | --- | --- | | session | La otc_session structure représentant la session OpenTok dont la publication doit être annulée. | | publisher | Le otc_publisher structure représentant l'éditeur. |

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

otc_session_unsubscribe()
otc_status otc_session_unsubscribe ( otc_session * session,
abonné_otc * abonné
)

Cesse l'abonnement à (la réception d'un flux provenant de) un abonné spécifié dans la session.

Paramètres : | | | | --- | --- | | session | La otc_session structure représentant la session OpenTok contenant le flux de l'abonné. | | abonné | Le otc_subscriber structure représentant l'abonné. |

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