大网数据广告活动
Web 标准与前端开发

RTCPeerConnection: icegatheringstatechange event

· 52CE 我爱测

The **`icegatheringstatechange`** event is sent to the `onicegatheringstatechange` event handler on an RTCPeerConnection when the state of the ICE candidate gathering process changes. This signifies that the value of the connection's RTCPeerConnection.iceGatheringState property h

WebRTC

The icegatheringstatechange event is sent to the onicegatheringstatechange event handler on an RTCPeerConnection when the state of the ICE candidate gathering process changes. This signifies that the value of the connection's RTCPeerConnection.iceGatheringState property has changed.

When ICE first starts to gather connection candidates, the value changes from new to gathering to indicate that the process of collecting candidate configurations for the connection has begun. When the value changes to complete, all of the transports that make up the RTCPeerConnection have finished gathering ICE candidates.

[!NOTE] While you can determine that ICE candidate gathering is complete by watching for icegatheringstatechange events and checking for the value of RTCPeerConnection.iceGatheringState to become complete, you can also have your handler for the RTCPeerConnection.icecandidate_event event look to see if its RTCPeerConnectionIceEvent.candidate property is null. This also indicates that collection of candidates is finished.

This event is not cancelable and does not bubble.

Syntax

Use the event name in EventTarget/addEventListener:

addEventListener("icegatheringstatechange", (event) => { })

Alternatively, assign to the event handler property of the interface:

onicegatheringstatechange = (event) => { }

Event type

A generic Event.

Examples

This example creates a handler for icegatheringstatechange events using the onicegatheringstatechange property (but note that this replaces other event listeners added using onicegatheringstatechange, if any).

pc.onicegatheringstatechange = (ev) => {
  let connection = ev.target;

  switch (connection.iceGatheringState) {
    case "gathering":
      /* collection of candidates has begun */
      break;
    case "complete":
      /* collection of candidates is finished */
      break;
  }
};

Likewise, you can use EventTarget.addEventListener to add a listener for icegatheringstatechange events:

pc.addEventListener("icegatheringstatechange", (ev) => {
  let connection = ev.target;

  switch (connection.iceGatheringState) {
    case "gathering":
      // collection of candidates has begun
      break;
    case "complete":
      // collection of candidates is finished
      break;
  }
});

Specifications

Browser compatibility

See also

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。