Broadcast メソッド

シグナリングチャンネルにサブスクライブしているすべてのピアにテキストペイロードを送信します。オプションで特定の接続を除外またはターゲットにできます。

構文

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

パラメータ

名前	タイプ	説明
`aMessage`	`string`	サブスクライバーに配信されるテキストペイロード。通常はチャットライン、ルーム通知、または SDP/ICE リレーの傍らにあるアプリケーション固有のメタデータです。
`aChannel`	`string`	ブロードキャストのスコープとなるチャンネル（ルーム）です。空の場合、フレームはサブスクリプションに関係なく、接続中のすべてのピアに送信されます。
`Exclude`	`String`	スキップする必要がある接続のGUID。通常は送信者であり、自身のメッセージがエコーバックされないようにします。
`Include`	`String`	単一ターゲット接続の GUID：設定されている場合、チャネルのファンアウトを上書きしてそのピアのみがフレームを受信します。

解説

テキストをシグナリングエンベロープ内で要求されたチャンネルの sgc@broadcast メソッドとしてラップし、基本サブスクリプションサーバーを通じて配信します。SDP オファー/アンサーや ICE 候補を伝えるピアツーピアの sgc@webrtc リレーとは異なり、Broadcast はルームの全サブスクライバーが共有するアプリケーションレベルのチャット/コントロールチャンネルです。特定のシグナリングルームに参加したすべてのピアにスナップショット、モデレーションイベント、または帯域外通知をプッシュする必要がある場合にサーバーから呼び出してください。

使用例


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

メソッドに戻る