TsgcWSPServer_WebRTCMetody › Broadcast

Broadcast Metoda

Wysyła ładunek tekstowy do wszystkich węzłów subskrybujących kanał sygnalizacyjny, z opcjonalnym wykluczeniem lub skierowaniem do określonych połączeń.

Składnia

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

Parametry

NazwaTypOpis
aMessagestringŁadunek tekstowy dostarczany subskrybentom; zazwyczaj wiadomość czatu, powiadomienie pokoju lub metadane specyficzne dla aplikacji towarzyszące przekazaniu SDP/ICE.
aChannelstringKanał (pokój), do którego ograniczony jest zasięg transmisji. Gdy pole jest puste, ramka jest wysyłana do wszystkich połączonych partnerów niezależnie od ich subskrypcji.
ExcludeStringGUID połączenia, które ma zostać pominięte — zazwyczaj nadawca, aby nie odbierał własnej wiadomości.
IncludeStringGUID pojedynczego docelowego połączenia: gdy ustawiony, tylko ten węzeł otrzymuje ramkę, zastępując przekazywanie kanałowe.

Uwagi

Opakuje tekst w kopertę sygnalizacyjną jako metodę sgc@broadcast na żądanym kanale i wysyła go przez bazowy serwer subskrypcji. W odróżnieniu od przekaźnika peer-to-peer sgc@webrtc, który przenosi oferty SDP/odpowiedzi i kandydatów ICE, Broadcast jest kanałem czatu/kontroli na poziomie aplikacji współdzielonym przez wszystkich subskrybentów pokoju. Należy go wywoływać z serwera zawsze, gdy potrzebne jest przesłanie migawki, zdarzenia moderacyjnego lub powiadomienia poza pasmem do wszystkich węzłów, które dołączyły do określonego pokoju sygnalizacyjnego.

Przykład


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

Powrót do metod