TsgcWSPServer_WebRTCMethoden › Broadcast

Broadcast Methode

Sendet eine Textnutzlast an jeden Peer, der den Signalisierungskanal abonniert hat, optional unter Ausschluss oder Targeting bestimmter Verbindungen.

Syntax

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

Parameter

NameTypBeschreibung
aMessagestringText-Payload, die an die Abonnenten zugestellt wird; üblicherweise eine Chat-Zeile, ein Raumhinweis oder anwendungsspezifische Metadaten, die neben dem SDP/ICE-Relay liegen.
aChannelstringKanal (Raum), auf den der Broadcast beschränkt ist. Wenn leer, wird der Frame an jeden verbundenen Peer gesendet, unabhängig von dessen Abonnements.
ExcludeStringGUID einer Verbindung, die übersprungen werden muss — typischerweise der Sender, sodass er seine eigene Nachricht nicht zurückgespiegelt bekommt.
IncludeStringGUID einer einzelnen Zielverbindung: wenn gesetzt, empfängt nur dieser Peer den Frame und überschreibt das Kanal-Fan-out.

Hinweise

Verpackt den Text im Signalisierungs-Envelope als sgc@broadcast-Methode auf dem angeforderten Kanal und versendet ihn über den Basis-Abonnementserver. Anders als das Peer-to-Peer-sgc@webrtc-Relay, das SDP-Offers/Answers und ICE-Kandidaten trägt, ist Broadcast ein anwendungsseitiger Chat-/Steuerkanal, der von jedem Abonnenten eines Raums gemeinsam genutzt wird. Rufen Sie es vom Server auf, wann immer Sie einen Snapshot, ein Moderationsereignis oder eine Out-of-Band-Mitteilung an alle Peers pushen müssen, die einem bestimmten Signalisierungsraum beigetreten sind.

Beispiel


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

Zurück zu Methoden