TsgcWSPServer_WebRTC › 方法 › Broadcast

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 offer/answer 和 ICE 候选者的点对点 sgc@webrtc 中继不同，Broadcast 是一个应用层聊天/控制频道，由某个房间的所有订阅者共享。当您需要向加入特定信令房间的所有对端推送快照、审核事件或带外通知时，请从服务器调用此方法。

示例

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

返回方法