TsgcWSPServer_WebRTCMethoden › Broadcast

Broadcast Methode

Verzendt een tekstpayload naar alle peers die zijn geabonneerd op het signaalkanaal, optioneel met uitsluiting of doelgericht op specifieke verbindingen.

Syntaxis

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

Parameters

NaamTypeBeschrijving
aMessagestringTekstpayload afgeleverd aan de abonnees; gewoonlijk een chatlijn, een kamermelding of toepassingsspecifieke metagegevens die naast de SDP/ICE-relay liggen.
aChannelstringKanaal (room) the broadcast is scoped to. When empty, het frame is sent to every verbonden peer regardless of their subscriptions.
ExcludeStringGUID van een verbinding die moet worden overgeslagen — doorgaans de afzender, zodat het eigen bericht niet wordt teruggestuurd.
IncludeStringGUID van een enkele doelverbinding: indien ingesteld, ontvangt alleen die peer het frame, waarbij de kanaal-fan-out wordt overschreven.

Opmerkingen

Verpakt de tekst in de signaleringsomhulsel als een sgc@broadcast-methode op het gevraagde kanaal en verstuurt deze via de basis-abonnementserver. In tegenstelling tot het peer-to-peer sgc@webrtc-relais dat SDP-aanbiedingen/antwoorden en ICE-kandidaten vervoert, is Broadcast een toepassingsniveau-chat/controlekanaal gedeeld door elke abonnee van een ruimte. Roep dit aan vanuit de server wanneer u een momentopname, moderatiegebeurtenis of out-of-band mededeling wilt pushen naar alle peers die een specifieke signaleringsruimte hebben betreden.

Voorbeeld


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

Terug naar methoden