TsgcWSPServer_WebRTCMéthodes › Broadcast

Broadcast Méthode

Envoie une charge utile textuelle à chaque pair abonné au canal de signalisation, en excluant ou ciblant optionnellement des connexions spécifiques.

Syntaxe

procedure Broadcast(aMessage: string; aChannel: string = ''; Exclude: String = ''; Include: String = '');

Paramètres

NomTypeDescription
aMessagestringCharge utile texte livrée aux abonnés ; généralement une ligne de chat, une notice de salle ou des métadonnées spécifiques à l'application qui accompagnent le relais SDP/ICE.
aChannelstringCanal (salle) auquel la diffusion est limitée. Lorsqu'il est vide, la trame est envoyée à tous les pairs connectés, quelle que soit leur abonnement.
ExcludeStringGUID d'une connexion qui doit être ignorée — généralement l'expéditeur, pour qu'il ne reçoive pas son propre message en écho.
IncludeStringGUID d'une seule connexion cible : lorsqu'il est défini, seul ce pair reçoit la trame, en remplacement de la diffusion sur le canal.

Remarques

Encapsule le texte dans l'enveloppe de signalisation en tant que méthode sgc@broadcast sur le canal demandé et le distribue via le serveur d'abonnement de base. Contrairement au relais pair-à-pair sgc@webrtc qui transporte les offres SDP/réponses et les candidats ICE, Broadcast est un canal de discussion/contrôle au niveau application partagé par tous les abonnés d'une salle. Appelez-le depuis le serveur chaque fois que vous devez pousser un instantané, un événement de modération ou une notification hors-bande à tous les pairs ayant rejoint une salle de signalisation spécifique.

Exemple


// push a room notice to every peer in channel "room-42"
WebRTCSrv.Broadcast('{"type":"notice","text":"recording started"}',
  'room-42');

Retour aux méthodes