RTCIceGathererEvent event

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Fires in relation to RTCIceCandidates being gathered by the RTCIceGatherer object.

Syntax

Event Property

object.RTCIceGathererEvent = handler;

 

Event information

Synchronous	No
Bubbles	No
Cancelable	No

 

Event handler parameters

• candidate
  Type: RTCIceCandidate

  The candidate attribute is the RTCIceCandidate object with the new ICE candidate that caused the event. If candidate is of type RTCIceCandidateComplete, there are no additional candidates.

Standards information

• Object RTC (ORTC) API for WebRTC

  dictionary RTCIceGathererEventInit : EventInit { RTCIceGatherCandidate candidate; };

  [Constructor(DOMString type, RTCIceGathererEventInit eventInitDict)] interface RTCIceGathererEvent : Event { readonly attribute RTCIceGatherCandidate candidate; };

Remarks

Firing an RTCIceGathererEvent named X with an RTCIceGatherCandidate means that an event with the name X, which does not bubble (except where otherwise stated) and is not cancelable (except where otherwise stated), and which uses the RTCIceGathererEvent interface with the candidate attribute set to the new ICE candidate, must be created and dispatched at the given target.

See also

RTCIceGatherer