Signalisation

Utilisez l'API de signalisation pour envoyer du texte et des données entre les clients connectés à une session.

Ces messages permettent aux développeurs de créer un chat textuel de base, d'envoyer des instructions d'un client à un autre et de créer d'autres expériences utiles.

Les SDK clients comprennent des méthodes permettant d'envoyer des signaux aux clients connectés à une session. Ils comprennent également des événements qui sont déclenchés lorsqu'un signal est reçu.

Voir le Tutoriels de signalisation pour apprendre à envoyer et à recevoir des signaux. Vous pouvez également utiliser l'outil API REST pour envoyer des signaux du serveur aux clients.

Charges utiles des signaux

Chaque signal contient data et type qui sont toutes deux des chaînes de caractères :

• data - Contient les informations principales à envoyer dans le signal. Une chaîne de caractères. La longueur maximale est de 128 octets et elle ne doit contenir que des lettres (A-Z et a-z), des chiffres (0-9), des "-", des "_" et des "~".
• type - Un champ secondaire que vous pouvez utiliser pour grouper et filtrer les signaux. La longueur maximale est de 8 kb.

Un client peut également envoyer un signal sans data ou type défini. Ce signal ping n'identifie que l'expéditeur du signal. Le signal comprend également une propriété qui identifie le client qui a envoyé le signal. Vous pouvez envoyer un signal à un client spécifique ou à tous les clients connectés à une session.

Distribution du signal

Pour un client connecté à une session, le Client SDK envoie un événement lorsque le client reçoit un signal. Toutefois, aucun événement n'indique que le ou les destinataires ont reçu un signal sur le client expéditeur. Si votre application le nécessite, vous pouvez utiliser l'API de signalisation pour renvoyer des accusés de réception au client expéditeur.

Le serveur vidéo de Vonage relaie les signaux du client émetteur aux clients récepteurs. Le signal est envoyé à l'aide de connexions WebSocket basées sur le protocole TCP entre les clients et le serveur vidéo de Vonage. La livraison du signal n'est pas strictement garantie, mais la signalisation utilise les capacités de retransmission de paquets inhérentes à TCP.

L'ordre des événements est préservé pour les signaux envoyés par un client, mais pas pour tous les clients. Par exemple, considérons une session dans laquelle client A envoie les signaux 1 et 2 à tous les clients de la session, et client B envoie les signaux 3 et 4 à tous les clients de la session. Le signal 1 sera reçu avant le signal 2, et le signal 3 sera reçu avant le signal 4. Mais il n'y a aucune garantie que du client A seront reçus avant que les du client B signaux.

Voir le Tutoriels de signalisation pour apprendre à envoyer et à recevoir des signaux.